NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Browse Source

[doc] build from commit 590b21165288127c6f942fe43d261d57d9a6d5c3

return42 1 day ago
commit
cc41d4bc73
100 changed files with 29349 additions and 0 deletions
Unified View Show Diff Stats
  1. 4 0
      .buildinfo
  2. 0 0
      .nojekyll
  3. 98 0
      404.html
  4. 1 0
      CNAME
  5. 1438 0
      _downloads/ad0ebe55d6b53b1559e0ca8dee6f30b9/reST.rst
  6. 3 0
      _images/DOT-57a4a7f78690d0b6b884bc59f36e84cfb0b61f76.dot
  7. 31 0
      _images/DOT-57a4a7f78690d0b6b884bc59f36e84cfb0b61f76.svg
  8. 13 0
      _images/SVG-1fb7029fa2cc454a267bae271cccb2c591387416.svg
  9. 30 0
      _images/arch_public.dot
  10. 149 0
      _images/arch_public.svg
  11. BIN
      _images/ffox-setting-proxy-socks.png
  12. 3 0
      _images/hello.dot
  13. 30 0
      _images/hello.svg
  14. 25 0
      _images/math/07c9ff4251510b06013159f4e45ec9ab97044096.svg
  15. 25 0
      _images/math/3b8127a8eed95247f9249ea6c85e8e86df1baa82.svg
  16. 22 0
      _images/math/6673b43f9fe29455c1fcd1164e5844698cc64d38.svg
  17. 9 0
      _images/math/a6a994cb6e7278ec30eaebe7e636046d3deccb5b.svg
  18. 10 0
      _images/svg_image.svg
  19. 0 0
      _images/translation.svg
  20. 183 0
      _modules/index.html
  21. 309 0
      _modules/searx/answerers/_core.html
  22. 193 0
      _modules/searx/answerers/random.html
  23. 177 0
      _modules/searx/answerers/statistics.html
  24. 431 0
      _modules/searx/autocomplete.html
  25. 157 0
      _modules/searx/babel_extract.html
  26. 247 0
      _modules/searx/botdetection/_helpers.html
  27. 512 0
      _modules/searx/botdetection/config.html
  28. 194 0
      _modules/searx/botdetection/ip_lists.html
  29. 270 0
      _modules/searx/botdetection/link_token.html
  30. 254 0
      _modules/searx/enginelib.html
  31. 411 0
      _modules/searx/enginelib/traits.html
  32. 369 0
      _modules/searx/engines.html
  33. 316 0
      _modules/searx/engines/annas_archive.html
  34. 262 0
      _modules/searx/engines/archlinux.html
  35. 391 0
      _modules/searx/engines/bing.html
  36. 223 0
      _modules/searx/engines/bing_images.html
  37. 277 0
      _modules/searx/engines/bing_news.html
  38. 212 0
      _modules/searx/engines/bing_videos.html
  39. 616 0
      _modules/searx/engines/brave.html
  40. 354 0
      _modules/searx/engines/command.html
  41. 362 0
      _modules/searx/engines/dailymotion.html
  42. 192 0
      _modules/searx/engines/demo_offline.html
  43. 223 0
      _modules/searx/engines/demo_online.html
  44. 632 0
      _modules/searx/engines/duckduckgo.html
  45. 378 0
      _modules/searx/engines/duckduckgo_definitions.html
  46. 657 0
      _modules/searx/engines/google.html
  47. 246 0
      _modules/searx/engines/google_images.html
  48. 418 0
      _modules/searx/engines/google_news.html
  49. 344 0
      _modules/searx/engines/google_scholar.html
  50. 267 0
      _modules/searx/engines/google_videos.html
  51. 537 0
      _modules/searx/engines/json_engine.html
  52. 181 0
      _modules/searx/engines/mrs.html
  53. 390 0
      _modules/searx/engines/mullvad_leta.html
  54. 255 0
      _modules/searx/engines/odysee.html
  55. 301 0
      _modules/searx/engines/peertube.html
  56. 474 0
      _modules/searx/engines/qwant.html
  57. 303 0
      _modules/searx/engines/radio_browser.html
  58. 196 0
      _modules/searx/engines/sepiasearch.html
  59. 230 0
      _modules/searx/engines/sqlite.html
  60. 647 0
      _modules/searx/engines/startpage.html
  61. 342 0
      _modules/searx/engines/tineye.html
  62. 367 0
      _modules/searx/engines/torznab.html
  63. 201 0
      _modules/searx/engines/voidlinux.html
  64. 946 0
      _modules/searx/engines/wikidata.html
  65. 443 0
      _modules/searx/engines/wikipedia.html
  66. 447 0
      _modules/searx/engines/xpath.html
  67. 304 0
      _modules/searx/engines/yahoo.html
  68. 366 0
      _modules/searx/engines/zlibrary.html
  69. 255 0
      _modules/searx/exceptions.html
  70. 192 0
      _modules/searx/extended_types.html
  71. 643 0
      _modules/searx/favicons/cache.html
  72. 175 0
      _modules/searx/favicons/config.html
  73. 363 0
      _modules/searx/favicons/proxy.html
  74. 216 0
      _modules/searx/favicons/resolvers.html
  75. 317 0
      _modules/searx/infopage.html
  76. 361 0
      _modules/searx/limiter.html
  77. 595 0
      _modules/searx/locales.html
  78. 444 0
      _modules/searx/plugins/_core.html
  79. 268 0
      _modules/searx/plugins/calculator.html
  80. 176 0
      _modules/searx/plugins/hash_plugin.html
  81. 320 0
      _modules/searx/plugins/hostnames.html
  82. 167 0
      _modules/searx/plugins/self_info.html
  83. 189 0
      _modules/searx/plugins/tor_check.html
  84. 396 0
      _modules/searx/plugins/unit_converter.html
  85. 362 0
      _modules/searx/redislib.html
  86. 175 0
      _modules/searx/result_types.html
  87. 691 0
      _modules/searx/result_types/_base.html
  88. 268 0
      _modules/searx/result_types/answer.html
  89. 160 0
      _modules/searx/result_types/keyvalue.html
  90. 324 0
      _modules/searx/search.html
  91. 246 0
      _modules/searx/search/models.html
  92. 312 0
      _modules/searx/search/processors/abstract.html
  93. 137 0
      _modules/searx/search/processors/offline.html
  94. 350 0
      _modules/searx/search/processors/online.html
  95. 187 0
      _modules/searx/search/processors/online_currency.html
  96. 174 0
      _modules/searx/search/processors/online_dictionary.html
  97. 159 0
      _modules/searx/search/processors/online_url_search.html
  98. 337 0
      _modules/searx/settings_loader.html
  99. 454 0
      _modules/searx/sqlitedb.html
  100. 1038 0
      _modules/searx/utils.html

+ 4 - 0
.buildinfo
View File 

@@ -0,0 +1,4 @@
 
+# Sphinx build info version 1
 
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
 
+config: 918e1383719c81837264043785632057
 
+tags: 645f666f9bcd5a90fca523b33c5a78b7

+ 0 - 0
.nojekyll
View File


+ 98 - 0
404.html
View File 

@@ -0,0 +1,98 @@
 
+<!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>Page not found &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="/_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="/_static/searxng.css?v=52e4ff28" />
 
+    <script src="/_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="/_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="/_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="/_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="/genindex.html" />
 
+    <link rel="search" title="Search" href="/search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="/genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="/py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="/index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">Page not found</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Page not found</h1>
 
+
 
+Unfortunately we couldn't find the content you were looking for.
 
+
 
+            <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>
 
+    
+  </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 1 - 0
CNAME
View File 

@@ -0,0 +1 @@
 
+docs.searxng.org

+ 1438 - 0
_downloads/ad0ebe55d6b53b1559e0ca8dee6f30b9/reST.rst
View File 

@@ -0,0 +1,1438 @@
 
+.. _reST primer:
 
+
 
+===========
 
+reST primer
 
+===========
 
+
 
+.. sidebar:: KISS_ and readability_
 
+
 
+   Instead of defining more and more roles, we at SearXNG encourage our
 
+   contributors to follow principles like KISS_ and readability_.
 
+
 
+We at SearXNG are using reStructuredText (aka reST_) markup for all kind of
 
+documentation.  With the builders from the Sphinx_ project a HTML output is
 
+generated and deployed at docs.searxng.org_.  For build prerequisites read
 
+:ref:`docs build`.
 
+
 
+.. _docs.searxng.org: https://docs.searxng.org/
 
+
 
+The source files of SearXNG's documentation are located at :origin:`docs`.
 
+Sphinx assumes source files to be encoded in UTF-8 by default.  Run :ref:`make
 
+docs.live <make docs.live>` to build HTML while editing.
 
+
 
+.. sidebar:: Further reading
 
+
 
+   - Sphinx-Primer_
 
+   - `Sphinx markup constructs`_
 
+   - reST_, docutils_, `docutils FAQ`_
 
+   - Sphinx_, `sphinx-doc FAQ`_
 
+   - `sphinx config`_, doctree_
 
+   - `sphinx cross references`_
 
+   - linuxdoc_
 
+   - intersphinx_
 
+   - sphinx-jinja_
 
+   - `Sphinx's autodoc`_
 
+   - `Sphinx's Python domain`_, `Sphinx's C domain`_
 
+   - SVG_, ImageMagick_
 
+   - DOT_, `Graphviz's dot`_, Graphviz_
 
+
 
+
 
+.. contents::
 
+   :depth: 3
 
+   :local:
 
+   :backlinks: entry
 
+
 
+Sphinx_ and reST_ have their place in the python ecosystem.  Over that reST is
 
+used in popular projects, e.g the Linux kernel documentation `[kernel doc]`_.
 
+
 
+.. _[kernel doc]: https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html
 
+
 
+.. sidebar:: Content matters
 
+
 
+   The readability_ of the reST sources has its value, therefore we recommend to
 
+   make sparse usage of reST markup / .. content matters!
 
+
 
+**reST** is a plaintext markup language, its markup is *mostly* intuitive and
 
+you will not need to learn much to produce well formed articles with.  I use the
 
+word *mostly*: like everything in live, reST has its advantages and
 
+disadvantages, some markups feel a bit grumpy (especially if you are used to
 
+other plaintext markups).
 
+
 
+Soft skills
 
+===========
 
+
 
+Before going any deeper into the markup let's face on some **soft skills** a
 
+trained author brings with, to reach a well feedback from readers:
 
+
 
+- Documentation is dedicated to an audience and answers questions from the
 
+  audience point of view.
 
+- Don't detail things which are general knowledge from the audience point of
 
+  view.
 
+- Limit the subject, use cross links for any further reading.
 
+
 
+To be more concrete what a *point of view* means.  In the (:origin:`docs`)
 
+folder we have three sections (and the *blog* folder), each dedicate to a
 
+different group of audience.
 
+
 
+User's POV: :origin:`docs/user`
 
+  A typical user knows about search engines and might have heard about
 
+  meta crawlers and privacy.
 
+
 
+Admin's POV: :origin:`docs/admin`
 
+  A typical Admin knows about setting up services on a linux system, but he does
 
+  not know all the pros and cons of a SearXNG setup.
 
+
 
+Developer's POV: :origin:`docs/dev`
 
+  Depending on the readability_ of code, a typical developer is able to read and
 
+  understand source code.  Describe what a item aims to do (e.g. a function).
 
+  If the chronological order matters, describe it.  Name the *out-of-limits
 
+  conditions* and all the side effects a external developer will not know.
 
+
 
+.. _reST inline markup:
 
+
 
+Basic inline markup
 
+===================
 
+
 
+.. sidebar:: Inline markup
 
+
 
+   - :ref:`reST roles`
 
+   - :ref:`reST smart ref`
 
+
 
+Basic inline markup is done with asterisks and backquotes.  If asterisks or
 
+backquotes appear in running text and could be confused with inline markup
 
+delimiters, they have to be escaped with a backslash (``\*pointer``).
 
+
 
+.. table:: basic inline markup
 
+   :widths: 4 3 7
 
+
 
+   ================================================ ==================== ========================
 
+   description                                      rendered             markup
 
+   ================================================ ==================== ========================
 
+   one asterisk for emphasis                        *italics*            ``*italics*``
 
+   two asterisks for strong emphasis                **boldface**         ``**boldface**``
 
+   backquotes for code samples and literals         ``foo()``            ````foo()````
 
+   quote asterisks or backquotes                    \*foo is a pointer   ``\*foo is a pointer``
 
+   ================================================ ==================== ========================
 
+
 
+.. _reST basic structure:
 
+
 
+Basic article structure
 
+=======================
 
+
 
+The basic structure of an article makes use of heading adornments to markup
 
+chapter, sections and subsections.
 
+
 
+.. _reST template:
 
+
 
+reST template
 
+-------------
 
+
 
+reST template for an simple article:
 
+
 
+.. code:: reST
 
+
 
+    .. _doc refname:
 
+
 
+    ==============
 
+    Document title
 
+    ==============
 
+
 
+    Lorem ipsum dolor sit amet, consectetur adipisici elit ..  Further read
 
+    :ref:`chapter refname`.
 
+
 
+    .. _chapter refname:
 
+
 
+    Chapter
 
+    =======
 
+
 
+    Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
 
+    aliquid ex ea commodi consequat ...
 
+
 
+    .. _section refname:
 
+
 
+    Section
 
+    -------
 
+
 
+    lorem ..
 
+
 
+    .. _subsection refname:
 
+
 
+    Subsection
 
+    ~~~~~~~~~~
 
+
 
+    lorem ..
 
+
 
+
 
+Headings
 
+--------
 
+
 
+#. title - with overline for document title:
 
+
 
+  .. code:: reST
 
+
 
+    ==============
 
+    Document title
 
+    ==============
 
+
 
+
 
+#. chapter - with anchor named ``anchor name``:
 
+
 
+   .. code:: reST
 
+
 
+      .. _anchor name:
 
+
 
+      Chapter
 
+      =======
 
+
 
+#. section
 
+
 
+   .. code:: reST
 
+
 
+      Section
 
+      -------
 
+
 
+#. subsection
 
+
 
+   .. code:: reST
 
+
 
+      Subsection
 
+      ~~~~~~~~~~
 
+
 
+
 
+
 
+Anchors & Links
 
+===============
 
+
 
+.. _reST anchor:
 
+
 
+Anchors
 
+-------
 
+
 
+.. _ref role:
 
+   https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref
 
+
 
+To refer a point in the documentation a anchor is needed.  The :ref:`reST
 
+template <reST template>` shows an example where a chapter titled *"Chapters"*
 
+gets an anchor named ``chapter title``.  Another example from *this* document,
 
+where the anchor named ``reST anchor``:
 
+
 
+.. code:: reST
 
+
 
+   .. _reST anchor:
 
+
 
+   Anchors
 
+   -------
 
+
 
+   To refer a point in the documentation a anchor is needed ...
 
+
 
+To refer anchors use the `ref role`_ markup:
 
+
 
+.. code:: reST
 
+
 
+   Visit chapter :ref:`reST anchor`.  Or set hyperlink text manually :ref:`foo
 
+   bar <reST anchor>`.
 
+
 
+.. admonition:: ``:ref:`` role
 
+   :class: rst-example
 
+
 
+   Visit chapter :ref:`reST anchor`.  Or set hyperlink text manually :ref:`foo
 
+   bar <reST anchor>`.
 
+
 
+.. _reST ordinary ref:
 
+
 
+Link ordinary URL
 
+-----------------
 
+
 
+If you need to reference external URLs use *named* hyperlinks to maintain
 
+readability of reST sources.  Here is a example taken from *this* article:
 
+
 
+.. code:: reST
 
+
 
+   .. _Sphinx Field Lists:
 
+      https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html
 
+
 
+   With the *named* hyperlink `Sphinx Field Lists`_, the raw text is much more
 
+   readable.
 
+
 
+   And this shows the alternative (less readable) hyperlink markup `Sphinx Field
 
+   Lists
 
+   <https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html>`__.
 
+
 
+.. admonition:: Named hyperlink
 
+   :class: rst-example
 
+
 
+   With the *named* hyperlink `Sphinx Field Lists`_, the raw text is much more
 
+   readable.
 
+
 
+   And this shows the alternative (less readable) hyperlink markup `Sphinx Field
 
+   Lists
 
+   <https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html>`__.
 
+
 
+
 
+.. _reST smart ref:
 
+
 
+Smart refs
 
+----------
 
+
 
+With the power of sphinx.ext.extlinks_ and intersphinx_ referencing external
 
+content becomes smart.
 
+
 
+.. table:: smart refs with sphinx.ext.extlinks_ and intersphinx_
 
+   :widths: 4 3 7
 
+
 
+   ========================== ================================== ====================================
 
+   refer ...                  rendered example                   markup
 
+   ========================== ================================== ====================================
 
+   :rst:role:`rfc`            :rfc:`822`                         ``:rfc:`822```
 
+   :rst:role:`pep`            :pep:`8`                           ``:pep:`8```
 
+   sphinx.ext.extlinks_
 
+   --------------------------------------------------------------------------------------------------
 
+   project's wiki article     :wiki:`Offline-engines`            ``:wiki:`Offline-engines```
 
+   to docs public URL         :docs:`dev/reST.html`              ``:docs:`dev/reST.html```
 
+   files & folders origin     :origin:`docs/dev/reST.rst`        ``:origin:`docs/dev/reST.rst```
 
+   pull request               :pull:`4`                          ``:pull:`4```
 
+   patch                      :patch:`af2cae6`                   ``:patch:`af2cae6```
 
+   PyPi package               :pypi:`httpx`                      ``:pypi:`httpx```
 
+   manual page man            :man:`bash`                        ``:man:`bash```
 
+   intersphinx_
 
+   --------------------------------------------------------------------------------------------------
 
+   external anchor            :ref:`python:and`                  ``:ref:`python:and```
 
+   external doc anchor        :doc:`jinja:templates`             ``:doc:`jinja:templates```
 
+   python code object         :py:obj:`datetime.datetime`        ``:py:obj:`datetime.datetime```
 
+   flask code object          :py:obj:`flask.Flask`              ``:py:obj:`flask.Flask```
 
+   ========================== ================================== ====================================
 
+
 
+
 
+Intersphinx is configured in :origin:`docs/conf.py`:
 
+
 
+.. code:: python
 
+
 
+    intersphinx_mapping = {
 
+        "python": ("https://docs.python.org/3/", None),
 
+        "flask": ("https://flask.palletsprojects.com/", None),
 
+        "jinja": ("https://jinja.palletsprojects.com/", None),
 
+        "linuxdoc" : ("https://return42.github.io/linuxdoc/", None),
 
+        "sphinx" : ("https://www.sphinx-doc.org/en/master/", None),
 
+    }
 
+
 
+
 
+To list all anchors of the inventory (e.g. ``python``) use:
 
+
 
+.. code:: sh
 
+
 
+   $ python -m sphinx.ext.intersphinx https://docs.python.org/3/objects.inv
 
+   ...
 
+   $ python -m sphinx.ext.intersphinx https://docs.searxng.org/objects.inv
 
+   ...
 
+
 
+Literal blocks
 
+==============
 
+
 
+The simplest form of :duref:`literal-blocks` is a indented block introduced by
 
+two colons (``::``).  For highlighting use :dudir:`highlight` or :ref:`reST
 
+code` directive.  To include literals from external files use
 
+:rst:dir:`literalinclude` or :ref:`kernel-include <kernel-include-directive>`
 
+directive (latter one expands environment variables in the path name).
 
+
 
+.. _reST literal:
 
+
 
+``::``
 
+------
 
+
 
+.. code:: reST
 
+
 
+   ::
 
+
 
+     Literal block
 
+
 
+   Lorem ipsum dolor::
 
+
 
+     Literal block
 
+
 
+   Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
 
+   eirmod tempor invidunt ut labore ::
 
+
 
+     Literal block
 
+
 
+.. admonition:: Literal block
 
+   :class: rst-example
 
+
 
+   ::
 
+
 
+     Literal block
 
+
 
+   Lorem ipsum dolor::
 
+
 
+     Literal block
 
+
 
+   Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
 
+   eirmod tempor invidunt ut labore ::
 
+
 
+     Literal block
 
+
 
+
 
+.. _reST code:
 
+
 
+``code-block``
 
+--------------
 
+
 
+.. _pygments: https://pygments.org/languages/
 
+
 
+.. sidebar:: Syntax highlighting
 
+
 
+   is handled by pygments_.
 
+
 
+The :rst:dir:`code-block` directive is a variant of the :dudir:`code` directive
 
+with additional options.  To learn more about code literals visit
 
+:ref:`sphinx:code-examples`.
 
+
 
+.. code-block:: reST
 
+
 
+   The URL ``/stats`` handle is shown in :ref:`stats-handle`
 
+
 
+   .. code-block:: Python
 
+      :caption: python code block
 
+      :name: stats-handle
 
+
 
+      @app.route('/stats', methods=['GET'])
 
+      def stats():
 
+          """Render engine statistics page."""
 
+          stats = get_engines_stats()
 
+          return render(
 
+              'stats.html'
 
+              , stats = stats )
 
+
 
+.. code-block:: reST
 
+
 
+.. admonition:: Code block
 
+   :class: rst-example
 
+
 
+   The URL ``/stats`` handle is shown in :ref:`stats-handle`
 
+
 
+   .. code-block:: Python
 
+      :caption: python code block
 
+      :name: stats-handle
 
+
 
+      @app.route('/stats', methods=['GET'])
 
+      def stats():
 
+          """Render engine statistics page."""
 
+          stats = get_engines_stats()
 
+          return render(
 
+              'stats.html'
 
+              , stats = stats )
 
+
 
+Unicode substitution
 
+====================
 
+
 
+The :dudir:`unicode directive <unicode-character-codes>` converts Unicode
 
+character codes (numerical values) to characters.  This directive can only be
 
+used within a substitution definition.
 
+
 
+.. code-block:: reST
 
+
 
+   .. |copy| unicode:: 0xA9 .. copyright sign
 
+   .. |(TM)| unicode:: U+2122
 
+
 
+   Trademark |(TM)| and copyright |copy| glyphs.
 
+
 
+.. admonition:: Unicode
 
+   :class: rst-example
 
+
 
+   .. |copy| unicode:: 0xA9 .. copyright sign
 
+   .. |(TM)| unicode:: U+2122
 
+
 
+   Trademark |(TM)| and copyright |copy| glyphs.
 
+
 
+
 
+.. _reST roles:
 
+
 
+Roles
 
+=====
 
+
 
+.. sidebar:: Further reading
 
+
 
+   - `Sphinx Roles`_
 
+   - :doc:`sphinx:usage/restructuredtext/domains`
 
+
 
+
 
+A *custom interpreted text role* (:duref:`ref <roles>`) is an inline piece of
 
+explicit markup.  It signifies that that the enclosed text should be interpreted
 
+in a specific way.
 
+
 
+The general markup is one of:
 
+
 
+.. code:: reST
 
+
 
+   :rolename:`ref-name`
 
+   :rolename:`ref text <ref-name>`
 
+
 
+.. table:: smart refs with sphinx.ext.extlinks_ and intersphinx_
 
+   :widths: 4 3 7
 
+
 
+   ========================== ================================== ====================================
 
+   role                       rendered example                   markup
 
+   ========================== ================================== ====================================
 
+   :rst:role:`guilabel`       :guilabel:`&Cancel`                ``:guilabel:`&Cancel```
 
+   :rst:role:`kbd`            :kbd:`C-x C-f`                     ``:kbd:`C-x C-f```
 
+   :rst:role:`menuselection`  :menuselection:`Open --> File`     ``:menuselection:`Open --> File```
 
+   :rst:role:`download`       :download:`this file <reST.rst>`   ``:download:`this file <reST.rst>```
 
+   math_                      :math:`a^2 + b^2 = c^2`            ``:math:`a^2 + b^2 = c^2```
 
+   :rst:role:`ref`            :ref:`svg image example`           ``:ref:`svg image example```
 
+   :rst:role:`command`        :command:`ls -la`                  ``:command:`ls -la```
 
+   :durole:`emphasis`         :emphasis:`italic`                 ``:emphasis:`italic```
 
+   :durole:`strong`           :strong:`bold`                     ``:strong:`bold```
 
+   :durole:`literal`          :literal:`foo()`                   ``:literal:`foo()```
 
+   :durole:`subscript`        H\ :sub:`2`\ O                     ``H\ :sub:`2`\ O``
 
+   :durole:`superscript`      E = mc\ :sup:`2`                   ``E = mc\ :sup:`2```
 
+   :durole:`title-reference`  :title:`Time`                      ``:title:`Time```
 
+   ========================== ================================== ====================================
 
+
 
+Figures & Images
 
+================
 
+
 
+.. sidebar:: Image processing
 
+
 
+   With the directives from :ref:`linuxdoc <linuxdoc:kfigure>` the build process
 
+   is flexible.  To get best results in the generated output format, install
 
+   ImageMagick_ and Graphviz_.
 
+
 
+SearXNG's sphinx setup includes: :ref:`linuxdoc:kfigure`.  Scalable here means;
 
+scalable in sense of the build process.  Normally in absence of a converter
 
+tool, the build process will break.  From the authors POV it’s annoying to care
 
+about the build process when handling with images, especially since he has no
 
+access to the build process.  With :ref:`linuxdoc:kfigure` the build process
 
+continues and scales output quality in dependence of installed image processors.
 
+
 
+If you want to add an image, you should use the ``kernel-figure`` (inheritance
 
+of :dudir:`figure`) and ``kernel-image`` (inheritance of :dudir:`image`)
 
+directives.  E.g. to insert a figure with a scalable image format use SVG
 
+(:ref:`svg image example`):
 
+
 
+.. code:: reST
 
+
 
+   .. _svg image example:
 
+
 
+   .. kernel-figure:: svg_image.svg
 
+      :alt: SVG image example
 
+
 
+      Simple SVG image
 
+
 
+    To refer the figure, a caption block is needed: :ref:`svg image example`.
 
+
 
+.. _svg image example:
 
+
 
+.. kernel-figure:: svg_image.svg
 
+   :alt: SVG image example
 
+
 
+   Simple SVG image.
 
+
 
+To refer the figure, a caption block is needed: :ref:`svg image example`.
 
+
 
+DOT files (aka Graphviz)
 
+------------------------
 
+
 
+With :ref:`linuxdoc:kernel-figure` reST support for **DOT** formatted files is
 
+given.
 
+
 
+- `Graphviz's dot`_
 
+- DOT_
 
+- Graphviz_
 
+
 
+A simple example is shown in :ref:`dot file example`:
 
+
 
+.. code:: reST
 
+
 
+   .. _dot file example:
 
+
 
+   .. kernel-figure:: hello.dot
 
+      :alt: hello world
 
+
 
+      DOT's hello world example
 
+
 
+.. admonition:: hello.dot
 
+   :class: rst-example
 
+
 
+   .. _dot file example:
 
+
 
+   .. kernel-figure:: hello.dot
 
+      :alt: hello world
 
+
 
+      DOT's hello world example
 
+
 
+``kernel-render`` DOT
 
+---------------------
 
+
 
+Embed *render* markups (or languages) like Graphviz's **DOT** is provided by the
 
+:ref:`linuxdoc:kernel-render` directive.  A simple example of embedded DOT_ is
 
+shown in figure :ref:`dot render example`:
 
+
 
+.. code:: reST
 
+
 
+   .. _dot render example:
 
+
 
+   .. kernel-render:: DOT
 
+      :alt: digraph
 
+      :caption: Embedded  DOT (Graphviz) code
 
+
 
+      digraph foo {
 
+        "bar" -> "baz";
 
+      }
 
+
 
+   Attribute ``caption`` is needed, if you want to refer the figure: :ref:`dot
 
+   render example`.
 
+
 
+Please note :ref:`build tools <linuxdoc:kfigure_build_tools>`.  If Graphviz_ is
 
+installed, you will see an vector image.  If not, the raw markup is inserted as
 
+*literal-block*.
 
+
 
+.. admonition:: kernel-render DOT
 
+   :class: rst-example
 
+
 
+   .. _dot render example:
 
+
 
+   .. kernel-render:: DOT
 
+      :alt: digraph
 
+      :caption: Embedded  DOT (Graphviz) code
 
+
 
+      digraph foo {
 
+        "bar" -> "baz";
 
+      }
 
+
 
+   Attribute ``caption`` is needed, if you want to refer the figure: :ref:`dot
 
+   render example`.
 
+
 
+``kernel-render`` SVG
 
+---------------------
 
+
 
+A simple example of embedded SVG_ is shown in figure :ref:`svg render example`:
 
+
 
+.. code:: reST
 
+
 
+   .. _svg render example:
 
+
 
+   .. kernel-render:: SVG
 
+      :caption: Embedded **SVG** markup
 
+      :alt: so-nw-arrow
 
+..
 
+
 
+  .. code:: xml
 
+
 
+      <?xml version="1.0" encoding="UTF-8"?>
 
+      <svg xmlns="http://www.w3.org/2000/svg" version="1.1"
 
+           baseProfile="full" width="70px" height="40px"
 
+           viewBox="0 0 700 400"
 
+           >
 
+        <line x1="180" y1="370"
 
+              x2="500" y2="50"
 
+              stroke="black" stroke-width="15px"
 
+              />
 
+        <polygon points="585 0 525 25 585 50"
 
+                 transform="rotate(135 525 25)"
 
+                 />
 
+      </svg>
 
+
 
+.. admonition:: kernel-render SVG
 
+   :class: rst-example
 
+
 
+   .. _svg render example:
 
+
 
+   .. kernel-render:: SVG
 
+      :caption: Embedded **SVG** markup
 
+      :alt: so-nw-arrow
 
+
 
+      <?xml version="1.0" encoding="UTF-8"?>
 
+      <svg xmlns="http://www.w3.org/2000/svg" version="1.1"
 
+           baseProfile="full" width="70px" height="40px"
 
+           viewBox="0 0 700 400"
 
+           >
 
+        <line x1="180" y1="370"
 
+              x2="500" y2="50"
 
+              stroke="black" stroke-width="15px"
 
+              />
 
+        <polygon points="585 0 525 25 585 50"
 
+                 transform="rotate(135 525 25)"
 
+                 />
 
+      </svg>
 
+
 
+
 
+
 
+
 
+.. _reST lists:
 
+
 
+List markups
 
+============
 
+
 
+Bullet list
 
+-----------
 
+
 
+List markup (:duref:`ref <bullet-lists>`) is simple:
 
+
 
+.. code:: reST
 
+
 
+   - This is a bulleted list.
 
+
 
+     1. Nested lists are possible, but be aware that they must be separated from
 
+        the parent list items by blank line
 
+     2. Second item of nested list
 
+
 
+   - It has two items, the second
 
+     item uses two lines.
 
+
 
+   #. This is a numbered list.
 
+   #. It has two items too.
 
+
 
+.. admonition:: bullet list
 
+   :class: rst-example
 
+
 
+   - This is a bulleted list.
 
+
 
+     1. Nested lists are possible, but be aware that they must be separated from
 
+        the parent list items by blank line
 
+     2. Second item of nested list
 
+
 
+   - It has two items, the second
 
+     item uses two lines.
 
+
 
+   #. This is a numbered list.
 
+   #. It has two items too.
 
+
 
+
 
+Horizontal list
 
+---------------
 
+
 
+The :rst:dir:`.. hlist:: <hlist>` transforms a bullet list into a more compact
 
+list.
 
+
 
+.. code:: reST
 
+
 
+   .. hlist::
 
+
 
+      - first list item
 
+      - second list item
 
+      - third list item
 
+      ...
 
+
 
+.. admonition:: hlist
 
+   :class: rst-example
 
+
 
+   .. hlist::
 
+
 
+      - first list item
 
+      - second list item
 
+      - third list item
 
+      - next list item
 
+      - next list item xxxx
 
+      - next list item yyyy
 
+      - next list item zzzz
 
+
 
+
 
+Definition list
 
+---------------
 
+
 
+.. sidebar:: Note ..
 
+
 
+   - the term cannot have more than one line of text
 
+
 
+   - there is **no blank line between term and definition block** // this
 
+     distinguishes definition lists (:duref:`ref <definition-lists>`) from block
 
+     quotes (:duref:`ref <block-quotes>`).
 
+
 
+Each definition list (:duref:`ref <definition-lists>`) item contains a term,
 
+optional classifiers and a definition.  A term is a simple one-line word or
 
+phrase.  Optional classifiers may follow the term on the same line, each after
 
+an inline ' : ' (**space, colon, space**).  A definition is a block indented
 
+relative to the term, and may contain multiple paragraphs and other body
 
+elements.  There may be no blank line between a term line and a definition block
 
+(*this distinguishes definition lists from block quotes*).  Blank lines are
 
+required before the first and after the last definition list item, but are
 
+optional in-between.
 
+
 
+Definition lists are created as follows:
 
+
 
+.. code:: reST
 
+
 
+   term 1 (up to a line of text)
 
+       Definition 1.
 
+
 
+   See the typo : this line is not a term!
 
+
 
+     And this is not term's definition.  **There is a blank line** in between
 
+     the line above and this paragraph.  That's why this paragraph is taken as
 
+     **block quote** (:duref:`ref <block-quotes>`) and not as term's definition!
 
+
 
+   term 2
 
+       Definition 2, paragraph 1.
 
+
 
+       Definition 2, paragraph 2.
 
+
 
+   term 3 : classifier
 
+       Definition 3.
 
+
 
+   term 4 : classifier one : classifier two
 
+       Definition 4.
 
+
 
+.. admonition:: definition list
 
+   :class: rst-example
 
+
 
+   term 1 (up to a line of text)
 
+       Definition 1.
 
+
 
+   See the typo : this line is not a term!
 
+
 
+     And this is not term's definition.  **There is a blank line** in between
 
+     the line above and this paragraph.  That's why this paragraph is taken as
 
+     **block quote** (:duref:`ref <block-quotes>`) and not as term's definition!
 
+
 
+
 
+   term 2
 
+       Definition 2, paragraph 1.
 
+
 
+       Definition 2, paragraph 2.
 
+
 
+   term 3 : classifier
 
+       Definition 3.
 
+
 
+   term 4 : classifier one : classifier two
 
+
 
+
 
+Quoted paragraphs
 
+-----------------
 
+
 
+Quoted paragraphs (:duref:`ref <block-quotes>`) are created by just indenting
 
+them more than the surrounding paragraphs.  Line blocks (:duref:`ref
 
+<line-blocks>`) are a way of preserving line breaks:
 
+
 
+.. code:: reST
 
+
 
+   normal paragraph ...
 
+   lorem ipsum.
 
+
 
+      Quoted paragraph ...
 
+      lorem ipsum.
 
+
 
+   | These lines are
 
+   | broken exactly like in
 
+   | the source file.
 
+
 
+
 
+.. admonition:: Quoted paragraph and line block
 
+   :class: rst-example
 
+
 
+   normal paragraph ...
 
+   lorem ipsum.
 
+
 
+      Quoted paragraph ...
 
+      lorem ipsum.
 
+
 
+   | These lines are
 
+   | broken exactly like in
 
+   | the source file.
 
+
 
+
 
+.. _reST field list:
 
+
 
+Field Lists
 
+-----------
 
+
 
+.. _Sphinx Field Lists:
 
+   https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html
 
+
 
+.. sidebar::  bibliographic fields
 
+
 
+   First lines fields are bibliographic fields, see `Sphinx Field Lists`_.
 
+
 
+Field lists are used as part of an extension syntax, such as options for
 
+directives, or database-like records meant for further processing.  Field lists
 
+are mappings from field names to field bodies.  They marked up like this:
 
+
 
+.. code:: reST
 
+
 
+   :fieldname: Field content
 
+   :foo:       first paragraph in field foo
 
+
 
+               second paragraph in field foo
 
+
 
+   :bar:       Field content
 
+
 
+.. admonition:: Field List
 
+   :class: rst-example
 
+
 
+   :fieldname: Field content
 
+   :foo:       first paragraph in field foo
 
+
 
+               second paragraph in field foo
 
+
 
+   :bar:       Field content
 
+
 
+
 
+They are commonly used in Python documentation:
 
+
 
+.. code:: python
 
+
 
+   def my_function(my_arg, my_other_arg):
 
+       """A function just for me.
 
+
 
+       :param my_arg: The first of my arguments.
 
+       :param my_other_arg: The second of my arguments.
 
+
 
+       :returns: A message (just for me, of course).
 
+       """
 
+
 
+Further list blocks
 
+-------------------
 
+
 
+- field lists (:duref:`ref <field-lists>`, with caveats noted in
 
+  :ref:`reST field list`)
 
+- option lists (:duref:`ref <option-lists>`)
 
+- quoted literal blocks (:duref:`ref <quoted-literal-blocks>`)
 
+- doctest blocks (:duref:`ref <doctest-blocks>`)
 
+
 
+
 
+Admonitions
 
+===========
 
+
 
+Sidebar
 
+-------
 
+
 
+Sidebar is an eye catcher, often used for admonitions pointing further stuff or
 
+site effects.  Here is the source of the sidebar :ref:`on top of this page <reST
 
+primer>`.
 
+
 
+.. code:: reST
 
+
 
+   .. sidebar:: KISS_ and readability_
 
+
 
+      Instead of defining more and more roles, we at SearXNG encourage our
 
+      contributors to follow principles like KISS_ and readability_.
 
+
 
+Generic admonition
 
+------------------
 
+
 
+The generic :dudir:`admonition <admonitions>` needs a title:
 
+
 
+.. code:: reST
 
+
 
+   .. admonition:: generic admonition title
 
+
 
+      lorem ipsum ..
 
+
 
+
 
+.. admonition:: generic admonition title
 
+
 
+   lorem ipsum ..
 
+
 
+
 
+Specific admonitions
 
+--------------------
 
+
 
+Specific admonitions: :dudir:`hint`, :dudir:`note`, :dudir:`tip` :dudir:`attention`,
 
+:dudir:`caution`, :dudir:`danger`, :dudir:`error`, , :dudir:`important`, and
 
+:dudir:`warning` .
 
+
 
+.. code:: reST
 
+
 
+   .. hint::
 
+
 
+      lorem ipsum ..
 
+
 
+   .. note::
 
+
 
+      lorem ipsum ..
 
+
 
+   .. warning::
 
+
 
+      lorem ipsum ..
 
+
 
+
 
+.. hint::
 
+
 
+   lorem ipsum ..
 
+
 
+.. note::
 
+
 
+   lorem ipsum ..
 
+
 
+.. tip::
 
+
 
+   lorem ipsum ..
 
+
 
+.. attention::
 
+
 
+   lorem ipsum ..
 
+
 
+.. caution::
 
+
 
+   lorem ipsum ..
 
+
 
+.. danger::
 
+
 
+   lorem ipsum ..
 
+
 
+.. important::
 
+
 
+   lorem ipsum ..
 
+
 
+.. error::
 
+
 
+   lorem ipsum ..
 
+
 
+.. warning::
 
+
 
+   lorem ipsum ..
 
+
 
+
 
+Tables
 
+======
 
+
 
+.. sidebar:: Nested tables
 
+
 
+   Nested tables are ugly! Not all builder support nested tables, don't use
 
+   them!
 
+
 
+ASCII-art tables like :ref:`reST simple table` and :ref:`reST grid table` might
 
+be comfortable for readers of the text-files, but they have huge disadvantages
 
+in the creation and modifying.  First, they are hard to edit.  Think about
 
+adding a row or a column to a ASCII-art table or adding a paragraph in a cell,
 
+it is a nightmare on big tables.
 
+
 
+
 
+.. sidebar:: List tables
 
+
 
+   For meaningful patch and diff use :ref:`reST flat table`.
 
+
 
+Second the diff of modifying ASCII-art tables is not meaningful, e.g. widening a
 
+cell generates a diff in which also changes are included, which are only
 
+ascribable to the ASCII-art.  Anyway, if you prefer ASCII-art for any reason,
 
+here are some helpers:
 
+
 
+* `Emacs Table Mode`_
 
+* `Online Tables Generator`_
 
+
 
+.. _reST simple table:
 
+
 
+Simple tables
 
+-------------
 
+
 
+:duref:`Simple tables <simple-tables>` allow *colspan* but not *rowspan*.  If
 
+your table need some metadata (e.g. a title) you need to add the ``.. table::
 
+directive`` :dudir:`(ref) <table>` in front and place the table in its body:
 
+
 
+.. code:: reST
 
+
 
+   .. table:: foo gate truth table
 
+      :widths: grid
 
+      :align: left
 
+
 
+      ====== ====== ======
 
+          Inputs    Output
 
+      ------------- ------
 
+      A      B      A or B
 
+      ====== ====== ======
 
+      False
 
+      --------------------
 
+      True
 
+      --------------------
 
+      True   False  True
 
+             (foo)
 
+      ------ ------ ------
 
+      False  True
 
+             (foo)
 
+      ====== =============
 
+
 
+.. admonition:: Simple ASCII table
 
+   :class: rst-example
 
+
 
+   .. table:: foo gate truth table
 
+      :widths: grid
 
+      :align: left
 
+
 
+      ====== ====== ======
 
+          Inputs    Output
 
+      ------------- ------
 
+      A      B      A or B
 
+      ====== ====== ======
 
+      False
 
+      --------------------
 
+      True
 
+      --------------------
 
+      True   False  True
 
+             (foo)
 
+      ------ ------ ------
 
+      False  True
 
+             (foo)
 
+      ====== =============
 
+
 
+
 
+
 
+.. _reST grid table:
 
+
 
+Grid tables
 
+-----------
 
+
 
+:duref:`Grid tables <grid-tables>` allow colspan *colspan* and *rowspan*:
 
+
 
+.. code:: reST
 
+
 
+   .. table:: grid table example
 
+      :widths: 1 1 5
 
+
 
+      +------------+------------+-----------+
 
+      | Header 1   | Header 2   | Header 3  |
 
+      +============+============+===========+
 
+      | body row 1 | column 2   | column 3  |
 
+      +------------+------------+-----------+
 
+      | body row 2 | Cells may span columns.|
 
+      +------------+------------+-----------+
 
+      | body row 3 | Cells may  | - Cells   |
 
+      +------------+ span rows. | - contain |
 
+      | body row 4 |            | - blocks. |
 
+      +------------+------------+-----------+
 
+
 
+.. admonition:: ASCII grid table
 
+   :class: rst-example
 
+
 
+   .. table:: grid table example
 
+      :widths: 1 1 5
 
+
 
+      +------------+------------+-----------+
 
+      | Header 1   | Header 2   | Header 3  |
 
+      +============+============+===========+
 
+      | body row 1 | column 2   | column 3  |
 
+      +------------+------------+-----------+
 
+      | body row 2 | Cells may span columns.|
 
+      +------------+------------+-----------+
 
+      | body row 3 | Cells may  | - Cells   |
 
+      +------------+ span rows. | - contain |
 
+      | body row 4 |            | - blocks. |
 
+      +------------+------------+-----------+
 
+
 
+
 
+.. _reST flat table:
 
+
 
+flat-table
 
+----------
 
+
 
+The ``flat-table`` is a further developed variant of the :ref:`list tables
 
+<linuxdoc:list-table-directives>`.  It is a double-stage list similar to the
 
+:dudir:`list-table` with some additional features:
 
+
 
+column-span: ``cspan``
 
+  with the role ``cspan`` a cell can be extended through additional columns
 
+
 
+row-span: ``rspan``
 
+  with the role ``rspan`` a cell can be extended through additional rows
 
+
 
+auto-span:
 
+  spans rightmost cell of a table row over the missing cells on the right side
 
+  of that table-row.  With Option ``:fill-cells:`` this behavior can changed
 
+  from *auto span* to *auto fill*, which automatically inserts (empty) cells
 
+  instead of spanning the last cell.
 
+
 
+options:
 
+  :header-rows:   [int] count of header rows
 
+  :stub-columns:  [int] count of stub columns
 
+  :widths:        [[int] [int] ... ] widths of columns
 
+  :fill-cells:    instead of auto-span missing cells, insert missing cells
 
+
 
+roles:
 
+  :cspan: [int] additional columns (*morecols*)
 
+  :rspan: [int] additional rows (*morerows*)
 
+
 
+The example below shows how to use this markup.  The first level of the staged
 
+list is the *table-row*. In the *table-row* there is only one markup allowed,
 
+the list of the cells in this *table-row*. Exception are *comments* ( ``..`` )
 
+and *targets* (e.g. a ref to :ref:`row 2 of table's body <row body 2>`).
 
+
 
+.. code:: reST
 
+
 
+   .. flat-table:: ``flat-table`` example
 
+      :header-rows: 2
 
+      :stub-columns: 1
 
+      :widths: 1 1 1 1 2
 
+
 
+      * - :rspan:`1` head / stub
 
+        - :cspan:`3` head 1.1-4
 
+
 
+      * - head 2.1
 
+        - head 2.2
 
+        - head 2.3
 
+        - head 2.4
 
+
 
+      * .. row body 1 / this is a comment
 
+
 
+        - row 1
 
+        - :rspan:`2` cell 1-3.1
 
+        - cell 1.2
 
+        - cell 1.3
 
+        - cell 1.4
 
+
 
+      * .. Comments and targets are allowed on *table-row* stage.
 
+        .. _`row body 2`:
 
+
 
+        - row 2
 
+        - cell 2.2
 
+        - :rspan:`1` :cspan:`1`
 
+          cell 2.3 with a span over
 
+
 
+          * col 3-4 &
 
+          * row 2-3
 
+
 
+      * - row 3
 
+        - cell 3.2
 
+
 
+      * - row 4
 
+        - cell 4.1
 
+        - cell 4.2
 
+        - cell 4.3
 
+        - cell 4.4
 
+
 
+      * - row 5
 
+        - cell 5.1 with automatic span to right end
 
+
 
+      * - row 6
 
+        - cell 6.1
 
+        - ..
 
+
 
+
 
+.. admonition:: List table
 
+   :class: rst-example
 
+
 
+   .. flat-table:: ``flat-table`` example
 
+      :header-rows: 2
 
+      :stub-columns: 1
 
+      :widths: 1 1 1 1 2
 
+
 
+      * - :rspan:`1` head / stub
 
+        - :cspan:`3` head 1.1-4
 
+
 
+      * - head 2.1
 
+        - head 2.2
 
+        - head 2.3
 
+        - head 2.4
 
+
 
+      * .. row body 1 / this is a comment
 
+
 
+        - row 1
 
+        - :rspan:`2` cell 1-3.1
 
+        - cell 1.2
 
+        - cell 1.3
 
+        - cell 1.4
 
+
 
+      * .. Comments and targets are allowed on *table-row* stage.
 
+        .. _`row body 2`:
 
+
 
+        - row 2
 
+        - cell 2.2
 
+        - :rspan:`1` :cspan:`1`
 
+          cell 2.3 with a span over
 
+
 
+          * col 3-4 &
 
+          * row 2-3
 
+
 
+      * - row 3
 
+        - cell 3.2
 
+
 
+      * - row 4
 
+        - cell 4.1
 
+        - cell 4.2
 
+        - cell 4.3
 
+        - cell 4.4
 
+
 
+      * - row 5
 
+        - cell 5.1 with automatic span to right end
 
+
 
+      * - row 6
 
+        - cell 6.1
 
+        - ..
 
+
 
+
 
+CSV table
 
+---------
 
+
 
+CSV table might be the choice if you want to include CSV-data from a outstanding
 
+(build) process into your documentation.
 
+
 
+.. code:: reST
 
+
 
+   .. csv-table:: CSV table example
 
+      :header: .. , Column 1, Column 2
 
+      :widths: 2 5 5
 
+      :stub-columns: 1
 
+      :file: csv_table.txt
 
+
 
+Content of file ``csv_table.txt``:
 
+
 
+.. literalinclude:: csv_table.txt
 
+
 
+.. admonition:: CSV table
 
+   :class: rst-example
 
+
 
+   .. csv-table:: CSV table example
 
+      :header: .. , Column 1, Column 2
 
+      :widths: 3 5 5
 
+      :stub-columns: 1
 
+      :file: csv_table.txt
 
+
 
+Templating
 
+==========
 
+
 
+.. sidebar:: Build environment
 
+
 
+   All *generic-doc* tasks are running in the :ref:`make install`.
 
+
 
+Templating is suitable for documentation which is created generic at the build
 
+time.  The sphinx-jinja_ extension evaluates jinja_ templates in the :ref:`make
 
+install` (with SearXNG modules installed).  We use this e.g. to build chapter:
 
+:ref:`configured engines`.  Below the jinja directive from the
 
+:origin:`docs/admin/engines.rst` is shown:
 
+
 
+.. literalinclude:: ../user/configured_engines.rst
 
+   :language: reST
 
+   :start-after: .. _configured engines:
 
+
 
+The context for the template is selected in the line ``.. jinja:: searx``.  In
 
+sphinx's build configuration (:origin:`docs/conf.py`) the ``searx`` context
 
+contains the ``engines`` and ``plugins``.
 
+
 
+.. code:: py
 
+
 
+   import searx.search
 
+   import searx.engines
 
+   import searx.plugins
 
+   searx.search.initialize()
 
+   jinja_contexts = {
 
+      'searx': {
 
+         'engines': searx.engines.engines,
 
+         'plugins': searx.plugins.plugins
 
+      },
 
+   }
 
+
 
+
 
+Tabbed views
 
+============
 
+
 
+.. _sphinx-tabs: https://github.com/djungelorm/sphinx-tabs
 
+.. _basic-tabs: https://github.com/djungelorm/sphinx-tabs#basic-tabs
 
+.. _group-tabs: https://github.com/djungelorm/sphinx-tabs#group-tabs
 
+.. _code-tabs: https://github.com/djungelorm/sphinx-tabs#code-tabs
 
+
 
+With `sphinx-tabs`_ extension we have *tabbed views*.  To provide installation
 
+instructions with one tab per distribution we use the `group-tabs`_ directive,
 
+others are basic-tabs_ and code-tabs_.  Below a *group-tab* example from
 
+:ref:`docs build` is shown:
 
+
 
+.. literalinclude:: ../admin/buildhosts.rst
 
+   :language: reST
 
+   :start-after: .. SNIP sh lint requirements
 
+   :end-before: .. SNAP sh lint requirements
 
+
 
+.. _math:
 
+
 
+Math equations
 
+==============
 
+
 
+.. _Mathematics: https://en.wikibooks.org/wiki/LaTeX/Mathematics
 
+.. _amsmath user guide:
 
+   http://vesta.informatik.rwth-aachen.de/ftp/pub/mirror/ctan/macros/latex/required/amsmath/amsldoc.pdf
 
+
 
+.. sidebar:: About LaTeX
 
+
 
+   - `amsmath user guide`_
 
+   - Mathematics_
 
+   - :ref:`docs build`
 
+
 
+The input language for mathematics is LaTeX markup using the :ctan:`amsmath`
 
+package.
 
+
 
+To embed LaTeX markup in reST documents, use role :rst:role:`:math: <math>` for
 
+inline and directive :rst:dir:`.. math:: <math>` for block markup.
 
+
 
+.. code:: reST
 
+
 
+   In :math:numref:`schroedinger general` the time-dependent Schrödinger equation
 
+   is shown.
 
+
 
+   .. math::
 
+      :label: schroedinger general
 
+
 
+       \mathrm{i}\hbar\dfrac{\partial}{\partial t} |\,\psi (t) \rangle =
 
+             \hat{H} |\,\psi (t) \rangle.
 
+
 
+.. admonition:: LaTeX math equation
 
+   :class: rst-example
 
+
 
+   In :math:numref:`schroedinger general` the time-dependent Schrödinger equation
 
+   is shown.
 
+
 
+   .. math::
 
+      :label: schroedinger general
 
+
 
+       \mathrm{i}\hbar\dfrac{\partial}{\partial t} |\,\psi (t) \rangle =
 
+             \hat{H} |\,\psi (t) \rangle.
 
+
 
+
 
+The next example shows the difference of ``\tfrac`` (*textstyle*) and ``\dfrac``
 
+(*displaystyle*) used in a inline markup or another fraction.
 
+
 
+.. code:: reST
 
+
 
+   ``\tfrac`` **inline example** :math:`\tfrac{\tfrac{1}{x}+\tfrac{1}{y}}{y-z}`
 
+   ``\dfrac`` **inline example** :math:`\dfrac{\dfrac{1}{x}+\dfrac{1}{y}}{y-z}`
 
+
 
+.. admonition:: Line spacing
 
+   :class: rst-example
 
+
 
+   Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
 
+   eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
 
+   voluptua.  ...
 
+   ``\tfrac`` **inline example** :math:`\tfrac{\tfrac{1}{x}+\tfrac{1}{y}}{y-z}`
 
+   At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd
 
+   gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
 
+
 
+   Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
 
+   eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
 
+   voluptua.  ...
 
+   ``\tfrac`` **inline example** :math:`\dfrac{\dfrac{1}{x}+\dfrac{1}{y}}{y-z}`
 
+   At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd
 
+   gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
 
+
 
+
 
+.. _KISS: https://en.wikipedia.org/wiki/KISS_principle
 
+
 
+.. _readability: https://docs.python-guide.org/writing/style/
 
+.. _Sphinx-Primer:
 
+    https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
 
+.. _reST: https://docutils.sourceforge.io/rst.html
 
+.. _Sphinx Roles:
 
+    https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html
 
+.. _Sphinx: https://www.sphinx-doc.org
 
+.. _`sphinx-doc FAQ`: https://www.sphinx-doc.org/en/stable/faq.html
 
+.. _Sphinx markup constructs:
 
+    https://www.sphinx-doc.org/en/stable/markup/index.html
 
+.. _`sphinx cross references`:
 
+    https://www.sphinx-doc.org/en/stable/markup/inline.html#cross-referencing-arbitrary-locations
 
+.. _sphinx.ext.extlinks:
 
+    https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
 
+.. _intersphinx: https://www.sphinx-doc.org/en/stable/ext/intersphinx.html
 
+.. _sphinx config: https://www.sphinx-doc.org/en/stable/config.html
 
+.. _Sphinx's autodoc: https://www.sphinx-doc.org/en/stable/ext/autodoc.html
 
+.. _Sphinx's Python domain:
 
+    https://www.sphinx-doc.org/en/stable/domains.html#the-python-domain
 
+.. _Sphinx's C domain:
 
+   https://www.sphinx-doc.org/en/stable/domains.html#cross-referencing-c-constructs
 
+.. _doctree:
 
+    https://www.sphinx-doc.org/en/master/extdev/tutorial.html?highlight=doctree#build-phases
 
+.. _docutils: http://docutils.sourceforge.net/docs/index.html
 
+.. _docutils FAQ: http://docutils.sourceforge.net/FAQ.html
 
+.. _linuxdoc: https://return42.github.io/linuxdoc
 
+.. _jinja: https://jinja.palletsprojects.com/
 
+.. _sphinx-jinja: https://github.com/tardyp/sphinx-jinja
 
+.. _SVG: https://www.w3.org/TR/SVG11/expanded-toc.html
 
+.. _DOT: https://graphviz.gitlab.io/_pages/doc/info/lang.html
 
+.. _`Graphviz's dot`: https://graphviz.gitlab.io/_pages/pdf/dotguide.pdf
 
+.. _Graphviz: https://graphviz.gitlab.io
 
+.. _ImageMagick: https://www.imagemagick.org
 
+
 
+.. _`Emacs Table Mode`: https://www.emacswiki.org/emacs/TableMode
 
+.. _`Online Tables Generator`: https://www.tablesgenerator.com/text_tables
 
+.. _`OASIS XML Exchange Table Model`: https://www.oasis-open.org/specs/tm9901.html

+ 3 - 0
_images/DOT-57a4a7f78690d0b6b884bc59f36e84cfb0b61f76.dot
View File 

@@ -0,0 +1,3 @@
 
+digraph foo {
 
+  "bar" -> "baz";
 
+}

+ 31 - 0
_images/DOT-57a4a7f78690d0b6b884bc59f36e84cfb0b61f76.svg
View File 

@@ -0,0 +1,31 @@
 
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
 
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 
+<!-- Generated by graphviz version 2.43.0 (0)
 
+ -->
 
+<!-- Title: foo Pages: 1 -->
 
+<svg width="62pt" height="116pt"
 
+ viewBox="0.00 0.00 62.00 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
 
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
 
+<title>foo</title>
 
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-112 58,-112 58,4 -4,4"/>
 
+<!-- bar -->
 
+<g id="node1" class="node">
 
+<title>bar</title>
 
+<ellipse fill="none" stroke="black" cx="27" cy="-90" rx="27" ry="18"/>
 
+<text text-anchor="middle" x="27" y="-86.3" font-family="Times,serif" font-size="14.00">bar</text>
 
+</g>
 
+<!-- baz -->
 
+<g id="node2" class="node">
 
+<title>baz</title>
 
+<ellipse fill="none" stroke="black" cx="27" cy="-18" rx="27" ry="18"/>
 
+<text text-anchor="middle" x="27" y="-14.3" font-family="Times,serif" font-size="14.00">baz</text>
 
+</g>
 
+<!-- bar&#45;&gt;baz -->
 
+<g id="edge1" class="edge">
 
+<title>bar&#45;&gt;baz</title>
 
+<path fill="none" stroke="black" d="M27,-71.7C27,-63.98 27,-54.71 27,-46.11"/>
 
+<polygon fill="black" stroke="black" points="30.5,-46.1 27,-36.1 23.5,-46.1 30.5,-46.1"/>
 
+</g>
 
+</g>
 
+</svg>

+ 13 - 0
_images/SVG-1fb7029fa2cc454a267bae271cccb2c591387416.svg
View File 

@@ -0,0 +1,13 @@
 
+<?xml version="1.0" encoding="UTF-8"?>
 
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1"
 
+     baseProfile="full" width="70px" height="40px"
 
+     viewBox="0 0 700 400"
 
+     >
 
+  <line x1="180" y1="370"
 
+        x2="500" y2="50"
 
+        stroke="black" stroke-width="15px"
 
+        />
 
+  <polygon points="585 0 525 25 585 50"
 
+           transform="rotate(135 525 25)"
 
+           />
 
+</svg>

+ 30 - 0
_images/arch_public.dot
View File 

@@ -0,0 +1,30 @@
 
+digraph G {
 
+
 
+  node [style=filled, shape=box, fillcolor="#ffffcc", fontname=Sans];
 
+  edge [fontname="Sans"];
 
+
 
+  browser [label="browser", shape=tab, fillcolor=aliceblue];
 
+  rp      [label="reverse proxy"];
 
+  static  [label="static files", shape=folder, href="url to configure static files", fillcolor=lightgray];
 
+  uwsgi   [label="uwsgi", shape=parallelogram href="https://docs.searxng.org/utils/searx.sh.html"]
 
+  redis     [label="redis DB", shape=cylinder];
 
+  searxng1  [label="SearXNG #1", fontcolor=blue3];
 
+  searxng2  [label="SearXNG #2", fontcolor=blue3];
 
+  searxng3  [label="SearXNG #3", fontcolor=blue3];
 
+  searxng4  [label="SearXNG #4", fontcolor=blue3];
 
+
 
+  browser -> rp [label="HTTPS"]
 
+
 
+  subgraph cluster_searxng {
 
+      label = "SearXNG instance" fontname=Sans;
 
+      bgcolor="#fafafa";
 
+      { rank=same; static rp };
 
+      rp -> static  [label="optional: reverse proxy serves static files", fillcolor=slategray, fontcolor=slategray];
 
+      rp -> uwsgi [label="http:// (tcp) or unix:// (socket)"];
 
+      uwsgi -> searxng1 -> redis;
 
+      uwsgi -> searxng2 -> redis;
 
+      uwsgi -> searxng3 -> redis;
 
+      uwsgi -> searxng4 -> redis;
 
+  }
 
+
 
+}

+ 149 - 0
_images/arch_public.svg
View File 

@@ -0,0 +1,149 @@
 
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
 
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 
+<!-- Generated by graphviz version 2.43.0 (0)
 
+ -->
 
+<!-- Title: G Pages: 1 -->
 
+<svg width="543pt" height="401pt"
 
+ viewBox="0.00 0.00 543.00 401.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
 
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 397)">
 
+<title>G</title>
 
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-397 539,-397 539,4 -4,4"/>
 
+<g id="clust1" class="cluster">
 
+<title>cluster_searxng</title>
 
+<polygon fill="#fafafa" stroke="black" points="8,-8 8,-316 527,-316 527,-8 8,-8"/>
 
+<text text-anchor="middle" x="267.5" y="-300.8" font-family="Sans" font-size="14.00">SearXNG instance</text>
 
+</g>
 
+<!-- browser -->
 
+<g id="node1" class="node">
 
+<title>browser</title>
 
+<polygon fill="aliceblue" stroke="black" points="108,-393 48,-393 48,-397 36,-397 36,-357 108,-357 108,-393"/>
 
+<polyline fill="none" stroke="black" points="36,-393 48,-393 "/>
 
+<text text-anchor="middle" x="72" y="-371.3" font-family="Sans" font-size="14.00">browser</text>
 
+</g>
 
+<!-- rp -->
 
+<g id="node2" class="node">
 
+<title>rp</title>
 
+<polygon fill="#ffffcc" stroke="black" points="128,-285 16,-285 16,-249 128,-249 128,-285"/>
 
+<text text-anchor="middle" x="72" y="-263.3" font-family="Sans" font-size="14.00">reverse proxy</text>
 
+</g>
 
+<!-- browser&#45;&gt;rp -->
 
+<g id="edge1" class="edge">
 
+<title>browser&#45;&gt;rp</title>
 
+<path fill="none" stroke="black" d="M72,-356.97C72,-340.38 72,-314.88 72,-295.43"/>
 
+<polygon fill="black" stroke="black" points="75.5,-295.34 72,-285.34 68.5,-295.34 75.5,-295.34"/>
 
+<text text-anchor="middle" x="94.5" y="-327.8" font-family="Sans" font-size="14.00">HTTPS</text>
 
+</g>
 
+<!-- static -->
 
+<g id="node3" class="node">
 
+<title>static</title>
 
+<g id="a_node3"><a xlink:href="url to configure static files" xlink:title="static files">
 
+<polygon fill="lightgray" stroke="black" points="518.5,-285 515.5,-289 494.5,-289 491.5,-285 431.5,-285 431.5,-249 518.5,-249 518.5,-285"/>
 
+<text text-anchor="middle" x="475" y="-263.3" font-family="Sans" font-size="14.00">static files</text>
 
+</a>
 
+</g>
 
+</g>
 
+<!-- rp&#45;&gt;static -->
 
+<g id="edge2" class="edge">
 
+<title>rp&#45;&gt;static</title>
 
+<path fill="none" stroke="black" d="M128.04,-267C205.6,-267 344.74,-267 421.13,-267"/>
 
+<polygon fill="slategray" stroke="black" points="421.48,-270.5 431.48,-267 421.48,-263.5 421.48,-270.5"/>
 
+<text text-anchor="middle" x="279.75" y="-273.8" font-family="Sans" font-size="14.00" fill="slategray">optional: reverse proxy serves static files</text>
 
+</g>
 
+<!-- uwsgi -->
 
+<g id="node4" class="node">
 
+<title>uwsgi</title>
 
+<g id="a_node4"><a xlink:href="https://docs.searxng.org/utils/searx.sh.html" xlink:title="uwsgi">
 
+<polygon fill="#ffffcc" stroke="black" points="244.14,-198 158.02,-198 135.86,-162 221.98,-162 244.14,-198"/>
 
+<text text-anchor="middle" x="190" y="-176.3" font-family="Sans" font-size="14.00">uwsgi</text>
 
+</a>
 
+</g>
 
+</g>
 
+<!-- rp&#45;&gt;uwsgi -->
 
+<g id="edge3" class="edge">
 
+<title>rp&#45;&gt;uwsgi</title>
 
+<path fill="none" stroke="black" d="M95.88,-248.8C113.71,-235.95 138.28,-218.26 157.84,-204.17"/>
 
+<polygon fill="black" stroke="black" points="160.09,-206.86 166.16,-198.18 156,-201.18 160.09,-206.86"/>
 
+<text text-anchor="middle" x="240.5" y="-219.8" font-family="Sans" font-size="14.00">http:// (tcp) or unix:// (socket)</text>
 
+</g>
 
+<!-- searxng1 -->
 
+<g id="node6" class="node">
 
+<title>searxng1</title>
 
+<polygon fill="#ffffcc" stroke="black" points="120,-125 16,-125 16,-89 120,-89 120,-125"/>
 
+<text text-anchor="middle" x="68" y="-103.3" font-family="Sans" font-size="14.00" fill="#0000cd">SearXNG #1</text>
 
+</g>
 
+<!-- uwsgi&#45;&gt;searxng1 -->
 
+<g id="edge4" class="edge">
 
+<title>uwsgi&#45;&gt;searxng1</title>
 
+<path fill="none" stroke="black" d="M160.78,-161.99C144.45,-152.49 123.91,-140.54 106.31,-130.29"/>
 
+<polygon fill="black" stroke="black" points="107.81,-127.12 97.41,-125.11 104.29,-133.17 107.81,-127.12"/>
 
+</g>
 
+<!-- searxng2 -->
 
+<g id="node7" class="node">
 
+<title>searxng2</title>
 
+<polygon fill="#ffffcc" stroke="black" points="242,-125 138,-125 138,-89 242,-89 242,-125"/>
 
+<text text-anchor="middle" x="190" y="-103.3" font-family="Sans" font-size="14.00" fill="#0000cd">SearXNG #2</text>
 
+</g>
 
+<!-- uwsgi&#45;&gt;searxng2 -->
 
+<g id="edge6" class="edge">
 
+<title>uwsgi&#45;&gt;searxng2</title>
 
+<path fill="none" stroke="black" d="M190,-161.81C190,-153.79 190,-144.05 190,-135.07"/>
 
+<polygon fill="black" stroke="black" points="193.5,-135.03 190,-125.03 186.5,-135.03 193.5,-135.03"/>
 
+</g>
 
+<!-- searxng3 -->
 
+<g id="node8" class="node">
 
+<title>searxng3</title>
 
+<polygon fill="#ffffcc" stroke="black" points="364,-125 260,-125 260,-89 364,-89 364,-125"/>
 
+<text text-anchor="middle" x="312" y="-103.3" font-family="Sans" font-size="14.00" fill="#0000cd">SearXNG #3</text>
 
+</g>
 
+<!-- uwsgi&#45;&gt;searxng3 -->
 
+<g id="edge8" class="edge">
 
+<title>uwsgi&#45;&gt;searxng3</title>
 
+<path fill="none" stroke="black" d="M219.22,-161.99C235.55,-152.49 256.09,-140.54 273.69,-130.29"/>
 
+<polygon fill="black" stroke="black" points="275.71,-133.17 282.59,-125.11 272.19,-127.12 275.71,-133.17"/>
 
+</g>
 
+<!-- searxng4 -->
 
+<g id="node9" class="node">
 
+<title>searxng4</title>
 
+<polygon fill="#ffffcc" stroke="black" points="486,-125 382,-125 382,-89 486,-89 486,-125"/>
 
+<text text-anchor="middle" x="434" y="-103.3" font-family="Sans" font-size="14.00" fill="#0000cd">SearXNG #4</text>
 
+</g>
 
+<!-- uwsgi&#45;&gt;searxng4 -->
 
+<g id="edge10" class="edge">
 
+<title>uwsgi&#45;&gt;searxng4</title>
 
+<path fill="none" stroke="black" d="M226,-168.52C264.37,-157.36 325.82,-139.48 372,-126.04"/>
 
+<polygon fill="black" stroke="black" points="372.99,-129.4 381.61,-123.24 371.03,-122.68 372.99,-129.4"/>
 
+</g>
 
+<!-- redis -->
 
+<g id="node5" class="node">
 
+<title>redis</title>
 
+<path fill="#ffffcc" stroke="black" d="M288.5,-48.73C288.5,-50.53 271.69,-52 251,-52 230.31,-52 213.5,-50.53 213.5,-48.73 213.5,-48.73 213.5,-19.27 213.5,-19.27 213.5,-17.47 230.31,-16 251,-16 271.69,-16 288.5,-17.47 288.5,-19.27 288.5,-19.27 288.5,-48.73 288.5,-48.73"/>
 
+<path fill="none" stroke="black" d="M288.5,-48.73C288.5,-46.92 271.69,-45.45 251,-45.45 230.31,-45.45 213.5,-46.92 213.5,-48.73"/>
 
+<text text-anchor="middle" x="251" y="-30.3" font-family="Sans" font-size="14.00">redis DB</text>
 
+</g>
 
+<!-- searxng1&#45;&gt;redis -->
 
+<g id="edge5" class="edge">
 
+<title>searxng1&#45;&gt;redis</title>
 
+<path fill="none" stroke="black" d="M111.83,-88.99C139.55,-78.24 175.36,-64.35 203.71,-53.35"/>
 
+<polygon fill="black" stroke="black" points="205.35,-56.47 213.4,-49.59 202.81,-49.94 205.35,-56.47"/>
 
+</g>
 
+<!-- searxng2&#45;&gt;redis -->
 
+<g id="edge7" class="edge">
 
+<title>searxng2&#45;&gt;redis</title>
 
+<path fill="none" stroke="black" d="M204.77,-88.81C212.26,-80.09 221.5,-69.34 229.74,-59.75"/>
 
+<polygon fill="black" stroke="black" points="232.51,-61.89 236.37,-52.03 227.2,-57.33 232.51,-61.89"/>
 
+</g>
 
+<!-- searxng3&#45;&gt;redis -->
 
+<g id="edge9" class="edge">
 
+<title>searxng3&#45;&gt;redis</title>
 
+<path fill="none" stroke="black" d="M297.23,-88.81C289.74,-80.09 280.5,-69.34 272.26,-59.75"/>
 
+<polygon fill="black" stroke="black" points="274.8,-57.33 265.63,-52.03 269.49,-61.89 274.8,-57.33"/>
 
+</g>
 
+<!-- searxng4&#45;&gt;redis -->
 
+<g id="edge11" class="edge">
 
+<title>searxng4&#45;&gt;redis</title>
 
+<path fill="none" stroke="black" d="M390.17,-88.99C362.45,-78.24 326.64,-64.35 298.29,-53.35"/>
 
+<polygon fill="black" stroke="black" points="299.19,-49.94 288.6,-49.59 296.65,-56.47 299.19,-49.94"/>
 
+</g>
 
+</g>
 
+</svg>

BIN
_images/ffox-setting-proxy-socks.png
View File


+ 3 - 0
_images/hello.dot
View File 

@@ -0,0 +1,3 @@
 
+graph G {
 
+      Hello -- World
 
+}

+ 30 - 0
_images/hello.svg
View File 

@@ -0,0 +1,30 @@
 
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
 
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
 
+<!-- Generated by graphviz version 2.43.0 (0)
 
+ -->
 
+<!-- Title: G Pages: 1 -->
 
+<svg width="85pt" height="116pt"
 
+ viewBox="0.00 0.00 84.69 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
 
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
 
+<title>G</title>
 
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-112 80.69,-112 80.69,4 -4,4"/>
 
+<!-- Hello -->
 
+<g id="node1" class="node">
 
+<title>Hello</title>
 
+<ellipse fill="none" stroke="black" cx="38.35" cy="-90" rx="35.19" ry="18"/>
 
+<text text-anchor="middle" x="38.35" y="-86.3" font-family="Times,serif" font-size="14.00">Hello</text>
 
+</g>
 
+<!-- World -->
 
+<g id="node2" class="node">
 
+<title>World</title>
 
+<ellipse fill="none" stroke="black" cx="38.35" cy="-18" rx="38.19" ry="18"/>
 
+<text text-anchor="middle" x="38.35" y="-14.3" font-family="Times,serif" font-size="14.00">World</text>
 
+</g>
 
+<!-- Hello&#45;&#45;World -->
 
+<g id="edge1" class="edge">
 
+<title>Hello&#45;&#45;World</title>
 
+<path fill="none" stroke="black" d="M38.35,-71.7C38.35,-60.85 38.35,-46.92 38.35,-36.1"/>
 
+</g>
 
+</g>
 
+</svg>

+ 25 - 0
_images/math/07c9ff4251510b06013159f4e45ec9ab97044096.svg
View File 

@@ -0,0 +1,25 @@
 
+<?xml version='1.0' encoding='UTF-8'?>
 
+<!-- This file was generated by dvisvgm 3.2.1 -->
 
+<svg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='36.523255pt' height='48.422712pt' viewBox='57.608781 53.798251 36.523255 48.422712'>
 
+<defs>
 
+<path id='g0-0' d='M9.191532-3.20797C9.428643-3.20797 9.679701-3.20797 9.679701-3.486924S9.428643-3.765878 9.191532-3.765878H1.645828C1.408717-3.765878 1.157659-3.765878 1.157659-3.486924S1.408717-3.20797 1.645828-3.20797H9.191532Z'/>
 
+<path id='g1-120' d='M6.611208-5.69066C6.164882-5.606974 5.997509-5.272229 5.997509-5.007223C5.997509-4.672478 6.262516-4.560897 6.457783-4.560897C6.876214-4.560897 7.169116-4.923537 7.169116-5.300125C7.169116-5.885928 6.499626-6.150934 5.913823-6.150934C5.063014-6.150934 4.588792-5.314072 4.463263-5.049066C4.142466-6.095143 3.277709-6.150934 3.02665-6.150934C1.603985-6.150934 .850809-4.323786 .850809-4.016936C.850809-3.961146 .9066-3.891407 1.004234-3.891407C1.115816-3.891407 1.143711-3.975093 1.171606-4.030884C1.645828-5.579078 2.580324-5.87198 2.984807-5.87198C3.612453-5.87198 3.737983-5.286177 3.737983-4.951432C3.737983-4.644583 3.654296-4.323786 3.486924-3.654296L3.012702-1.743462C2.803487-.9066 2.399004-.139477 1.659776-.139477C1.590037-.139477 1.241345-.139477 .948443-.320797C1.45056-.418431 1.562142-.836862 1.562142-1.004234C1.562142-1.283188 1.352927-1.45056 1.08792-1.45056C.753176-1.45056 .390535-1.157659 .390535-.711333C.390535-.125529 1.046077 .139477 1.645828 .139477C2.315318 .139477 2.789539-.390535 3.082441-.962391C3.305604-.139477 4.002989 .139477 4.519054 .139477C5.941719 .139477 6.694894-1.687671 6.694894-1.994521C6.694894-2.064259 6.639103-2.12005 6.555417-2.12005C6.429888-2.12005 6.41594-2.050311 6.374097-1.93873C5.997509-.711333 5.188543-.139477 4.560897-.139477C4.072727-.139477 3.807721-.502117 3.807721-1.073973C3.807721-1.380822 3.863512-1.603985 4.086675-2.524533L4.574844-4.42142C4.78406-5.258281 5.258281-5.87198 5.899875-5.87198C5.927771-5.87198 6.318306-5.87198 6.611208-5.69066Z'/>
 
+<path id='g1-121' d='M3.668244 1.562142C3.291656 2.092154 2.747696 2.566376 2.064259 2.566376C1.896887 2.566376 1.227397 2.538481 1.018182 1.896887C1.060025 1.910834 1.129763 1.910834 1.157659 1.910834C1.57609 1.910834 1.855044 1.548194 1.855044 1.227397S1.590037 .795019 1.380822 .795019C1.157659 .795019 .669489 .962391 .669489 1.645828C.669489 2.357161 1.26924 2.84533 2.064259 2.84533C3.459029 2.84533 4.867746 1.562142 5.258281 .013948L6.625156-5.425654C6.639103-5.495392 6.666999-5.579078 6.666999-5.662765C6.666999-5.87198 6.499626-6.011457 6.290411-6.011457C6.164882-6.011457 5.87198-5.955666 5.760399-5.537235L4.728269-1.436613C4.658531-1.185554 4.658531-1.157659 4.546949-1.004234C4.267995-.613699 3.807721-.139477 3.138232-.139477C2.357161-.139477 2.287422-.9066 2.287422-1.283188C2.287422-2.078207 2.66401-3.152179 3.040598-4.156413C3.194022-4.560897 3.277709-4.756164 3.277709-5.035118C3.277709-5.620922 2.859278-6.150934 2.175841-6.150934C.892653-6.150934 .376588-4.128518 .376588-4.016936C.376588-3.961146 .432379-3.891407 .530012-3.891407C.655542-3.891407 .669489-3.947198 .72528-4.142466C1.060025-5.314072 1.590037-5.87198 2.133998-5.87198C2.259527-5.87198 2.496638-5.87198 2.496638-5.411706C2.496638-5.049066 2.343213-4.644583 2.133998-4.11457C1.45056-2.287422 1.45056-1.827148 1.45056-1.492403C1.45056-.167372 2.399004 .139477 3.096389 .139477C3.500872 .139477 4.002989 .013948 4.491158-.502117L4.505106-.488169C4.29589 .334745 4.156413 .878705 3.668244 1.562142Z'/>
 
+<path id='g1-122' d='M1.771357-1.129763C2.371108-1.8132 2.859278-2.245579 3.556663-2.873225C4.393524-3.598506 4.756164-3.947198 4.951432-4.156413C5.927771-5.118804 6.41594-5.927771 6.41594-6.039352S6.304359-6.150934 6.276463-6.150934C6.178829-6.150934 6.150934-6.095143 6.081196-5.997509C5.732503-5.397758 5.397758-5.104857 5.035118-5.104857C4.742217-5.104857 4.588792-5.230386 4.323786-5.565131C4.030884-5.913823 3.793773-6.150934 3.38929-6.150934C2.371108-6.150934 1.75741-4.881694 1.75741-4.588792C1.75741-4.546949 1.771357-4.463263 1.896887-4.463263C2.008468-4.463263 2.022416-4.519054 2.064259-4.616687C2.30137-5.174595 2.970859-5.272229 3.235866-5.272229C3.528767-5.272229 3.807721-5.174595 4.100623-5.049066C4.630635-4.825903 4.853798-4.825903 4.993275-4.825903C5.090909-4.825903 5.1467-4.825903 5.216438-4.839851C4.756164-4.29589 4.002989-3.626401 3.375342-3.054545L1.966625-1.75741C1.115816-.892653 .599751-.069738 .599751 .027895C.599751 .111582 .669489 .139477 .753176 .139477S.850809 .125529 .948443-.041843C1.171606-.390535 1.617933-.9066 2.133998-.9066C2.426899-.9066 2.566376-.808966 2.84533-.460274C3.110336-.153425 3.347447 .139477 3.793773 .139477C5.160648 .139477 5.941719-1.63188 5.941719-1.952677C5.941719-2.008468 5.927771-2.092154 5.788294-2.092154C5.676712-2.092154 5.662765-2.036364 5.620922-1.896887C5.314072-1.073973 4.491158-.739228 3.947198-.739228C3.654296-.739228 3.375342-.836862 3.082441-.962391C2.524533-1.185554 2.371108-1.185554 2.189788-1.185554C2.050311-1.185554 1.896887-1.185554 1.771357-1.129763Z'/>
 
+<path id='g2-43' d='M5.565131-3.221918H9.414695C9.609963-3.221918 9.861021-3.221918 9.861021-3.472976C9.861021-3.737983 9.62391-3.737983 9.414695-3.737983H5.565131V-7.587547C5.565131-7.782814 5.565131-8.033873 5.314072-8.033873C5.049066-8.033873 5.049066-7.796762 5.049066-7.587547V-3.737983H1.199502C1.004234-3.737983 .753176-3.737983 .753176-3.486924C.753176-3.221918 .990286-3.221918 1.199502-3.221918H5.049066V.627646C5.049066 .822914 5.049066 1.073973 5.300125 1.073973C5.565131 1.073973 5.565131 .836862 5.565131 .627646V-3.221918Z'/>
 
+<path id='g2-49' d='M4.016936-8.940473C4.016936-9.26127 4.016936-9.275218 3.737983-9.275218C3.403238-8.89863 2.705853-8.382565 1.26924-8.382565V-7.978082C1.590037-7.978082 2.287422-7.978082 3.054545-8.340722V-1.073973C3.054545-.571856 3.012702-.404483 1.785305-.404483H1.352927V0C1.729514-.027895 3.082441-.027895 3.542715-.027895S5.341968-.027895 5.718555 0V-.404483H5.286177C4.05878-.404483 4.016936-.571856 4.016936-1.073973V-8.940473Z'/>
 
+</defs>
 
+<g id='page1'>
 
+<use x='59.270442' y='62.786766' xlink:href='#g2-49'/>
 
+<rect x='58.804295' y='68.456606' height='.55789' width='7.760768'/>
 
+<use x='58.804295' y='81.789907' xlink:href='#g1-120'/>
 
+<use x='70.860038' y='72.222482' xlink:href='#g2-43'/>
 
+<use x='85.942577' y='62.786766' xlink:href='#g2-49'/>
 
+<rect x='85.777106' y='68.456606' height='.55789' width='7.159416'/>
 
+<use x='85.777106' y='81.789907' xlink:href='#g1-121'/>
 
+<rect x='57.608781' y='86.175621' height='.55789' width='36.523255'/>
 
+<use x='60.284264' y='99.508922' xlink:href='#g1-121'/>
 
+<use x='70.543155' y='99.508922' xlink:href='#g0-0'/>
 
+<use x='84.490862' y='99.508922' xlink:href='#g1-122'/>
 
+</g>
 
+</svg>

+ 25 - 0
_images/math/3b8127a8eed95247f9249ea6c85e8e86df1baa82.svg
View File 

@@ -0,0 +1,25 @@
 
+<?xml version='1.0' encoding='UTF-8'?>
 
+<!-- This file was generated by dvisvgm 3.2.1 -->
 
+<svg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='23.092891pt' height='29.523663pt' viewBox='57.608781 53.79825 23.092891 29.523663'>
 
+<defs>
 
+<path id='g0-0' d='M6.434044-2.245569C6.600021-2.245569 6.775761-2.245569 6.775761-2.440836S6.600021-2.636103 6.434044-2.636103H1.152075C.986098-2.636103 .810358-2.636103 .810358-2.440836S.986098-2.245569 1.152075-2.245569H6.434044Z'/>
 
+<path id='g1-120' d='M3.260957-2.94853C3.319537-3.202377 3.544094-4.100605 4.227528-4.100605C4.276345-4.100605 4.510665-4.100605 4.715696-3.973681C4.442322-3.924865 4.247055-3.680781 4.247055-3.446461C4.247055-3.290247 4.354452-3.104744 4.618062-3.104744C4.832856-3.104744 5.145283-3.280484 5.145283-3.671018C5.145283-4.178712 4.569245-4.315398 4.237292-4.315398C3.671018-4.315398 3.329301-3.797941 3.21214-3.573384C2.968057-4.217765 2.440836-4.315398 2.157699-4.315398C1.142311-4.315398 .585801-3.055927 .585801-2.811843C.585801-2.71421 .683434-2.71421 .702961-2.71421C.781068-2.71421 .810358-2.733737 .829884-2.821607C1.161838-3.856521 1.806219-4.100605 2.138172-4.100605C2.323676-4.100605 2.665393-4.012735 2.665393-3.446461C2.665393-3.143797 2.499416-2.489653 2.138172-1.122785C1.981959-.517457 1.640242-.107397 1.210655-.107397C1.152075-.107397 .927518-.107397 .722488-.23432C.966571-.283137 1.181365-.488167 1.181365-.761541C1.181365-1.025151 .966571-1.103258 .820121-1.103258C.527221-1.103258 .283137-.849411 .283137-.536984C.283137-.08787 .771304 .107397 1.200891 .107397C1.845272 .107397 2.196753-.576037 2.226043-.634617C2.343203-.273374 2.694683 .107397 3.280484 .107397C4.286108 .107397 4.842619-1.152075 4.842619-1.396158C4.842619-1.493792 4.754749-1.493792 4.725459-1.493792C4.637589-1.493792 4.618062-1.454738 4.598535-1.386395C4.276345-.341717 3.612438-.107397 3.300011-.107397C2.91924-.107397 2.763027-.419824 2.763027-.751778C2.763027-.966571 2.821607-1.181365 2.929003-1.610952L3.260957-2.94853Z'/>
 
+<path id='g1-121' d='M4.744986-3.719834C4.784039-3.856521 4.784039-3.876048 4.784039-3.944391C4.784039-4.120131 4.647352-4.208002 4.500902-4.208002C4.403268-4.208002 4.247055-4.149422 4.159185-4.002971C4.139658-3.954155 4.061551-3.651491 4.022498-3.475751C3.954155-3.221904 3.885811-2.958293 3.827231-2.694683L3.387881-.937281C3.348827-.790831 2.929003-.107397 2.284623-.107397C1.786692-.107397 1.679295-.536984 1.679295-.898228C1.679295-1.347342 1.845272-1.952669 2.177226-2.811843C2.333439-3.21214 2.372493-3.319537 2.372493-3.514804C2.372493-3.954155 2.060066-4.315398 1.571899-4.315398C.644381-4.315398 .283137-2.899713 .283137-2.811843C.283137-2.71421 .38077-2.71421 .400297-2.71421C.497931-2.71421 .507694-2.733737 .556511-2.88995C.820121-3.807704 1.210655-4.100605 1.542608-4.100605C1.620715-4.100605 1.786692-4.100605 1.786692-3.788178C1.786692-3.544094 1.689059-3.290247 1.620715-3.104744C1.230181-2.069829 1.054441-1.513318 1.054441-1.054441C1.054441-.185504 1.669532 .107397 2.245569 .107397C2.62634 .107397 2.958293-.05858 3.231667-.331954C3.104744 .17574 2.987583 .654144 2.59705 1.171601C2.343203 1.503555 1.972196 1.786692 1.523082 1.786692C1.386395 1.786692 .947044 1.757402 .781068 1.376632C.937281 1.376632 1.064205 1.376632 1.200891 1.259471C1.298525 1.171601 1.396158 1.044678 1.396158 .859174C1.396158 .556511 1.132548 .517457 1.034915 .517457C.810358 .517457 .488167 .673671 .488167 1.152075C.488167 1.640242 .917754 2.001486 1.523082 2.001486C2.528706 2.001486 3.534331 1.113021 3.807704 .009763L4.744986-3.719834Z'/>
 
+<path id='g1-122' d='M1.298525-.810358C1.825745-1.376632 2.108882-1.620715 2.460363-1.923379C2.460363-1.933142 3.06569-2.4506 3.417171-2.80208C4.344688-3.710071 4.559482-4.178712 4.559482-4.217765C4.559482-4.315398 4.471612-4.315398 4.452085-4.315398C4.383742-4.315398 4.354452-4.295872 4.305635-4.208002C4.012735-3.739361 3.807704-3.583148 3.573384-3.583148S3.221904-3.729598 3.075454-3.895575C2.88995-4.120131 2.723973-4.315398 2.401783-4.315398C1.669532-4.315398 1.220418-3.407407 1.220418-3.202377C1.220418-3.15356 1.249708-3.09498 1.337578-3.09498S1.444975-3.143797 1.464502-3.202377C1.650005-3.651491 2.216279-3.661254 2.294386-3.661254C2.499416-3.661254 2.68492-3.592911 2.909477-3.514804C3.300011-3.368354 3.407407-3.368354 3.661254-3.368354C3.309774-2.94853 2.489653-2.245569 2.304149-2.089356L1.425448-1.269235C.761541-.615091 .419824-.05858 .419824 .009763C.419824 .107397 .517457 .107397 .536984 .107397C.615091 .107397 .634617 .08787 .693197-.019527C.917754-.361244 1.210655-.624854 1.523082-.624854C1.747639-.624854 1.845272-.536984 2.089356-.253847C2.255333-.048817 2.431073 .107397 2.71421 .107397C3.680781 .107397 4.247055-1.132548 4.247055-1.396158C4.247055-1.444975 4.208002-1.493792 4.129895-1.493792C4.042025-1.493792 4.022498-1.435212 3.993208-1.366868C3.768651-.732251 3.143797-.546747 2.821607-.546747C2.62634-.546747 2.4506-.605327 2.245569-.673671C1.913616-.800594 1.767165-.839648 1.562135-.839648C1.542608-.839648 1.386395-.839648 1.298525-.810358Z'/>
 
+<path id='g2-43' d='M3.993208-2.245569H6.717181C6.853868-2.245569 7.039372-2.245569 7.039372-2.440836S6.853868-2.636103 6.717181-2.636103H3.993208V-5.36984C3.993208-5.506526 3.993208-5.69203 3.797941-5.69203S3.602674-5.506526 3.602674-5.36984V-2.636103H.868938C.732251-2.636103 .546747-2.636103 .546747-2.440836S.732251-2.245569 .868938-2.245569H3.602674V.488167C3.602674 .624854 3.602674 .810358 3.797941 .810358S3.993208 .624854 3.993208 .488167V-2.245569Z'/>
 
+<path id='g2-49' d='M2.870423-6.248541C2.870423-6.482861 2.870423-6.502388 2.645866-6.502388C2.040539-5.877534 1.181365-5.877534 .868938-5.877534V-5.57487C1.064205-5.57487 1.640242-5.57487 2.147936-5.828717V-.771304C2.147936-.419824 2.118646-.302664 1.239945-.302664H.927518V0C1.269235-.02929 2.118646-.02929 2.50918-.02929S3.749124-.02929 4.090841 0V-.302664H3.778414C2.899713-.302664 2.870423-.41006 2.870423-.771304V-6.248541Z'/>
 
+</defs>
 
+<g id='page1'>
 
+<use x='59.153464' y='60.090183' xlink:href='#g2-49'/>
 
+<rect x='58.804295' y='61.81595' height='.55789' width='5.580027'/>
 
+<use x='58.804295' y='70.391549' xlink:href='#g1-120'/>
 
+<use x='65.579836' y='65.581827' xlink:href='#g2-43'/>
 
+<use x='74.496784' y='60.090183' xlink:href='#g2-49'/>
 
+<rect x='74.369089' y='61.81595' height='.55789' width='5.137078'/>
 
+<use x='74.369089' y='70.391549' xlink:href='#g1-121'/>
 
+<rect x='57.608781' y='72.847884' height='.55789' width='23.092891'/>
 
+<use x='60.304908' y='81.423483' xlink:href='#g1-121'/>
 
+<use x='65.441996' y='81.423483' xlink:href='#g0-0'/>
 
+<use x='73.035735' y='81.423483' xlink:href='#g1-122'/>
 
+</g>
 
+</svg>

+ 22 - 0
_images/math/6673b43f9fe29455c1fcd1164e5844698cc64d38.svg
View File 

@@ -0,0 +1,22 @@
 
+<?xml version='1.0' encoding='UTF-8'?>
 
+<!-- This file was generated by dvisvgm 3.2.1 -->
 
+<svg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='69.686469pt' height='12.418845pt' viewBox='56.413267 54.399982 69.686469 12.418845'>
 
+<defs>
 
+<path id='g1-50' d='M1.239945-.751778L2.274859-1.757402C3.797941-3.104744 4.383742-3.631964 4.383742-4.608299C4.383742-5.72132 3.505041-6.502388 2.313913-6.502388C1.210655-6.502388 .488167-5.60416 .488167-4.735222C.488167-4.188475 .976334-4.188475 1.005625-4.188475C1.171601-4.188475 1.513318-4.305635 1.513318-4.705932C1.513318-4.959779 1.337578-5.213626 .995861-5.213626C.917754-5.213626 .898228-5.213626 .868938-5.203863C1.093495-5.83848 1.620715-6.199724 2.186989-6.199724C3.075454-6.199724 3.495277-5.408893 3.495277-4.608299C3.495277-3.827231 3.00711-3.055927 2.470126-2.4506L.595564-.361244C.488167-.253847 .488167-.23432 .488167 0H4.110368L4.383742-1.698822H4.139658C4.090841-1.405922 4.022498-.976334 3.924865-.829884C3.856521-.751778 3.21214-.751778 2.997347-.751778H1.239945Z'/>
 
+<path id='g2-43' d='M5.565131-3.221918H9.414695C9.609963-3.221918 9.861021-3.221918 9.861021-3.472976C9.861021-3.737983 9.62391-3.737983 9.414695-3.737983H5.565131V-7.587547C5.565131-7.782814 5.565131-8.033873 5.314072-8.033873C5.049066-8.033873 5.049066-7.796762 5.049066-7.587547V-3.737983H1.199502C1.004234-3.737983 .753176-3.737983 .753176-3.486924C.753176-3.221918 .990286-3.221918 1.199502-3.221918H5.049066V.627646C5.049066 .822914 5.049066 1.073973 5.300125 1.073973C5.565131 1.073973 5.565131 .836862 5.565131 .627646V-3.221918Z'/>
 
+<path id='g2-61' d='M9.414695-4.519054C9.609963-4.519054 9.861021-4.519054 9.861021-4.770112C9.861021-5.035118 9.62391-5.035118 9.414695-5.035118H1.199502C1.004234-5.035118 .753176-5.035118 .753176-4.78406C.753176-4.519054 .990286-4.519054 1.199502-4.519054H9.414695ZM9.414695-1.924782C9.609963-1.924782 9.861021-1.924782 9.861021-2.175841C9.861021-2.440847 9.62391-2.440847 9.414695-2.440847H1.199502C1.004234-2.440847 .753176-2.440847 .753176-2.189788C.753176-1.924782 .990286-1.924782 1.199502-1.924782H9.414695Z'/>
 
+<path id='g0-97' d='M4.198257-1.659776C4.128518-1.422665 4.128518-1.39477 3.93325-1.129763C3.626401-.739228 3.012702-.139477 2.357161-.139477C1.785305-.139477 1.464508-.655542 1.464508-1.478456C1.464508-2.245579 1.896887-3.807721 2.161893-4.393524C2.636115-5.369863 3.291656-5.87198 3.835616-5.87198C4.756164-5.87198 4.937484-4.728269 4.937484-4.616687C4.937484-4.60274 4.895641-4.42142 4.881694-4.393524L4.198257-1.659776ZM5.090909-5.230386C4.937484-5.593026 4.560897-6.150934 3.835616-6.150934C2.259527-6.150934 .557908-4.11457 .557908-2.050311C.557908-.669489 1.366874 .139477 2.315318 .139477C3.082441 .139477 3.737983-.460274 4.128518-.920548C4.267995-.097634 4.923537 .139477 5.341968 .139477S6.095143-.111582 6.346202-.613699C6.569365-1.08792 6.764633-1.93873 6.764633-1.994521C6.764633-2.064259 6.708842-2.12005 6.625156-2.12005C6.499626-2.12005 6.485679-2.050311 6.429888-1.841096C6.220672-1.018182 5.955666-.139477 5.383811-.139477C4.979328-.139477 4.951432-.502117 4.951432-.781071C4.951432-1.101868 4.993275-1.255293 5.118804-1.799253C5.216438-2.147945 5.286177-2.454795 5.397758-2.859278C5.913823-4.951432 6.039352-5.453549 6.039352-5.537235C6.039352-5.732503 5.885928-5.885928 5.676712-5.885928C5.230386-5.885928 5.118804-5.397758 5.090909-5.230386Z'/>
 
+<path id='g0-98' d='M3.221918-9.331009C3.235866-9.3868 3.263761-9.470486 3.263761-9.540224C3.263761-9.679701 3.124284-9.679701 3.096389-9.679701C3.082441-9.679701 2.580324-9.637858 2.329265-9.609963C2.092154-9.596015 1.882939-9.56812 1.63188-9.554172C1.297136-9.526276 1.199502-9.512329 1.199502-9.26127C1.199502-9.121793 1.338979-9.121793 1.478456-9.121793C2.189788-9.121793 2.189788-8.996264 2.189788-8.856787C2.189788-8.759153 2.078207-8.35467 2.022416-8.103611L1.687671-6.764633C1.548194-6.206725 .753176-3.040598 .697385-2.789539C.627646-2.440847 .627646-2.203736 .627646-2.022416C.627646-.599751 1.422665 .139477 2.329265 .139477C3.947198 .139477 5.620922-1.93873 5.620922-3.961146C5.620922-5.244334 4.895641-6.150934 3.849564-6.150934C3.124284-6.150934 2.468742-5.551183 2.203736-5.272229L3.221918-9.331009ZM2.343213-.139477C1.896887-.139477 1.408717-.474222 1.408717-1.562142C1.408717-2.022416 1.45056-2.287422 1.701619-3.263761C1.743462-3.445081 1.966625-4.337733 2.022416-4.519054C2.050311-4.630635 2.873225-5.87198 3.821669-5.87198C4.435367-5.87198 4.714321-5.258281 4.714321-4.533001C4.714321-3.863512 4.323786-2.287422 3.975093-1.562142C3.626401-.808966 2.984807-.139477 2.343213-.139477Z'/>
 
+<path id='g0-99' d='M5.453549-5.244334C5.188543-5.244334 5.063014-5.244334 4.867746-5.076961C4.78406-5.007223 4.630635-4.798007 4.630635-4.574844C4.630635-4.29589 4.839851-4.128518 5.104857-4.128518C5.439601-4.128518 5.816189-4.407472 5.816189-4.96538C5.816189-5.634869 5.174595-6.150934 4.212204-6.150934C2.385056-6.150934 .557908-4.156413 .557908-2.175841C.557908-.962391 1.311083 .139477 2.733748 .139477C4.630635 .139477 5.830137-1.338979 5.830137-1.520299C5.830137-1.603985 5.746451-1.673724 5.69066-1.673724C5.648817-1.673724 5.634869-1.659776 5.50934-1.534247C4.616687-.348692 3.291656-.139477 2.761644-.139477C1.799253-.139477 1.492403-.976339 1.492403-1.673724C1.492403-2.161893 1.729514-3.514819 2.231631-4.463263C2.594271-5.118804 3.347447-5.87198 4.226152-5.87198C4.407472-5.87198 5.174595-5.844085 5.453549-5.244334Z'/>
 
+</defs>
 
+<g id='page1'>
 
+<use x='56.413267' y='65.753425' xlink:href='#g0-97'/>
 
+<use x='63.582369' y='60.691915' xlink:href='#g1-50'/>
 
+<use x='72.061649' y='65.753425' xlink:href='#g2-43'/>
 
+<use x='85.783204' y='65.753425' xlink:href='#g0-98'/>
 
+<use x='91.589827' y='60.691915' xlink:href='#g1-50'/>
 
+<use x='100.843973' y='65.753425' xlink:href='#g2-61'/>
 
+<use x='115.340392' y='65.753425' xlink:href='#g0-99'/>
 
+<use x='121.218045' y='60.691915' xlink:href='#g1-50'/>
 
+</g>
 
+</svg>

File diff suppressed because it is too large
+ 9 - 0
_images/math/a6a994cb6e7278ec30eaebe7e636046d3deccb5b.svg


+ 10 - 0
_images/svg_image.svg
View File 

@@ -0,0 +1,10 @@
 
+<?xml version="1.0" encoding="UTF-8"?>
 
+<!-- originate: https://commons.wikimedia.org/wiki/File:Variable_Resistor.svg -->
 
+<svg xmlns="http://www.w3.org/2000/svg"
 
+	version="1.1" baseProfile="full"
 
+	width="70px" height="40px" viewBox="0 0 700 400">
 
+	<line x1="0" y1="200" x2="700" y2="200" stroke="black" stroke-width="20px"/>
 
+	<rect x="100" y="100" width="500" height="200" fill="white" stroke="black" stroke-width="20px"/>
 
+	<line x1="180" y1="370" x2="500" y2="50" stroke="black" stroke-width="15px"/>
 
+	<polygon points="585 0 525 25 585 50" transform="rotate(135 525 25)"/>
 
+</svg>

File diff suppressed because it is too large
+ 0 - 0
_images/translation.svg


+ 183 - 0
_modules/index.html
View File 

@@ -0,0 +1,183 @@
 
+<!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>Overview: module code &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../genindex.html" />
 
+    <link rel="search" title="Search" href="../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>All modules for which code is available</h1>
 
+<ul><li><a href="searx/answerers/_core.html">searx.answerers._core</a></li>
 
+<li><a href="searx/answerers/random.html">searx.answerers.random</a></li>
 
+<li><a href="searx/answerers/statistics.html">searx.answerers.statistics</a></li>
 
+<li><a href="searx/autocomplete.html">searx.autocomplete</a></li>
 
+<li><a href="searx/babel_extract.html">searx.babel_extract</a></li>
 
+<li><a href="searx/botdetection/_helpers.html">searx.botdetection._helpers</a></li>
 
+<li><a href="searx/botdetection/config.html">searx.botdetection.config</a></li>
 
+<li><a href="searx/botdetection/ip_lists.html">searx.botdetection.ip_lists</a></li>
 
+<li><a href="searx/botdetection/link_token.html">searx.botdetection.link_token</a></li>
 
+<li><a href="searx/enginelib.html">searx.enginelib</a></li>
 
+<ul><li><a href="searx/enginelib/traits.html">searx.enginelib.traits</a></li>
 
+</ul><li><a href="searx/engines.html">searx.engines</a></li>
 
+<ul><li><a href="searx/engines/annas_archive.html">searx.engines.annas_archive</a></li>
 
+<li><a href="searx/engines/archlinux.html">searx.engines.archlinux</a></li>
 
+<li><a href="searx/engines/bing.html">searx.engines.bing</a></li>
 
+<li><a href="searx/engines/bing_images.html">searx.engines.bing_images</a></li>
 
+<li><a href="searx/engines/bing_news.html">searx.engines.bing_news</a></li>
 
+<li><a href="searx/engines/bing_videos.html">searx.engines.bing_videos</a></li>
 
+<li><a href="searx/engines/brave.html">searx.engines.brave</a></li>
 
+<li><a href="searx/engines/command.html">searx.engines.command</a></li>
 
+<li><a href="searx/engines/dailymotion.html">searx.engines.dailymotion</a></li>
 
+<li><a href="searx/engines/demo_offline.html">searx.engines.demo_offline</a></li>
 
+<li><a href="searx/engines/demo_online.html">searx.engines.demo_online</a></li>
 
+<li><a href="searx/engines/duckduckgo.html">searx.engines.duckduckgo</a></li>
 
+<li><a href="searx/engines/duckduckgo_definitions.html">searx.engines.duckduckgo_definitions</a></li>
 
+<li><a href="searx/engines/google.html">searx.engines.google</a></li>
 
+<li><a href="searx/engines/google_images.html">searx.engines.google_images</a></li>
 
+<li><a href="searx/engines/google_news.html">searx.engines.google_news</a></li>
 
+<li><a href="searx/engines/google_scholar.html">searx.engines.google_scholar</a></li>
 
+<li><a href="searx/engines/google_videos.html">searx.engines.google_videos</a></li>
 
+<li><a href="searx/engines/json_engine.html">searx.engines.json_engine</a></li>
 
+<li><a href="searx/engines/mrs.html">searx.engines.mrs</a></li>
 
+<li><a href="searx/engines/mullvad_leta.html">searx.engines.mullvad_leta</a></li>
 
+<li><a href="searx/engines/odysee.html">searx.engines.odysee</a></li>
 
+<li><a href="searx/engines/peertube.html">searx.engines.peertube</a></li>
 
+<li><a href="searx/engines/qwant.html">searx.engines.qwant</a></li>
 
+<li><a href="searx/engines/radio_browser.html">searx.engines.radio_browser</a></li>
 
+<li><a href="searx/engines/sepiasearch.html">searx.engines.sepiasearch</a></li>
 
+<li><a href="searx/engines/sqlite.html">searx.engines.sqlite</a></li>
 
+<li><a href="searx/engines/startpage.html">searx.engines.startpage</a></li>
 
+<li><a href="searx/engines/tineye.html">searx.engines.tineye</a></li>
 
+<li><a href="searx/engines/torznab.html">searx.engines.torznab</a></li>
 
+<li><a href="searx/engines/voidlinux.html">searx.engines.voidlinux</a></li>
 
+<li><a href="searx/engines/wikidata.html">searx.engines.wikidata</a></li>
 
+<li><a href="searx/engines/wikipedia.html">searx.engines.wikipedia</a></li>
 
+<li><a href="searx/engines/xpath.html">searx.engines.xpath</a></li>
 
+<li><a href="searx/engines/yahoo.html">searx.engines.yahoo</a></li>
 
+<li><a href="searx/engines/zlibrary.html">searx.engines.zlibrary</a></li>
 
+</ul><li><a href="searx/exceptions.html">searx.exceptions</a></li>
 
+<li><a href="searx/extended_types.html">searx.extended_types</a></li>
 
+<li><a href="searx/favicons/cache.html">searx.favicons.cache</a></li>
 
+<li><a href="searx/favicons/config.html">searx.favicons.config</a></li>
 
+<li><a href="searx/favicons/proxy.html">searx.favicons.proxy</a></li>
 
+<li><a href="searx/favicons/resolvers.html">searx.favicons.resolvers</a></li>
 
+<li><a href="searx/infopage.html">searx.infopage</a></li>
 
+<li><a href="searx/limiter.html">searx.limiter</a></li>
 
+<li><a href="searx/locales.html">searx.locales</a></li>
 
+<li><a href="searx/plugins/_core.html">searx.plugins._core</a></li>
 
+<li><a href="searx/plugins/calculator.html">searx.plugins.calculator</a></li>
 
+<li><a href="searx/plugins/hash_plugin.html">searx.plugins.hash_plugin</a></li>
 
+<li><a href="searx/plugins/hostnames.html">searx.plugins.hostnames</a></li>
 
+<li><a href="searx/plugins/self_info.html">searx.plugins.self_info</a></li>
 
+<li><a href="searx/plugins/tor_check.html">searx.plugins.tor_check</a></li>
 
+<li><a href="searx/plugins/unit_converter.html">searx.plugins.unit_converter</a></li>
 
+<li><a href="searx/redislib.html">searx.redislib</a></li>
 
+<li><a href="searx/result_types.html">searx.result_types</a></li>
 
+<ul><li><a href="searx/result_types/_base.html">searx.result_types._base</a></li>
 
+<li><a href="searx/result_types/answer.html">searx.result_types.answer</a></li>
 
+<li><a href="searx/result_types/keyvalue.html">searx.result_types.keyvalue</a></li>
 
+</ul><li><a href="searx/search.html">searx.search</a></li>
 
+<ul><li><a href="searx/search/models.html">searx.search.models</a></li>
 
+<li><a href="searx/search/processors/abstract.html">searx.search.processors.abstract</a></li>
 
+<li><a href="searx/search/processors/offline.html">searx.search.processors.offline</a></li>
 
+<li><a href="searx/search/processors/online.html">searx.search.processors.online</a></li>
 
+<li><a href="searx/search/processors/online_currency.html">searx.search.processors.online_currency</a></li>
 
+<li><a href="searx/search/processors/online_dictionary.html">searx.search.processors.online_dictionary</a></li>
 
+<li><a href="searx/search/processors/online_url_search.html">searx.search.processors.online_url_search</a></li>
 
+</ul><li><a href="searx/settings_loader.html">searx.settings_loader</a></li>
 
+<li><a href="searx/sqlitedb.html">searx.sqlitedb</a></li>
 
+<li><a href="searx/utils.html">searx.utils</a></li>
 
+<li><a href="searxng_extra/standalone_searx.html">searxng_extra.standalone_searx</a></li>
 
+<li><a href="searxng_extra/update/update_engine_descriptions.html">searxng_extra.update.update_engine_descriptions</a></li>
 
+<li><a href="searxng_extra/update/update_engine_traits.html">searxng_extra.update.update_engine_traits</a></li>
 
+<li><a href="searxng_extra/update/update_external_bangs.html">searxng_extra.update.update_external_bangs</a></li>
 
+<li><a href="searxng_extra/update/update_locales.html">searxng_extra.update.update_locales</a></li>
 
+<li><a href="searxng_extra/update/update_pygments.html">searxng_extra.update.update_pygments</a></li>
 
+</ul>
 
+
 
+            <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>
 
+    
+  </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 309 - 0
_modules/searx/answerers/_core.html
View File 

@@ -0,0 +1,309 @@
 
+<!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.answerers._core &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.answerers._core</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.answerers._core</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="c1"># pylint: disable=too-few-public-methods, missing-module-docstring</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">abc</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">importlib</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">pathlib</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">dataclasses</span><span class="w"> </span><span class="kn">import</span> <span class="n">dataclass</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">load_module</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types.answer</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseAnswer</span>
 
+
 
+
 
+<span class="n">_default</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span><span class="o">.</span><span class="n">parent</span>
 
+<span class="n">log</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">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;searx.answerers&quot;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="AnswererInfo">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.AnswererInfo">[docs]</a>
 
+<span class="nd">@dataclass</span>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">AnswererInfo</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Object that holds informations about an answerer, these infos are shown</span>
 
+<span class="sd">    to the user in the Preferences menu.</span>
 
+
 
+<span class="sd">    To be able to translate the information into other languages, the text must</span>
 
+<span class="sd">    be written in English and translated with :py:obj:`flask_babel.gettext`.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Name of the *answerer*.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">description</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Short description of the *answerer*.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">examples</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;List of short examples of the usage / of query terms.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">keywords</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;See :py:obj:`Answerer.keywords`&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="Answerer">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.Answerer">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">Answerer</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Abstract base class of answerers.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">keywords</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Keywords to which the answerer has *answers*.&quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="Answerer.answer">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.Answerer.answer">[docs]</a>
 
+    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">answer</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="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">BaseAnswer</span><span class="p">]:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Function that returns a list of answers to the question/query.&quot;&quot;&quot;</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="Answerer.info">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.Answerer.info">[docs]</a>
 
+    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AnswererInfo</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Informations about the *answerer*, see :py:obj:`AnswererInfo`.&quot;&quot;&quot;</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="ModuleAnswerer">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.ModuleAnswerer">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">ModuleAnswerer</span><span class="p">(</span><span class="n">Answerer</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A wrapper class for legacy *answerers* where the names (keywords, answer,</span>
 
+<span class="sd">    info) are implemented on the module level (not in a class).</span>
 
+
 
+<span class="sd">    .. note::</span>
 
+
 
+<span class="sd">       For internal use only!</span>
 
+<span class="sd">    &quot;&quot;&quot;</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">mod</span><span class="p">):</span>
 
+
 
+        <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;keywords&quot;</span><span class="p">,</span> <span class="s2">&quot;self_info&quot;</span><span class="p">,</span> <span class="s2">&quot;answer&quot;</span><span class="p">]:</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
 
+                <span class="k">raise</span> <span class="ne">SystemExit</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">mod</span><span class="o">.</span><span class="n">keywords</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span>
 
+            <span class="k">raise</span> <span class="ne">SystemExit</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">mod</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">keywords</span> <span class="o">=</span> <span class="n">mod</span><span class="o">.</span><span class="n">keywords</span>  <span class="c1"># type: ignore</span>
 
+
 
+<div class="viewcode-block" id="ModuleAnswerer.answer">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.ModuleAnswerer.answer">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">answer</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="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">BaseAnswer</span><span class="p">]:</span>
 
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">answer</span><span class="p">(</span><span class="n">query</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="ModuleAnswerer.info">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.ModuleAnswerer.info">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AnswererInfo</span><span class="p">:</span>
 
+        <span class="n">kwargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">self_info</span><span class="p">()</span>
 
+        <span class="n">kwargs</span><span class="p">[</span><span class="s2">&quot;keywords&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">keywords</span>
 
+        <span class="k">return</span> <span class="n">AnswererInfo</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="AnswerStorage">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.AnswerStorage">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">AnswerStorage</span><span class="p">(</span><span class="nb">dict</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A storage for managing the *answerers* of SearXNG.  With the</span>
 
+<span class="sd">    :py:obj:`AnswerStorage.ask`” method, a caller can ask questions to all</span>
 
+<span class="sd">    *answerers* and receives a list of the results.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">answerer_list</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="n">Answerer</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The list of :py:obj:`Answerer` in this storage.&quot;&quot;&quot;</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="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">answerer_list</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+
 
+<div class="viewcode-block" id="AnswerStorage.load_builtins">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.AnswerStorage.load_builtins">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">load_builtins</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Loads ``answerer.py`` modules from the python packages in</span>
 
+<span class="sd">        :origin:`searx/answerers`.  The python modules are wrapped by</span>
 
+<span class="sd">        :py:obj:`ModuleAnswerer`.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">_default</span><span class="o">.</span><span class="n">iterdir</span><span class="p">():</span>
 
+            <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;_&quot;</span><span class="p">):</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">is_file</span><span class="p">()</span> <span class="ow">and</span> <span class="n">f</span><span class="o">.</span><span class="n">suffix</span> <span class="o">==</span> <span class="s2">&quot;.py&quot;</span><span class="p">:</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">register_by_fqn</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;searx.answerers.</span><span class="si">{</span><span class="n">f</span><span class="o">.</span><span class="n">stem</span><span class="si">}</span><span class="s2">.SXNGAnswerer&quot;</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="c1"># for backward compatibility (if a fork has additional answerers)</span>
 
+
 
+            <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">is_dir</span><span class="p">()</span> <span class="ow">and</span> <span class="p">(</span><span class="n">f</span> <span class="o">/</span> <span class="s2">&quot;answerer.py&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
 
+                <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
 
+                    <span class="sa">f</span><span class="s2">&quot;answerer module </span><span class="si">{</span><span class="n">f</span><span class="si">}</span><span class="s2"> is deprecated / migrate to searx.answerers.Answerer&quot;</span><span class="p">,</span> <span class="ne">DeprecationWarning</span>
 
+                <span class="p">)</span>
 
+                <span class="n">mod</span> <span class="o">=</span> <span class="n">load_module</span><span class="p">(</span><span class="s2">&quot;answerer.py&quot;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">ModuleAnswerer</span><span class="p">(</span><span class="n">mod</span><span class="p">))</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="AnswerStorage.register_by_fqn">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.AnswerStorage.register_by_fqn">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">register_by_fqn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fqn</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Register a :py:obj:`Answerer` via its fully qualified class namen(FQN).&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">mod_name</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">obj_name</span> <span class="o">=</span> <span class="n">fqn</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
 
+        <span class="n">mod</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="n">mod_name</span><span class="p">)</span>
 
+        <span class="n">code_obj</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">obj_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="n">code_obj</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;answerer </span><span class="si">{</span><span class="n">fqn</span><span class="si">}</span><span class="s2"> is not implemented&quot;</span>
 
+            <span class="n">log</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">code_obj</span><span class="p">())</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="AnswerStorage.register">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.AnswerStorage.register">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">answerer</span><span class="p">:</span> <span class="n">Answerer</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Register a :py:obj:`Answerer`.&quot;&quot;&quot;</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">answerer_list</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">answerer</span><span class="p">)</span>
 
+        <span class="k">for</span> <span class="n">_kw</span> <span class="ow">in</span> <span class="n">answerer</span><span class="o">.</span><span class="n">keywords</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="p">[</span><span class="n">_kw</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">_kw</span><span class="p">,</span> <span class="p">[])</span>
 
+            <span class="bp">self</span><span class="p">[</span><span class="n">_kw</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">answerer</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="AnswerStorage.ask">
 
+<a class="viewcode-back" href="../../../dev/answerers/development.html#searx.answerers.AnswerStorage.ask">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">ask</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="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">BaseAnswer</span><span class="p">]:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;An answerer is identified via keywords, if there is a keyword at the</span>
 
+<span class="sd">        first position in the ``query`` for which there is one or more</span>
 
+<span class="sd">        answerers, then these are called, whereby the entire ``query`` is passed</span>
 
+<span class="sd">        as argument to the answerer function.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="n">keyword</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">():</span>
 
+            <span class="k">if</span> <span class="n">keyword</span><span class="p">:</span>
 
+                <span class="k">break</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">keyword</span> <span class="ow">or</span> <span class="n">keyword</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="k">for</span> <span class="n">answerer</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">[</span><span class="n">keyword</span><span class="p">]:</span>
 
+            <span class="k">for</span> <span class="n">answer</span> <span class="ow">in</span> <span class="n">answerer</span><span class="o">.</span><span class="n">answer</span><span class="p">(</span><span class="n">query</span><span class="p">):</span>
 
+                <span class="c1"># In case of *answers* prefix ``answerer:`` is set, see searx.result_types.Result</span>
 
+                <span class="n">answer</span><span class="o">.</span><span class="n">engine</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;answerer: </span><span class="si">{</span><span class="n">keyword</span><span class="si">}</span><span class="s2">&quot;</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">answer</span><span class="p">)</span>
 
+
 
+        <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+    <span class="nd">@property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">AnswererInfo</span><span class="p">]:</span>
 
+        <span class="k">return</span> <span class="p">[</span><span class="n">a</span><span class="o">.</span><span class="n">info</span><span class="p">()</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">answerer_list</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 193 - 0
_modules/searx/answerers/random.html
View File 

@@ -0,0 +1,193 @@
 
+<!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.answerers.random &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.answerers.random</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.answerers.random</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">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">hashlib</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">random</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">string</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">uuid</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</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">Answer</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types.answer</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseAnswer</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">Answerer</span><span class="p">,</span> <span class="n">AnswererInfo</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">random_characters</span><span class="p">():</span>
 
+    <span class="n">random_string_letters</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_lowercase</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_uppercase</span>
 
+    <span class="k">return</span> <span class="p">[</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">random_string_letters</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">32</span><span class="p">))]</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">random_string</span><span class="p">():</span>
 
+    <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">random_characters</span><span class="p">())</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">random_float</span><span class="p">():</span>
 
+    <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">random</span><span class="p">())</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">random_int</span><span class="p">():</span>
 
+    <span class="n">random_int_max</span> <span class="o">=</span> <span class="mi">2</span><span class="o">**</span><span class="mi">31</span>
 
+    <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="o">-</span><span class="n">random_int_max</span><span class="p">,</span> <span class="n">random_int_max</span><span class="p">))</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">random_sha256</span><span class="p">():</span>
 
+    <span class="n">m</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">()</span>
 
+    <span class="n">m</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">random_characters</span><span class="p">())</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
 
+    <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">())</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">random_uuid</span><span class="p">():</span>
 
+    <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">random_color</span><span class="p">():</span>
 
+    <span class="n">color</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">%06x</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mh">0xFFFFFF</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;#</span><span class="si">{</span><span class="n">color</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGAnswerer">
 
+<a class="viewcode-back" href="../../../dev/answerers/random.html#searx.answerers.random.SXNGAnswerer">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNGAnswerer</span><span class="p">(</span><span class="n">Answerer</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Random value generator&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">keywords</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;random&quot;</span><span class="p">]</span>
 
+
 
+    <span class="n">random_types</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;string&quot;</span><span class="p">:</span> <span class="n">random_string</span><span class="p">,</span>
 
+        <span class="s2">&quot;int&quot;</span><span class="p">:</span> <span class="n">random_int</span><span class="p">,</span>
 
+        <span class="s2">&quot;float&quot;</span><span class="p">:</span> <span class="n">random_float</span><span class="p">,</span>
 
+        <span class="s2">&quot;sha256&quot;</span><span class="p">:</span> <span class="n">random_sha256</span><span class="p">,</span>
 
+        <span class="s2">&quot;uuid&quot;</span><span class="p">:</span> <span class="n">random_uuid</span><span class="p">,</span>
 
+        <span class="s2">&quot;color&quot;</span><span class="p">:</span> <span class="n">random_color</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+<div class="viewcode-block" id="SXNGAnswerer.info">
 
+<a class="viewcode-back" href="../../../dev/answerers/random.html#searx.answerers.random.SXNGAnswerer.info">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+
 
+        <span class="k">return</span> <span class="n">AnswererInfo</span><span class="p">(</span>
 
+            <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span><span class="p">),</span>
 
+            <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Generate different random values&quot;</span><span class="p">),</span>
 
+            <span class="n">keywords</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">keywords</span><span class="p">,</span>
 
+            <span class="n">examples</span><span class="o">=</span><span class="p">[</span><span class="sa">f</span><span class="s2">&quot;random </span><span class="si">{</span><span class="n">x</span><span class="si">}</span><span class="s2">&quot;</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">random_types</span><span class="p">],</span>
 
+        <span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGAnswerer.answer">
 
+<a class="viewcode-back" href="../../../dev/answerers/random.html#searx.answerers.random.SXNGAnswerer.answer">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">answer</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="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">BaseAnswer</span><span class="p">]:</span>
 
+
 
+        <span class="n">parts</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">parts</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span> <span class="ow">or</span> <span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">random_types</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="p">[]</span>
 
+
 
+        <span class="k">return</span> <span class="p">[</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">random_types</span><span class="p">[</span><span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">]]())]</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 177 - 0
_modules/searx/answerers/statistics.html
View File 

@@ -0,0 +1,177 @@
 
+<!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.answerers.statistics &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.answerers.statistics</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.answerers.statistics</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">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">reduce</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">operator</span><span class="w"> </span><span class="kn">import</span> <span class="n">mul</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.numbers</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">sxng_request</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">Answer</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types.answer</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseAnswer</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">Answerer</span><span class="p">,</span> <span class="n">AnswererInfo</span>
 
+
 
+<span class="n">kw2func</span> <span class="o">=</span> <span class="p">[</span>
 
+    <span class="p">(</span><span class="s2">&quot;min&quot;</span><span class="p">,</span> <span class="nb">min</span><span class="p">),</span>
 
+    <span class="p">(</span><span class="s2">&quot;max&quot;</span><span class="p">,</span> <span class="nb">max</span><span class="p">),</span>
 
+    <span class="p">(</span><span class="s2">&quot;avg&quot;</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">args</span><span class="p">:</span> <span class="nb">sum</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">/</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)),</span>
 
+    <span class="p">(</span><span class="s2">&quot;sum&quot;</span><span class="p">,</span> <span class="nb">sum</span><span class="p">),</span>
 
+    <span class="p">(</span><span class="s2">&quot;prod&quot;</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">args</span><span class="p">:</span> <span class="n">reduce</span><span class="p">(</span><span class="n">mul</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="mi">1</span><span class="p">)),</span>
 
+<span class="p">]</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGAnswerer">
 
+<a class="viewcode-back" href="../../../dev/answerers/statistics.html#searx.answerers.statistics.SXNGAnswerer">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNGAnswerer</span><span class="p">(</span><span class="n">Answerer</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Statistics functions&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">keywords</span> <span class="o">=</span> <span class="p">[</span><span class="n">kw</span> <span class="k">for</span> <span class="n">kw</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">kw2func</span><span class="p">]</span>
 
+
 
+<div class="viewcode-block" id="SXNGAnswerer.info">
 
+<a class="viewcode-back" href="../../../dev/answerers/statistics.html#searx.answerers.statistics.SXNGAnswerer.info">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+
 
+        <span class="k">return</span> <span class="n">AnswererInfo</span><span class="p">(</span>
 
+            <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span><span class="p">),</span>
 
+            <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Compute </span><span class="si">{func}</span><span class="s2"> of the arguments&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">func</span><span class="o">=</span><span class="s1">&#39;/&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">keywords</span><span class="p">))),</span>
 
+            <span class="n">keywords</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">keywords</span><span class="p">,</span>
 
+            <span class="n">examples</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;avg 123 548 2.04 24.2&quot;</span><span class="p">],</span>
 
+        <span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGAnswerer.answer">
 
+<a class="viewcode-back" href="../../../dev/answerers/statistics.html#searx.answerers.statistics.SXNGAnswerer.answer">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">answer</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="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">BaseAnswer</span><span class="p">]:</span>
 
+
 
+        <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="n">parts</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">parts</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">2</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="n">ui_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="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s1">&#39;locale&#39;</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">parse_decimal</span><span class="p">(</span><span class="n">num</span><span class="p">,</span> <span class="n">ui_locale</span><span class="p">,</span> <span class="n">numbering_system</span><span class="o">=</span><span class="s2">&quot;latn&quot;</span><span class="p">)</span> <span class="k">for</span> <span class="n">num</span> <span class="ow">in</span> <span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">:]]</span>
 
+        <span class="k">except</span><span class="p">:</span>  <span class="c1"># pylint: disable=bare-except</span>
 
+            <span class="c1"># seems one of the args is not a float type, can&#39;t be converted to float</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">func</span> <span class="ow">in</span> <span class="n">kw2func</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
 
+                <span class="n">res</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
 
+                <span class="n">res</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">format_decimal</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">ui_locale</span><span class="p">)</span>
 
+                <span class="n">f_str</span> <span class="o">=</span> <span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">format_decimal</span><span class="p">(</span><span class="n">arg</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">ui_locale</span><span class="p">)</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">)</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;[</span><span class="si">{</span><span class="n">ui_locale</span><span class="si">}</span><span class="s2">] </span><span class="si">{</span><span class="n">k</span><span class="si">}</span><span class="s2">(</span><span class="si">{</span><span class="n">f_str</span><span class="si">}</span><span class="s2">) = </span><span class="si">{</span><span class="n">res</span><span class="si">}</span><span class="s2"> &quot;</span><span class="p">))</span>
 
+                <span class="k">break</span>
 
+
 
+        <span class="k">return</span> <span class="n">results</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 431 - 0
_modules/searx/autocomplete.html
View File 

@@ -0,0 +1,431 @@
 
+<!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.autocomplete &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.autocomplete</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.autocomplete</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This module implements functions needed for the autocompleter.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=use-dict-literal</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">html</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span><span class="p">,</span> <span class="n">quote_plus</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">lxml.etree</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">lxml.html</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">httpx</span><span class="w"> </span><span class="kn">import</span> <span class="n">HTTPError</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Response</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">settings</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="p">(</span>
 
+    <span class="n">engines</span><span class="p">,</span>
 
+    <span class="n">google</span><span class="p">,</span>
 
+<span class="p">)</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</span> <span class="k">as</span> <span class="n">http_get</span><span class="p">,</span> <span class="n">post</span> <span class="k">as</span> <span class="n">http_post</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">SearxEngineResponseException</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">extr</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">update_kwargs</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="s1">&#39;timeout&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
 
+        <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;timeout&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;outgoing&#39;</span><span class="p">][</span><span class="s1">&#39;request_timeout&#39;</span><span class="p">]</span>
 
+    <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;raise_for_httperror&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SXNG_Response</span><span class="p">:</span>
 
+    <span class="n">update_kwargs</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">http_get</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">post</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SXNG_Response</span><span class="p">:</span>
 
+    <span class="n">update_kwargs</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">http_post</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">baidu</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># baidu search autocompleter</span>
 
+    <span class="n">base_url</span> <span class="o">=</span> <span class="s2">&quot;https://www.baidu.com/sugrec?&quot;</span>
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">base_url</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;ie&#39;</span><span class="p">:</span> <span class="s1">&#39;utf-8&#39;</span><span class="p">,</span> <span class="s1">&#39;json&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;prod&#39;</span><span class="p">:</span> <span class="s1">&#39;pc&#39;</span><span class="p">,</span> <span class="s1">&#39;wd&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}))</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="s1">&#39;g&#39;</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
 
+            <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;g&#39;</span><span class="p">]:</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;q&#39;</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">brave</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># brave search autocompleter</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://search.brave.com/api/suggest?&#39;</span>
 
+    <span class="n">url</span> <span class="o">+=</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">})</span>
 
+    <span class="n">country</span> <span class="o">=</span> <span class="s1">&#39;all&#39;</span>
 
+    <span class="c1"># if lang in _brave:</span>
 
+    <span class="c1">#    country = lang</span>
 
+    <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;cookies&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;country&#39;</span><span class="p">:</span> <span class="n">country</span><span class="p">}}</span>
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">dbpedia</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># dbpedia autocompleter, no HTTPS</span>
 
+    <span class="n">autocomplete_url</span> <span class="o">=</span> <span class="s1">&#39;https://lookup.dbpedia.org/api/search.asmx/KeywordSearch?&#39;</span>
 
+
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">autocomplete_url</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">QueryString</span><span class="o">=</span><span class="n">query</span><span class="p">)))</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">dom</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">etree</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">)</span>
 
+        <span class="n">results</span> <span class="o">=</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//Result/Label//text()&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">duckduckgo</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">sxng_locale</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Autocomplete from DuckDuckGo. Supports DuckDuckGo&#39;s languages&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">traits</span> <span class="o">=</span> <span class="n">engines</span><span class="p">[</span><span class="s1">&#39;duckduckgo&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">traits</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;kl&#39;</span><span class="p">:</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">),</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://duckduckgo.com/ac/?type=list&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="n">ret_val</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">j</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">j</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="n">ret_val</span> <span class="o">=</span> <span class="n">j</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+    <span class="k">return</span> <span class="n">ret_val</span>
 
+
 
+
 
+<div class="viewcode-block" id="google_complete">
 
+<a class="viewcode-back" href="../../dev/engines/online/google.html#searx.autocomplete.google_complete">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">google_complete</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">sxng_locale</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Autocomplete from Google.  Supports Google&#39;s languages and subdomains</span>
 
+<span class="sd">    (:py:obj:`searx.engines.google.get_google_info`) by using the async REST</span>
 
+<span class="sd">    API::</span>
 
+
 
+<span class="sd">        https://{subdomain}/complete/search?{args}</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">google_info</span> <span class="o">=</span> <span class="n">google</span><span class="o">.</span><span class="n">get_google_info</span><span class="p">({</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">:</span> <span class="n">sxng_locale</span><span class="p">},</span> <span class="n">engines</span><span class="p">[</span><span class="s1">&#39;google&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">traits</span><span class="p">)</span>
 
+
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://</span><span class="si">{subdomain}</span><span class="s1">/complete/search?</span><span class="si">{args}</span><span class="s1">&#39;</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">(</span>
 
+        <span class="p">{</span>
 
+            <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+            <span class="s1">&#39;client&#39;</span><span class="p">:</span> <span class="s1">&#39;gws-wiz&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;hl&#39;</span><span class="p">:</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;hl&#39;</span><span class="p">],</span>
 
+        <span class="p">}</span>
 
+    <span class="p">)</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">subdomain</span><span class="o">=</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">],</span> <span class="n">args</span><span class="o">=</span><span class="n">args</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">resp</span> <span class="ow">and</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">json_txt</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">[</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;[&#39;</span><span class="p">)</span> <span class="p">:</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;]&#39;</span><span class="p">,</span> <span class="o">-</span><span class="mi">3</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">json_txt</span><span class="p">)</span>
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">lxml</span><span class="o">.</span><span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span><span class="o">.</span><span class="n">text_content</span><span class="p">())</span>
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="mwmbl">
 
+<a class="viewcode-back" href="../../dev/engines/online/mwmbl.html#searx.autocomplete.mwmbl">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">mwmbl</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Autocomplete from Mwmbl_.&quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># mwmbl autocompleter</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://api.mwmbl.org/search/complete?</span><span class="si">{query}</span><span class="s1">&#39;</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">})))</span><span class="o">.</span><span class="n">json</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
 
+
 
+    <span class="c1"># results starting with `go:` are direct urls and not useful for auto completion</span>
 
+    <span class="k">return</span> <span class="p">[</span><span class="n">result</span> <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">result</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;go: &quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">result</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;search: &quot;</span><span class="p">)]</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">qihu360search</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># 360Search search autocompleter</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://sug.so.360.cn/suggest?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;format&#39;</span><span class="p">:</span><span class="w"> </span><span class="s1">&#39;json&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;word&#39;</span><span class="p">:</span><span class="w"> </span><span class="n">query</span><span class="p">})</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="s1">&#39;result&#39;</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
 
+            <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;result&#39;</span><span class="p">]:</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;word&#39;</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">quark</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># Quark search autocompleter</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://sugs.m.sm.cn/web?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span><span class="w"> </span><span class="n">query</span><span class="p">})</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="p">[]):</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;w&#39;</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">seznam</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># seznam search autocompleter</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://suggest.seznam.cz/fulltext/cs?</span><span class="si">{query}</span><span class="s1">&#39;</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span>
 
+        <span class="n">url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
 
+            <span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">(</span>
 
+                <span class="p">{</span><span class="s1">&#39;phrase&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span> <span class="s1">&#39;cursorPosition&#39;</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">query</span><span class="p">),</span> <span class="s1">&#39;format&#39;</span><span class="p">:</span> <span class="s1">&#39;json-2&#39;</span><span class="p">,</span> <span class="s1">&#39;highlight&#39;</span><span class="p">:</span> <span class="s1">&#39;1&#39;</span><span class="p">,</span> <span class="s1">&#39;count&#39;</span><span class="p">:</span> <span class="s1">&#39;6&#39;</span><span class="p">}</span>
 
+            <span class="p">)</span>
 
+        <span class="p">)</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="p">[]</span>
 
+
 
+    <span class="n">data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+    <span class="k">return</span> <span class="p">[</span>
 
+        <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">part</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;text&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;text&#39;</span><span class="p">,</span> <span class="p">[])])</span>
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;result&#39;</span><span class="p">,</span> <span class="p">[])</span>
 
+        <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;itemType&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="o">==</span> <span class="s1">&#39;ItemType.TEXT&#39;</span>
 
+    <span class="p">]</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">sogou</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># Sogou search autocompleter</span>
 
+    <span class="n">base_url</span> <span class="o">=</span> <span class="s2">&quot;https://sor.html5.qq.com/api/getsug?&quot;</span>
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">base_url</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;m&#39;</span><span class="p">:</span> <span class="s1">&#39;searxng&#39;</span><span class="p">,</span> <span class="s1">&#39;key&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}))</span>
 
+
 
+    <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">raw_json</span> <span class="o">=</span> <span class="n">extr</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="s2">&quot;[&quot;</span><span class="p">,</span> <span class="s2">&quot;]&quot;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">data</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;[</span><span class="si">{</span><span class="n">raw_json</span><span class="si">}</span><span class="s2">]]&quot;</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+        <span class="k">except</span> <span class="n">json</span><span class="o">.</span><span class="n">JSONDecodeError</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="p">[]</span>
 
+
 
+    <span class="k">return</span> <span class="p">[]</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">stract</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># stract autocompleter (beta)</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://stract.com/beta/api/autosuggest?q=</span><span class="si">{</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">post</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="p">[]</span>
 
+
 
+    <span class="k">return</span> <span class="p">[</span><span class="n">html</span><span class="o">.</span><span class="n">unescape</span><span class="p">(</span><span class="n">suggestion</span><span class="p">[</span><span class="s1">&#39;raw&#39;</span><span class="p">])</span> <span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()]</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">swisscows</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># swisscows autocompleter</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://swisscows.ch/api/suggest?</span><span class="si">{query}</span><span class="s1">&amp;itemsCount=5&#39;</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">})))</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">resp</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">qwant</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">sxng_locale</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Autocomplete from Qwant. Supports Qwant&#39;s regions.&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="n">locale</span> <span class="o">=</span> <span class="n">engines</span><span class="p">[</span><span class="s1">&#39;qwant&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="s1">&#39;en_US&#39;</span><span class="p">)</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://api.qwant.com/v3/suggest?</span><span class="si">{query}</span><span class="s1">&#39;</span>
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span> <span class="s1">&#39;locale&#39;</span><span class="p">:</span> <span class="n">locale</span><span class="p">,</span> <span class="s1">&#39;version&#39;</span><span class="p">:</span> <span class="s1">&#39;2&#39;</span><span class="p">})))</span>
 
+
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;success&#39;</span><span class="p">:</span>
 
+            <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;items&#39;</span><span class="p">]:</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;value&#39;</span><span class="p">])</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">wikipedia</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">sxng_locale</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Autocomplete from Wikipedia. Supports Wikipedia&#39;s languages (aka netloc).&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">eng_traits</span> <span class="o">=</span> <span class="n">engines</span><span class="p">[</span><span class="s1">&#39;wikipedia&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">traits</span>
 
+    <span class="n">wiki_lang</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>
 
+    <span class="n">wiki_netloc</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">wiki_lang</span><span class="p">,</span> <span class="s1">&#39;en.wikipedia.org&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://</span><span class="si">{wiki_netloc}</span><span class="s1">/w/api.php?</span><span class="si">{args}</span><span class="s1">&#39;</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">(</span>
 
+        <span class="p">{</span>
 
+            <span class="s1">&#39;action&#39;</span><span class="p">:</span> <span class="s1">&#39;opensearch&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;format&#39;</span><span class="p">:</span> <span class="s1">&#39;json&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;formatversion&#39;</span><span class="p">:</span> <span class="s1">&#39;2&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;search&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+            <span class="s1">&#39;namespace&#39;</span><span class="p">:</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="s1">&#39;10&#39;</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+    <span class="p">)</span>
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span> <span class="n">wiki_netloc</span><span class="o">=</span><span class="n">wiki_netloc</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="n">results</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">yandex</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">_lang</span><span class="p">):</span>
 
+    <span class="c1"># yandex autocompleter</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://suggest.yandex.com/suggest-ff.cgi?</span><span class="si">{0}</span><span class="s2">&quot;</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">urlencode</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">part</span><span class="o">=</span><span class="n">query</span><span class="p">))))</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">resp</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+    <span class="k">return</span> <span class="p">[]</span>
 
+
 
+
 
+<span class="n">backends</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;360search&#39;</span><span class="p">:</span> <span class="n">qihu360search</span><span class="p">,</span>
 
+    <span class="s1">&#39;baidu&#39;</span><span class="p">:</span> <span class="n">baidu</span><span class="p">,</span>
 
+    <span class="s1">&#39;brave&#39;</span><span class="p">:</span> <span class="n">brave</span><span class="p">,</span>
 
+    <span class="s1">&#39;dbpedia&#39;</span><span class="p">:</span> <span class="n">dbpedia</span><span class="p">,</span>
 
+    <span class="s1">&#39;duckduckgo&#39;</span><span class="p">:</span> <span class="n">duckduckgo</span><span class="p">,</span>
 
+    <span class="s1">&#39;google&#39;</span><span class="p">:</span> <span class="n">google_complete</span><span class="p">,</span>
 
+    <span class="s1">&#39;mwmbl&#39;</span><span class="p">:</span> <span class="n">mwmbl</span><span class="p">,</span>
 
+    <span class="s1">&#39;quark&#39;</span><span class="p">:</span> <span class="n">quark</span><span class="p">,</span>
 
+    <span class="s1">&#39;qwant&#39;</span><span class="p">:</span> <span class="n">qwant</span><span class="p">,</span>
 
+    <span class="s1">&#39;seznam&#39;</span><span class="p">:</span> <span class="n">seznam</span><span class="p">,</span>
 
+    <span class="s1">&#39;sogou&#39;</span><span class="p">:</span> <span class="n">sogou</span><span class="p">,</span>
 
+    <span class="s1">&#39;stract&#39;</span><span class="p">:</span> <span class="n">stract</span><span class="p">,</span>
 
+    <span class="s1">&#39;swisscows&#39;</span><span class="p">:</span> <span class="n">swisscows</span><span class="p">,</span>
 
+    <span class="s1">&#39;wikipedia&#39;</span><span class="p">:</span> <span class="n">wikipedia</span><span class="p">,</span>
 
+    <span class="s1">&#39;yandex&#39;</span><span class="p">:</span> <span class="n">yandex</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">search_autocomplete</span><span class="p">(</span><span class="n">backend_name</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">sxng_locale</span><span class="p">):</span>
 
+    <span class="n">backend</span> <span class="o">=</span> <span class="n">backends</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">backend_name</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">backend</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="p">[]</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">backend</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">sxng_locale</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="p">(</span><span class="n">HTTPError</span><span class="p">,</span> <span class="n">SearxEngineResponseException</span><span class="p">):</span>
 
+        <span class="k">return</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 157 - 0
_modules/searx/babel_extract.html
View File 

@@ -0,0 +1,157 @@
 
+<!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.babel_extract &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.babel_extract</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.babel_extract</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This module implements the :origin:`searxng_msg &lt;babel.cfg&gt;` extractor to</span>
 
+<span class="sd">extract messages from:</span>
 
+
 
+<span class="sd">- :origin:`searx/searxng.msg`</span>
 
+
 
+<span class="sd">The ``searxng.msg`` files are selected by Babel_, see Babel&#39;s configuration in</span>
 
+<span class="sd">:origin:`babel.cfg`::</span>
 
+
 
+<span class="sd">    searxng_msg = searx.babel_extract.extract</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">    [searxng_msg: **/searxng.msg]</span>
 
+
 
+<span class="sd">A ``searxng.msg`` file is a python file that is *executed* by the</span>
 
+<span class="sd">:py:obj:`extract` function.  Additional ``searxng.msg`` files can be added by:</span>
 
+
 
+<span class="sd">1. Adding a ``searxng.msg`` file in one of the SearXNG python packages and</span>
 
+<span class="sd">2. implement a method in :py:obj:`extract` that yields messages from this file.</span>
 
+
 
+<span class="sd">.. _Babel: https://babel.pocoo.org/en/latest/index.html</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">os</span><span class="w"> </span><span class="kn">import</span> <span class="n">path</span>
 
+
 
+<span class="n">SEARXNG_MSG_FILE</span> <span class="o">=</span> <span class="s2">&quot;searxng.msg&quot;</span>
 
+<span class="n">_MSG_FILES</span> <span class="o">=</span> <span class="p">[</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">),</span> <span class="n">SEARXNG_MSG_FILE</span><span class="p">)]</span>
 
+
 
+
 
+<div class="viewcode-block" id="extract">
 
+<a class="viewcode-back" href="../../src/searx.babel_extract.html#searx.babel_extract.extract">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">extract</span><span class="p">(</span>
 
+    <span class="c1"># pylint: disable=unused-argument</span>
 
+    <span class="n">fileobj</span><span class="p">,</span>
 
+    <span class="n">keywords</span><span class="p">,</span>
 
+    <span class="n">comment_tags</span><span class="p">,</span>
 
+    <span class="n">options</span><span class="p">,</span>
 
+<span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extract messages from ``searxng.msg`` files by a custom extractor_.</span>
 
+
 
+<span class="sd">    .. _extractor:</span>
 
+<span class="sd">       https://babel.pocoo.org/en/latest/messages.html#writing-extraction-methods</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="n">fileobj</span><span class="o">.</span><span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_MSG_FILES</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;don&#39;t know how to extract messages from </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">fileobj</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
 
+
 
+    <span class="n">namespace</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="n">exec</span><span class="p">(</span><span class="n">fileobj</span><span class="o">.</span><span class="n">read</span><span class="p">(),</span> <span class="p">{},</span> <span class="n">namespace</span><span class="p">)</span>  <span class="c1"># pylint: disable=exec-used</span>
 
+
 
+    <span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">namespace</span><span class="p">[</span><span class="s1">&#39;__all__&#39;</span><span class="p">]:</span>
 
+        <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">namespace</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="k">yield</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">&#39;_&#39;</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">[&#39;</span><span class="si">%s</span><span class="s2">&#39;]&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">k</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 247 - 0
_modules/searx/botdetection/_helpers.html
View File 

@@ -0,0 +1,247 @@
 
+<!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.botdetection._helpers &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.botdetection._helpers</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.botdetection._helpers</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, invalid-name</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">IPv4Network</span><span class="p">,</span>
 
+    <span class="n">IPv6Network</span><span class="p">,</span>
 
+    <span class="n">IPv4Address</span><span class="p">,</span>
 
+    <span class="n">IPv6Address</span><span class="p">,</span>
 
+    <span class="n">ip_network</span><span class="p">,</span>
 
+    <span class="n">ip_address</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">werkzeug</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.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</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="s1">&#39;botdetection&#39;</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">dump_request</span><span class="p">(</span><span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">):</span>
 
+    <span class="k">return</span> <span class="p">(</span>
 
+        <span class="n">request</span><span class="o">.</span><span class="n">path</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || X-Forwarded-For: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;X-Forwarded-For&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || X-Real-IP: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;X-Real-IP&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || form: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">form</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || Accept: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Accept&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || Accept-Language: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Accept-Language&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || Accept-Encoding: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Accept-Encoding&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || Content-Type: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Content-Type&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || Content-Length: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Content-Length&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || Connection: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Connection&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot; || User-Agent: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;User-Agent&#39;</span><span class="p">)</span>
 
+    <span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="too_many_requests">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.too_many_requests">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">too_many_requests</span><span class="p">(</span><span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span> <span class="n">log_msg</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">werkzeug</span><span class="o">.</span><span class="n">Response</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a HTTP 429 response object and writes a ERROR message to the</span>
 
+<span class="sd">    &#39;botdetection&#39; logger.  This function is used in part by the filter methods</span>
 
+<span class="sd">    to return the default ``Too Many Requests`` response.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;BLOCK </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">log_msg</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">flask</span><span class="o">.</span><span class="n">make_response</span><span class="p">((</span><span class="s1">&#39;Too Many Requests&#39;</span><span class="p">,</span> <span class="mi">429</span><span class="p">))</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_network">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.get_network">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_network</span><span class="p">(</span><span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns the (client) network of whether the real_ip is part of.&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">if</span> <span class="n">real_ip</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="mi">6</span><span class="p">:</span>
 
+        <span class="n">prefix</span> <span class="o">=</span> <span class="n">cfg</span><span class="p">[</span><span class="s1">&#39;real_ip.ipv6_prefix&#39;</span><span class="p">]</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">prefix</span> <span class="o">=</span> <span class="n">cfg</span><span class="p">[</span><span class="s1">&#39;real_ip.ipv4_prefix&#39;</span><span class="p">]</span>
 
+    <span class="n">network</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">real_ip</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">prefix</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 
+    <span class="c1"># logger.debug(&quot;get_network(): %s&quot;, network.compressed)</span>
 
+    <span class="k">return</span> <span class="n">network</span></div>
 
+
 
+
 
+
 
+<span class="n">_logged_errors</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_log_error_only_once</span><span class="p">(</span><span class="n">err_msg</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="n">err_msg</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_logged_errors</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="n">err_msg</span><span class="p">)</span>
 
+        <span class="n">_logged_errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">err_msg</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_real_ip">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.get_real_ip">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_real_ip</span><span class="p">(</span><span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns real IP of the request.  Since not all proxies set all the HTTP</span>
 
+<span class="sd">    headers and incoming headers can be faked it may happen that the IP cannot</span>
 
+<span class="sd">    be determined correctly.</span>
 
+
 
+<span class="sd">    .. sidebar:: :py:obj:`flask.Request.remote_addr`</span>
 
+
 
+<span class="sd">       SearXNG uses Werkzeug&#39;s ProxyFix_ (with it default ``x_for=1``).</span>
 
+
 
+<span class="sd">    This function tries to get the remote IP in the order listed below,</span>
 
+<span class="sd">    additional some tests are done and if inconsistencies or errors are</span>
 
+<span class="sd">    detected, they are logged.</span>
 
+
 
+<span class="sd">    The remote IP of the request is taken from (first match):</span>
 
+
 
+<span class="sd">    - X-Forwarded-For_ header</span>
 
+<span class="sd">    - `X-real-IP header &lt;https://github.com/searxng/searxng/issues/1237#issuecomment-1147564516&gt;`__</span>
 
+<span class="sd">    - :py:obj:`flask.Request.remote_addr`</span>
 
+
 
+<span class="sd">    .. _ProxyFix:</span>
 
+<span class="sd">       https://werkzeug.palletsprojects.com/middleware/proxy_fix/</span>
 
+
 
+<span class="sd">    .. _X-Forwarded-For:</span>
 
+<span class="sd">      https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">forwarded_for</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;X-Forwarded-For&quot;</span><span class="p">)</span>
 
+    <span class="n">real_ip</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;X-Real-IP&#39;</span><span class="p">)</span>
 
+    <span class="n">remote_addr</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">remote_addr</span>
 
+    <span class="c1"># logger.debug(</span>
 
+    <span class="c1">#     &quot;X-Forwarded-For: %s || X-Real-IP: %s || request.remote_addr: %s&quot;, forwarded_for, real_ip, remote_addr</span>
 
+    <span class="c1"># )</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">forwarded_for</span><span class="p">:</span>
 
+        <span class="n">_log_error_only_once</span><span class="p">(</span><span class="s2">&quot;X-Forwarded-For header is not set!&quot;</span><span class="p">)</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">cfg</span>  <span class="c1"># pylint: disable=import-outside-toplevel, cyclic-import</span>
 
+
 
+        <span class="n">forwarded_for</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">forwarded_for</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">)]</span>
 
+        <span class="n">x_for</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">cfg</span><span class="p">[</span><span class="s1">&#39;real_ip.x_for&#39;</span><span class="p">]</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">forwarded_for</span> <span class="o">=</span> <span class="n">forwarded_for</span><span class="p">[</span><span class="o">-</span><span class="nb">min</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">forwarded_for</span><span class="p">),</span> <span class="n">x_for</span><span class="p">)]</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">real_ip</span><span class="p">:</span>
 
+        <span class="n">_log_error_only_once</span><span class="p">(</span><span class="s2">&quot;X-Real-IP header is not set!&quot;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">forwarded_for</span> <span class="ow">and</span> <span class="n">real_ip</span> <span class="ow">and</span> <span class="n">forwarded_for</span> <span class="o">!=</span> <span class="n">real_ip</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;IP from X-Real-IP (</span><span class="si">%s</span><span class="s2">) is not equal to IP from X-Forwarded-For (</span><span class="si">%s</span><span class="s2">)&quot;</span><span class="p">,</span> <span class="n">real_ip</span><span class="p">,</span> <span class="n">forwarded_for</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">forwarded_for</span> <span class="ow">and</span> <span class="n">remote_addr</span> <span class="ow">and</span> <span class="n">forwarded_for</span> <span class="o">!=</span> <span class="n">remote_addr</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
 
+            <span class="s2">&quot;IP from WSGI environment (</span><span class="si">%s</span><span class="s2">) is not equal to IP from X-Forwarded-For (</span><span class="si">%s</span><span class="s2">)&quot;</span><span class="p">,</span> <span class="n">remote_addr</span><span class="p">,</span> <span class="n">forwarded_for</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">real_ip</span> <span class="ow">and</span> <span class="n">remote_addr</span> <span class="ow">and</span> <span class="n">real_ip</span> <span class="o">!=</span> <span class="n">remote_addr</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;IP from WSGI environment (</span><span class="si">%s</span><span class="s2">) is not equal to IP from X-Real-IP (</span><span class="si">%s</span><span class="s2">)&quot;</span><span class="p">,</span> <span class="n">remote_addr</span><span class="p">,</span> <span class="n">real_ip</span><span class="p">)</span>
 
+
 
+    <span class="n">request_ip</span> <span class="o">=</span> <span class="n">ip_address</span><span class="p">(</span><span class="n">forwarded_for</span> <span class="ow">or</span> <span class="n">real_ip</span> <span class="ow">or</span> <span class="n">remote_addr</span> <span class="ow">or</span> <span class="s1">&#39;0.0.0.0&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">request_ip</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="mi">6</span> <span class="ow">and</span> <span class="n">request_ip</span><span class="o">.</span><span class="n">ipv4_mapped</span><span class="p">:</span>
 
+        <span class="n">request_ip</span> <span class="o">=</span> <span class="n">request_ip</span><span class="o">.</span><span class="n">ipv4_mapped</span>
 
+
 
+    <span class="c1"># logger.debug(&quot;get_real_ip() -&gt; %s&quot;, request_ip)</span>
 
+    <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">request_ip</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 512 - 0
_modules/searx/botdetection/config.html
View File 

@@ -0,0 +1,512 @@
 
+<!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.botdetection.config &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.botdetection.config</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.botdetection.config</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Configuration class :py:class:`Config` with deep-update, schema validation</span>
 
+<span class="sd">and deprecated names.</span>
 
+
 
+<span class="sd">The :py:class:`Config` class implements a configuration that is based on</span>
 
+<span class="sd">structured dictionaries.  The configuration schema is defined in a dictionary</span>
 
+<span class="sd">structure and the configuration data is given in a dictionary structure.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Any</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">copy</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">logging</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">pathlib</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">..compat</span><span class="w"> </span><span class="kn">import</span> <span class="n">tomllib</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Config&#39;</span><span class="p">,</span> <span class="s1">&#39;UNSET&#39;</span><span class="p">,</span> <span class="s1">&#39;SchemaIssue&#39;</span><span class="p">]</span>
 
+
 
+<span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FALSE</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Class of ``False`` singleton&quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># pylint: disable=multiple-statements</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">msg</span><span class="p">):</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="n">msg</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__bool__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">False</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__str__</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">msg</span>
 
+
 
+    <span class="fm">__repr__</span> <span class="o">=</span> <span class="fm">__str__</span>
 
+
 
+
 
+<span class="n">UNSET</span> <span class="o">=</span> <span class="n">FALSE</span><span class="p">(</span><span class="s1">&#39;&lt;UNSET&gt;&#39;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="SchemaIssue">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.SchemaIssue">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SchemaIssue</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Exception to store and/or raise a message from a schema issue.&quot;&quot;&quot;</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">level</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="s1">&#39;warn&#39;</span><span class="p">,</span> <span class="s1">&#39;invalid&#39;</span><span class="p">],</span> <span class="n">msg</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">level</span> <span class="o">=</span> <span class="n">level</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;[cfg schema </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">level</span><span class="si">}</span><span class="s2">] </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="Config">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">Config</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class used for configuration&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">UNSET</span> <span class="o">=</span> <span class="n">UNSET</span>
 
+
 
+    <span class="nd">@classmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">from_toml</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">schema_file</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Config</span><span class="p">:</span>
 
+
 
+        <span class="c1"># init schema</span>
 
+
 
+        <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;load schema file: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">schema_file</span><span class="p">)</span>
 
+        <span class="n">cfg</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">cfg_schema</span><span class="o">=</span><span class="n">toml_load</span><span class="p">(</span><span class="n">schema_file</span><span class="p">),</span> <span class="n">deprecated</span><span class="o">=</span><span class="n">deprecated</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">cfg_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
 
+            <span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;missing config file: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="n">cfg</span>
 
+
 
+        <span class="c1"># load configuration</span>
 
+
 
+        <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;load config file: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">)</span>
 
+        <span class="n">upd_cfg</span> <span class="o">=</span> <span class="n">toml_load</span><span class="p">(</span><span class="n">cfg_file</span><span class="p">)</span>
 
+
 
+        <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="n">upd_cfg</span><span class="p">)</span>
 
+        <span class="k">for</span> <span class="n">msg</span> <span class="ow">in</span> <span class="n">issue_list</span><span class="p">:</span>
 
+            <span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">msg</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">is_valid</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;schema of </span><span class="si">{</span><span class="n">cfg_file</span><span class="si">}</span><span class="s2"> is invalid!&quot;</span><span class="p">)</span>
 
+        <span class="n">cfg</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">upd_cfg</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">cfg</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">cfg_schema</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">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">&quot;&quot;&quot;Constructor of class Config.</span>
 
+
 
+<span class="sd">        :param cfg_schema: Schema of the configuration</span>
 
+<span class="sd">        :param deprecated: dictionary that maps deprecated configuration names to a messages</span>
 
+
 
+<span class="sd">        These values are needed for validation, see :py:obj:`validate`.</span>
 
+
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span> <span class="o">=</span> <span class="n">cfg_schema</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">deprecated</span> <span class="o">=</span> <span class="n">deprecated</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">cfg_schema</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="Config.validate">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.validate">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">validate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Validation of dictionary ``cfg`` on :py:obj:`Config.SCHEMA`.</span>
 
+<span class="sd">        Validation is done by :py:obj:`validate`.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">return</span> <span class="n">validate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span><span class="p">,</span> <span class="n">cfg</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deprecated</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="Config.update">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.update">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">upd_cfg</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Update this configuration by ``upd_cfg``.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">dict_deepupdate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">upd_cfg</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="Config.default">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.default">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">default</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="w">        </span><span class="sd">&quot;&quot;&quot;Returns default value of field ``name`` in ``self.cfg_schema``.&quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="n">value</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="Config.get">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.get">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get</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">default</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="n">UNSET</span><span class="p">,</span> <span class="n">replace</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the value to which ``name`` points in the configuration.</span>
 
+
 
+<span class="sd">        If there is no such ``name`` in the config and the ``default`` is</span>
 
+<span class="sd">        :py:obj:`UNSET`, a :py:obj:`KeyError` is raised.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_parent_dict</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+        <span class="n">val</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">UNSET</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="n">default</span>
 
+
 
+        <span class="k">if</span> <span class="n">replace</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="n">val</span> <span class="o">%</span> <span class="bp">self</span>
 
+        <span class="k">return</span> <span class="n">val</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="Config.set">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.set">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">set</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">val</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Set the value to which ``name`` points in the configuration.</span>
 
+
 
+<span class="sd">        If there is no such ``name`` in the config, a :py:obj:`KeyError` is</span>
 
+<span class="sd">        raised.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_parent_dict</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+        <span class="n">parent</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">val</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_get_parent_dict</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="n">parent_name</span> <span class="o">=</span> <span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
 
+        <span class="k">if</span> <span class="n">parent_name</span><span class="p">:</span>
 
+            <span class="n">parent</span> <span class="o">=</span> <span class="n">value</span><span class="p">(</span><span class="n">parent_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span>
 
+        <span class="k">if</span> <span class="p">(</span><span class="n">parent</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)):</span>
 
+            <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">parent_name</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">parent</span>
 
+
 
+<div class="viewcode-block" id="Config.path">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.path">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">path</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">default</span><span class="o">=</span><span class="n">UNSET</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get a :py:class:`pathlib.Path` object from a config string.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="n">default</span>
 
+        <span class="k">return</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">val</span><span class="p">))</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="Config.pyobj">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.pyobj">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">pyobj</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="n">default</span><span class="o">=</span><span class="n">UNSET</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get python object referred by full qualiffied name (FQN) in the config</span>
 
+<span class="sd">        string.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">fqn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">fqn</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="n">default</span>
 
+        <span class="p">(</span><span class="n">modulename</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">fqn</span><span class="p">)</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
 
+        <span class="n">m</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">modulename</span><span class="p">,</span> <span class="p">{},</span> <span class="p">{},</span> <span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div>
 
+</div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">toml_load</span><span class="p">(</span><span class="n">file_name</span><span class="p">):</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">tomllib</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="n">tomllib</span><span class="o">.</span><span class="n">TOMLDecodeError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
 
+        <span class="n">msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\t</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="p">)</span>
 
+        <span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
 
+        <span class="k">raise</span>
 
+
 
+
 
+<span class="c1"># working with dictionaries</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">value</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">data_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns the value to which ``name`` points in the ``dat_dict``.</span>
 
+
 
+<span class="sd">    .. code: python</span>
 
+
 
+<span class="sd">        &gt;&gt;&gt; data_dict = {</span>
 
+<span class="sd">                &quot;foo&quot;: {&quot;bar&quot;: 1 },</span>
 
+<span class="sd">                &quot;bar&quot;: {&quot;foo&quot;: 2 },</span>
 
+<span class="sd">                &quot;foobar&quot;: [1, 2, 3],</span>
 
+<span class="sd">            }</span>
 
+<span class="sd">        &gt;&gt;&gt; value(&#39;foobar&#39;, data_dict)</span>
 
+<span class="sd">        [1, 2, 3]</span>
 
+<span class="sd">        &gt;&gt;&gt; value(&#39;foo.bar&#39;, data_dict)</span>
 
+<span class="sd">        1</span>
 
+<span class="sd">        &gt;&gt;&gt; value(&#39;foo.bar.xxx&#39;, data_dict)</span>
 
+<span class="sd">        &lt;UNSET&gt;</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">ret_val</span> <span class="o">=</span> <span class="n">data_dict</span>
 
+    <span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ret_val</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+            <span class="n">ret_val</span> <span class="o">=</span> <span class="n">ret_val</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">part</span><span class="p">,</span> <span class="n">UNSET</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">ret_val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
 
+            <span class="k">break</span>
 
+    <span class="k">return</span> <span class="n">ret_val</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">validate</span><span class="p">(</span>
 
+    <span class="n">schema_dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">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="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">list</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Deep validation of dictionary in ``data_dict`` against dictionary in</span>
 
+<span class="sd">    ``schema_dict``.  Argument deprecated is a dictionary that maps deprecated</span>
 
+<span class="sd">    configuration names to a messages::</span>
 
+
 
+<span class="sd">        deprecated = {</span>
 
+<span class="sd">            &quot;foo.bar&quot; : &quot;config &#39;foo.bar&#39; is deprecated, use &#39;bar.foo&#39;&quot;,</span>
 
+<span class="sd">            &quot;...&quot;     : &quot;...&quot;</span>
 
+<span class="sd">        }</span>
 
+
 
+<span class="sd">    The function returns a python tuple ``(is_valid, issue_list)``:</span>
 
+
 
+<span class="sd">    ``is_valid``:</span>
 
+<span class="sd">      A bool value indicating ``data_dict`` is valid or not.</span>
 
+
 
+<span class="sd">    ``issue_list``:</span>
 
+<span class="sd">      A list of messages (:py:obj:`SchemaIssue`) from the validation::</span>
 
+
 
+<span class="sd">          [schema warn] data_dict: deprecated &#39;fontlib.foo&#39;: &lt;DEPRECATED[&#39;foo.bar&#39;]&gt;</span>
 
+<span class="sd">          [schema invalid] data_dict: key unknown &#39;fontlib.foo&#39;</span>
 
+<span class="sd">          [schema invalid] data_dict: type mismatch &#39;fontlib.foo&#39;: expected ..., is ...</span>
 
+
 
+<span class="sd">    If ``schema_dict`` or ``data_dict`` is not a dictionary type a</span>
 
+<span class="sd">    :py:obj:`SchemaIssue` is raised.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">names</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">is_valid</span> <span class="o">=</span> <span class="kc">True</span>
 
+    <span class="n">issue_list</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">schema_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">&#39;invalid&#39;</span><span class="p">,</span> <span class="s2">&quot;schema_dict is not a dict type&quot;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">&#39;invalid&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;data_dict issue</span><span class="si">{</span><span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2"> is not a dict type&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span> <span class="o">=</span> <span class="n">_validate</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">issue_list</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_validate</span><span class="p">(</span>
 
+    <span class="n">names</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">,</span>
 
+    <span class="n">issue_list</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">,</span>
 
+    <span class="n">schema_dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span>
 
+    <span class="n">data_dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span>
 
+    <span class="n">deprecated</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">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="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">]:</span>
 
+
 
+    <span class="n">is_valid</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+    <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">data_value</span> <span class="ow">in</span> <span class="n">data_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+
 
+        <span class="n">names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
 
+        <span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span>
 
+
 
+        <span class="n">deprecated_msg</span> <span class="o">=</span> <span class="n">deprecated</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+        <span class="c1"># print(&quot;XXX %s: key %s //   data_value: %s&quot; % (name, key, data_value))</span>
 
+        <span class="k">if</span> <span class="n">deprecated_msg</span><span class="p">:</span>
 
+            <span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">&#39;warn&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;data_dict &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39;: deprecated - </span><span class="si">{</span><span class="n">deprecated_msg</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
 
+
 
+        <span class="n">schema_value</span> <span class="o">=</span> <span class="n">value</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">)</span>
 
+        <span class="c1"># print(&quot;YYY %s: key %s // schema_value: %s&quot; % (name, key, schema_value))</span>
 
+        <span class="k">if</span> <span class="n">schema_value</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">deprecated_msg</span><span class="p">:</span>
 
+                <span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">&#39;invalid&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;data_dict &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39;: key unknown in schema_dict&quot;</span><span class="p">))</span>
 
+                <span class="n">is_valid</span> <span class="o">=</span> <span class="kc">False</span>
 
+
 
+        <span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">schema_value</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">type</span><span class="p">(</span><span class="n">data_value</span><span class="p">):</span>  <span class="c1"># pylint: disable=unidiomatic-typecheck</span>
 
+            <span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                <span class="n">SchemaIssue</span><span class="p">(</span>
 
+                    <span class="s1">&#39;invalid&#39;</span><span class="p">,</span>
 
+                    <span class="p">(</span><span class="sa">f</span><span class="s2">&quot;data_dict: type mismatch &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39;:&quot;</span> <span class="sa">f</span><span class="s2">&quot; expected </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">schema_value</span><span class="p">)</span><span class="si">}</span><span class="s2">, is: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">data_value</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">),</span>
 
+                <span class="p">)</span>
 
+            <span class="p">)</span>
 
+            <span class="n">is_valid</span> <span class="o">=</span> <span class="kc">False</span>
 
+
 
+        <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data_value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+            <span class="n">_valid</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_validate</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">issue_list</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">,</span> <span class="n">data_value</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">)</span>
 
+            <span class="n">is_valid</span> <span class="o">=</span> <span class="n">is_valid</span> <span class="ow">and</span> <span class="n">_valid</span>
 
+        <span class="n">names</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
 
+
 
+    <span class="k">return</span> <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">dict_deepupdate</span><span class="p">(</span><span class="n">base_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">upd_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">names</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Deep-update of dictionary in ``base_dict`` by dictionary in ``upd_dict``.</span>
 
+
 
+<span class="sd">    For each ``upd_key`` &amp; ``upd_val`` pair in ``upd_dict``:</span>
 
+
 
+<span class="sd">    0. If types of ``base_dict[upd_key]`` and ``upd_val`` do not match raise a</span>
 
+<span class="sd">       :py:obj:`TypeError`.</span>
 
+
 
+<span class="sd">    1. If ``base_dict[upd_key]`` is a dict: recursively deep-update it by ``upd_val``.</span>
 
+
 
+<span class="sd">    2. If ``base_dict[upd_key]`` not exist: set ``base_dict[upd_key]`` from a</span>
 
+<span class="sd">       (deep-) copy of ``upd_val``.</span>
 
+
 
+<span class="sd">    3. If ``upd_val`` is a list, extend list in ``base_dict[upd_key]`` by the</span>
 
+<span class="sd">       list in ``upd_val``.</span>
 
+
 
+<span class="sd">    4. If ``upd_val`` is a set, update set in ``base_dict[upd_key]`` by set in</span>
 
+<span class="sd">       ``upd_val``.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=too-many-branches</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;argument &#39;base_dict&#39; is not a ditionary type&quot;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;argument &#39;upd_dict&#39; is not a ditionary type&quot;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">names</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">names</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">for</span> <span class="n">upd_key</span><span class="p">,</span> <span class="n">upd_val</span> <span class="ow">in</span> <span class="n">upd_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="c1"># For each upd_key &amp; upd_val pair in upd_dict:</span>
 
+
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+
 
+            <span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
 
+                <span class="c1"># if base_dict[upd_key] exists, recursively deep-update it</span>
 
+                <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">dict</span><span class="p">):</span>
 
+                    <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;type mismatch </span><span class="si">{</span><span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a dict type in base_dict&quot;</span><span class="p">)</span>
 
+                <span class="n">dict_deepupdate</span><span class="p">(</span>
 
+                    <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span>
 
+                    <span class="n">upd_val</span><span class="p">,</span>
 
+                    <span class="n">names</span>
 
+                    <span class="o">+</span> <span class="p">[</span>
 
+                        <span class="n">upd_key</span><span class="p">,</span>
 
+                    <span class="p">],</span>
 
+                <span class="p">)</span>
 
+
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="c1"># if base_dict[upd_key] not exist, set base_dict[upd_key] from deepcopy of upd_val</span>
 
+                <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
 
+
 
+        <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 
+
 
+            <span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
 
+                <span class="c1"># if base_dict[upd_key] exists, base_dict[up_key] is extended by</span>
 
+                <span class="c1"># the list from upd_val</span>
 
+                <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">list</span><span class="p">):</span>
 
+                    <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;type mismatch </span><span class="si">{</span><span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a list type in base_dict&quot;</span><span class="p">)</span>
 
+                <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
 
+
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="c1"># if base_dict[upd_key] doesn&#39;t exists, set base_dict[key] from a deepcopy of the</span>
 
+                <span class="c1"># list in upd_val.</span>
 
+                <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
 
+
 
+        <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">set</span><span class="p">):</span>
 
+
 
+            <span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
 
+                <span class="c1"># if base_dict[upd_key] exists, base_dict[up_key] is updated by the set in upd_val</span>
 
+                <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">set</span><span class="p">):</span>
 
+                    <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;type mismatch </span><span class="si">{</span><span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a set type in base_dict&quot;</span><span class="p">)</span>
 
+                <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">upd_val</span><span class="o">.</span><span class="n">copy</span><span class="p">())</span>
 
+
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="c1"># if base_dict[upd_key] doesn&#39;t exists, set base_dict[upd_key] from a copy of the</span>
 
+                <span class="c1"># set in upd_val</span>
 
+                <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">upd_val</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
 
+
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="c1"># for any other type of upd_val replace or add base_dict[upd_key] by a copy</span>
 
+            <span class="c1"># of upd_val</span>
 
+            <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">upd_val</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 194 - 0
_modules/searx/botdetection/ip_lists.html
View File 

@@ -0,0 +1,194 @@
 
+<!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.botdetection.ip_lists &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.botdetection.ip_lists</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.botdetection.ip_lists</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;.. _botdetection.ip_lists:</span>
 
+
 
+<span class="sd">Method ``ip_lists``</span>
 
+<span class="sd">-------------------</span>
 
+
 
+<span class="sd">The ``ip_lists`` method implements IP :py:obj:`block- &lt;block_ip&gt;` and</span>
 
+<span class="sd">:py:obj:`pass-lists &lt;pass_ip&gt;`.</span>
 
+
 
+<span class="sd">.. code:: toml</span>
 
+
 
+<span class="sd">   [botdetection.ip_lists]</span>
 
+
 
+<span class="sd">   pass_ip = [</span>
 
+<span class="sd">    &#39;167.235.158.251&#39;, # IPv4 of check.searx.space</span>
 
+<span class="sd">    &#39;192.168.0.0/16&#39;,  # IPv4 private network</span>
 
+<span class="sd">    &#39;fe80::/10&#39;        # IPv6 linklocal</span>
 
+<span class="sd">   ]</span>
 
+<span class="sd">   block_ip = [</span>
 
+<span class="sd">      &#39;93.184.216.34&#39;, # IPv4 of example.org</span>
 
+<span class="sd">      &#39;257.1.1.1&#39;,     # invalid IP --&gt; will be ignored, logged in ERROR class</span>
 
+<span class="sd">   ]</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=unused-argument</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Tuple</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">ip_network</span><span class="p">,</span>
 
+    <span class="n">IPv4Address</span><span class="p">,</span>
 
+    <span class="n">IPv6Address</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">._helpers</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</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="s1">&#39;ip_limit&#39;</span><span class="p">)</span>
 
+
 
+<span class="n">SEARXNG_ORG</span> <span class="o">=</span> <span class="p">[</span>
 
+    <span class="c1"># https://github.com/searxng/searxng/pull/2484#issuecomment-1576639195</span>
 
+    <span class="s1">&#39;167.235.158.251&#39;</span><span class="p">,</span>  <span class="c1"># IPv4 check.searx.space</span>
 
+    <span class="s1">&#39;2a01:04f8:1c1c:8fc2::/64&#39;</span><span class="p">,</span>  <span class="c1"># IPv6 check.searx.space</span>
 
+<span class="p">]</span>
 
+<span class="sd">&quot;&quot;&quot;Passlist of IPs from the SearXNG organization, e.g. `check.searx.space`.&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="pass_ip">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.ip_lists.pass_ip">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">pass_ip</span><span class="p">(</span><span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">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="w">    </span><span class="sd">&quot;&quot;&quot;Checks if the IP on the subnet is in one of the members of the</span>
 
+<span class="sd">    ``botdetection.ip_lists.pass_ip`` list.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;botdetection.ip_lists.pass_searxng_org&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+        <span class="k">for</span> <span class="n">net</span> <span class="ow">in</span> <span class="n">SEARXNG_ORG</span><span class="p">:</span>
 
+            <span class="n">net</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="n">net</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">real_ip</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="n">net</span><span class="o">.</span><span class="n">version</span> <span class="ow">and</span> <span class="n">real_ip</span> <span class="ow">in</span> <span class="n">net</span><span class="p">:</span>
 
+                <span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;IP matches </span><span class="si">{</span><span class="n">net</span><span class="o">.</span><span class="n">compressed</span><span class="si">}</span><span class="s2"> in SEARXNG_ORG list.&quot;</span>
 
+    <span class="k">return</span> <span class="n">ip_is_subnet_of_member_in_list</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="s1">&#39;botdetection.ip_lists.pass_ip&#39;</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="block_ip">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.ip_lists.block_ip">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">block_ip</span><span class="p">(</span><span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">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="w">    </span><span class="sd">&quot;&quot;&quot;Checks if the IP on the subnet is in one of the members of the</span>
 
+<span class="sd">    ``botdetection.ip_lists.block_ip`` list.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">block</span><span class="p">,</span> <span class="n">msg</span> <span class="o">=</span> <span class="n">ip_is_subnet_of_member_in_list</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="s1">&#39;botdetection.ip_lists.block_ip&#39;</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">block</span><span class="p">:</span>
 
+        <span class="n">msg</span> <span class="o">+=</span> <span class="s2">&quot; To remove IP from list, please contact the maintainer of the service.&quot;</span>
 
+    <span class="k">return</span> <span class="n">block</span><span class="p">,</span> <span class="n">msg</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">ip_is_subnet_of_member_in_list</span><span class="p">(</span>
 
+    <span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">list_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span>
 
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">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="k">for</span> <span class="n">net</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">list_name</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="p">[]):</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">net</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="n">net</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="ne">ValueError</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">&quot;invalid IP </span><span class="si">%s</span><span class="s2"> in </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">net</span><span class="p">,</span> <span class="n">list_name</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">if</span> <span class="n">real_ip</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="n">net</span><span class="o">.</span><span class="n">version</span> <span class="ow">and</span> <span class="n">real_ip</span> <span class="ow">in</span> <span class="n">net</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;IP matches </span><span class="si">{</span><span class="n">net</span><span class="o">.</span><span class="n">compressed</span><span class="si">}</span><span class="s2"> in </span><span class="si">{</span><span class="n">list_name</span><span class="si">}</span><span class="s2">.&quot;</span>
 
+    <span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;IP is not a member of an item in the f</span><span class="si">{</span><span class="n">list_name</span><span class="si">}</span><span class="s2"> list&quot;</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 270 - 0
_modules/searx/botdetection/link_token.html
View File 

@@ -0,0 +1,270 @@
 
+<!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.botdetection.link_token &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.botdetection.link_token</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.botdetection.link_token</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">Method ``link_token``</span>
 
+<span class="sd">---------------------</span>
 
+
 
+<span class="sd">The ``link_token`` method evaluates a request as :py:obj:`suspicious</span>
 
+<span class="sd">&lt;is_suspicious&gt;` if the URL ``/client&lt;token&gt;.css`` is not requested by the</span>
 
+<span class="sd">client.  By adding a random component (the token) in the URL, a bot can not send</span>
 
+<span class="sd">a ping by request a static URL.</span>
 
+
 
+<span class="sd">.. note::</span>
 
+
 
+<span class="sd">   This method requires a redis DB and needs a HTTP X-Forwarded-For_ header.</span>
 
+
 
+<span class="sd">To get in use of this method a flask URL route needs to be added:</span>
 
+
 
+<span class="sd">.. code:: python</span>
 
+
 
+<span class="sd">   @app.route(&#39;/client&lt;token&gt;.css&#39;, methods=[&#39;GET&#39;, &#39;POST&#39;])</span>
 
+<span class="sd">   def client_token(token=None):</span>
 
+<span class="sd">       link_token.ping(request, token)</span>
 
+<span class="sd">       return Response(&#39;&#39;, mimetype=&#39;text/css&#39;)</span>
 
+
 
+<span class="sd">And in the HTML template from flask a stylesheet link is needed (the value of</span>
 
+<span class="sd">``link_token`` comes from :py:obj:`get_token`):</span>
 
+
 
+<span class="sd">.. code:: html</span>
 
+
 
+<span class="sd">   &lt;link rel=&quot;stylesheet&quot;</span>
 
+<span class="sd">         href=&quot;{{ url_for(&#39;client_token&#39;, token=link_token) }}&quot;</span>
 
+<span class="sd">         type=&quot;text/css&quot; &gt;</span>
 
+
 
+<span class="sd">.. _X-Forwarded-For:</span>
 
+<span class="sd">   https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">IPv4Network</span><span class="p">,</span>
 
+    <span class="n">IPv6Network</span><span class="p">,</span>
 
+    <span class="n">ip_address</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">string</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">random</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">redisdb</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.redislib</span><span class="w"> </span><span class="kn">import</span> <span class="n">secret_hash</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">._helpers</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">get_network</span><span class="p">,</span>
 
+    <span class="n">get_real_ip</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="n">TOKEN_LIVE_TIME</span> <span class="o">=</span> <span class="mi">600</span>
 
+<span class="sd">&quot;&quot;&quot;Lifetime (sec) of limiter&#39;s CSS token.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">PING_LIVE_TIME</span> <span class="o">=</span> <span class="mi">3600</span>
 
+<span class="sd">&quot;&quot;&quot;Lifetime (sec) of the ping-key from a client (request)&quot;&quot;&quot;</span>
 
+
 
+<span class="n">PING_KEY</span> <span class="o">=</span> <span class="s1">&#39;SearXNG_limiter.ping&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Prefix of all ping-keys generated by :py:obj:`get_ping_key`&quot;&quot;&quot;</span>
 
+
 
+<span class="n">TOKEN_KEY</span> <span class="o">=</span> <span class="s1">&#39;SearXNG_limiter.token&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Key for which the current token is stored in the DB&quot;&quot;&quot;</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="s1">&#39;botdetection.link_token&#39;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="is_suspicious">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.is_suspicious">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">is_suspicious</span><span class="p">(</span><span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">renew</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="w">    </span><span class="sd">&quot;&quot;&quot;Checks whether a valid ping is exists for this (client) network, if not</span>
 
+<span class="sd">    this request is rated as *suspicious*.  If a valid ping exists and argument</span>
 
+<span class="sd">    ``renew`` is ``True`` the expire time of this ping is reset to</span>
 
+<span class="sd">    :py:obj:`PING_LIVE_TIME`.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">redis_client</span> <span class="o">=</span> <span class="n">redisdb</span><span class="o">.</span><span class="n">client</span><span class="p">()</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">redis_client</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">False</span>
 
+
 
+    <span class="n">ping_key</span> <span class="o">=</span> <span class="n">get_ping_key</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">request</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">redis_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">ping_key</span><span class="p">):</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;missing ping (IP: </span><span class="si">%s</span><span class="s2">) / request: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">ping_key</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="kc">True</span>
 
+
 
+    <span class="k">if</span> <span class="n">renew</span><span class="p">:</span>
 
+        <span class="n">redis_client</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">ping_key</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">ex</span><span class="o">=</span><span class="n">PING_LIVE_TIME</span><span class="p">)</span>
 
+
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;found ping for (client) network </span><span class="si">%s</span><span class="s2"> -&gt; </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">ping_key</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="kc">False</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="ping">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.ping">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">ping</span><span class="p">(</span><span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">token</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;This function is called by a request to URL ``/client&lt;token&gt;.css``.  If</span>
 
+<span class="sd">    ``token`` is valid a :py:obj:`PING_KEY` for the client is stored in the DB.</span>
 
+<span class="sd">    The expire time of this ping-key is :py:obj:`PING_LIVE_TIME`.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">redis_client</span><span class="p">,</span> <span class="n">cfg</span>  <span class="c1"># pylint: disable=import-outside-toplevel, cyclic-import</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">redis_client</span><span class="p">:</span>
 
+        <span class="k">return</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">token_is_valid</span><span class="p">(</span><span class="n">token</span><span class="p">):</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="n">real_ip</span> <span class="o">=</span> <span class="n">ip_address</span><span class="p">(</span><span class="n">get_real_ip</span><span class="p">(</span><span class="n">request</span><span class="p">))</span>
 
+    <span class="n">network</span> <span class="o">=</span> <span class="n">get_network</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
 
+
 
+    <span class="n">ping_key</span> <span class="o">=</span> <span class="n">get_ping_key</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">request</span><span class="p">)</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;store ping_key for (client) network </span><span class="si">%s</span><span class="s2"> (IP </span><span class="si">%s</span><span class="s2">) -&gt; </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">real_ip</span><span class="p">,</span> <span class="n">ping_key</span><span class="p">)</span>
 
+    <span class="n">redis_client</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">ping_key</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">ex</span><span class="o">=</span><span class="n">PING_LIVE_TIME</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_ping_key">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.get_ping_key">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_ping_key</span><span class="p">(</span><span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Generates a hashed key that fits (more or less) to a *WEB-browser</span>
 
+<span class="sd">    session* in a network.&quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="p">(</span>
 
+        <span class="n">PING_KEY</span>
 
+        <span class="o">+</span> <span class="s2">&quot;[&quot;</span>
 
+        <span class="o">+</span> <span class="n">secret_hash</span><span class="p">(</span>
 
+            <span class="n">network</span><span class="o">.</span><span class="n">compressed</span> <span class="o">+</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Accept-Language&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;User-Agent&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+        <span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot;]&quot;</span>
 
+    <span class="p">)</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">token_is_valid</span><span class="p">(</span><span class="n">token</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+    <span class="n">valid</span> <span class="o">=</span> <span class="n">token</span> <span class="o">==</span> <span class="n">get_token</span><span class="p">()</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;token is valid --&gt; </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">valid</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">valid</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_token">
 
+<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.get_token">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_token</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns current token.  If there is no currently active token a new token</span>
 
+<span class="sd">    is generated randomly and stored in the redis DB.</span>
 
+
 
+<span class="sd">    - :py:obj:`TOKEN_LIVE_TIME`</span>
 
+<span class="sd">    - :py:obj:`TOKEN_KEY`</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">redis_client</span> <span class="o">=</span> <span class="n">redisdb</span><span class="o">.</span><span class="n">client</span><span class="p">()</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">redis_client</span><span class="p">:</span>
 
+        <span class="c1"># This function is also called when limiter is inactive / no redis DB</span>
 
+        <span class="c1"># (see render function in webapp.py)</span>
 
+        <span class="k">return</span> <span class="s1">&#39;12345678&#39;</span>
 
+    <span class="n">token</span> <span class="o">=</span> <span class="n">redis_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">TOKEN_KEY</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">token</span><span class="p">:</span>
 
+        <span class="n">token</span> <span class="o">=</span> <span class="n">token</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;UTF-8&#39;</span><span class="p">)</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">token</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">string</span><span class="o">.</span><span class="n">ascii_lowercase</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">16</span><span class="p">))</span>
 
+        <span class="n">redis_client</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">TOKEN_KEY</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">ex</span><span class="o">=</span><span class="n">TOKEN_LIVE_TIME</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">token</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 254 - 0
_modules/searx/enginelib.html
View File 

@@ -0,0 +1,254 @@
 
+<!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.enginelib &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.enginelib</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.enginelib</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Implementations of the framework for the SearXNG engines.</span>
 
+
 
+<span class="sd">.. hint::</span>
 
+
 
+<span class="sd">   The long term goal is to modularize all implementations of the engine</span>
 
+<span class="sd">   framework here in this Python package.  ToDo:</span>
 
+
 
+<span class="sd">   - move implementations of the :ref:`searx.engines loader` to a new module in</span>
 
+<span class="sd">     the :py:obj:`searx.enginelib` namespace.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</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">traits</span>
 
+
 
+
 
+<div class="viewcode-block" id="Engine">
 
+<a class="viewcode-back" href="../../dev/engines/enginelib.html#searx.enginelib.Engine">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">Engine</span><span class="p">:</span>  <span class="c1"># pylint: disable=too-few-public-methods</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Class of engine instances build from YAML settings.</span>
 
+
 
+<span class="sd">    Further documentation see :ref:`general engine configuration`.</span>
 
+
 
+<span class="sd">    .. hint::</span>
 
+
 
+<span class="sd">       This class is currently never initialized and only used for type hinting.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># Common options in the engine module</span>
 
+
 
+    <span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Type of the engine (:ref:`searx.search.processors`)&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">paging</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Engine supports multiple pages.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">time_range_support</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Engine supports search time range.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">safesearch</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Engine supports SafeSearch&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">language_support</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Engine supports languages (locales) search.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">language</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;For an engine, when there is ``language: ...`` in the YAML settings the engine</span>
 
+<span class="sd">    does support only this one language:</span>
 
+
 
+<span class="sd">    .. code:: yaml</span>
 
+
 
+<span class="sd">      - name: google french</span>
 
+<span class="sd">        engine: google</span>
 
+<span class="sd">        language: fr</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">region</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;For an engine, when there is ``region: ...`` in the YAML settings the engine</span>
 
+<span class="sd">    does support only this one region::</span>
 
+
 
+<span class="sd">    .. code:: yaml</span>
 
+
 
+<span class="sd">      - name: google belgium</span>
 
+<span class="sd">        engine: google</span>
 
+<span class="sd">        region: fr-BE</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">fetch_traits</span><span class="p">:</span> <span class="n">Callable</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Function to to fetch engine&#39;s traits from origin.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">traits</span><span class="p">:</span> <span class="n">traits</span><span class="o">.</span><span class="n">EngineTraits</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Traits of the engine.&quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># settings.yml</span>
 
+
 
+    <span class="n">categories</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Specifies to which :ref:`engine categories` the engine should be added.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Name that will be used across SearXNG to define this engine.  In settings, on</span>
 
+<span class="sd">    the result page ..&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Name of the python file used to handle requests and responses to and from</span>
 
+<span class="sd">    this search engine (file name from :origin:`searx/engines` without</span>
 
+<span class="sd">    ``.py``).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">enable_http</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Enable HTTP (by default only HTTPS is enabled).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">shortcut</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Code used to execute bang requests (``!foo``)&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Specific timeout for search-engine.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">display_error_messages</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Display error messages on the web UI.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">proxies</span><span class="p">:</span> <span class="nb">dict</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Set proxies for a specific engine (YAML):</span>
 
+
 
+<span class="sd">    .. code:: yaml</span>
 
+
 
+<span class="sd">       proxies :</span>
 
+<span class="sd">         http:  socks5://proxy:port</span>
 
+<span class="sd">         https: socks5://proxy:port</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">disabled</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;To disable by default the engine, but not deleting it.  It will allow the</span>
 
+<span class="sd">    user to manually activate it in the settings.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">inactive</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Remove the engine from the settings (*disabled &amp; removed*).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">about</span><span class="p">:</span> <span class="nb">dict</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Additional fields describing the engine.</span>
 
+
 
+<span class="sd">    .. code:: yaml</span>
 
+
 
+<span class="sd">       about:</span>
 
+<span class="sd">          website: https://example.com</span>
 
+<span class="sd">          wikidata_id: Q306656</span>
 
+<span class="sd">          official_api_documentation: https://example.com/api-doc</span>
 
+<span class="sd">          use_official_api: true</span>
 
+<span class="sd">          require_api_key: true</span>
 
+<span class="sd">          results: HTML</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">using_tor_proxy</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Using tor proxy (``true``) or not (``false``) for this engine.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">send_accept_language_header</span><span class="p">:</span> <span class="nb">bool</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;When this option is activated, the language (locale) that is selected by</span>
 
+<span class="sd">    the user is used to build and send a ``Accept-Language`` header in the</span>
 
+<span class="sd">    request to the origin search engine.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">tokens</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A list of secret tokens to make this engine *private*, more details see</span>
 
+<span class="sd">    :ref:`private engines`.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">weight</span><span class="p">:</span> <span class="nb">int</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Weighting of the results of this engine (:ref:`weight &lt;settings engines&gt;`).&quot;&quot;&quot;</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 411 - 0
_modules/searx/enginelib/traits.html
View File 

@@ -0,0 +1,411 @@
 
+<!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.enginelib.traits &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../enginelib.html" accesskey="U">searx.enginelib</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.enginelib.traits</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.enginelib.traits</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Engine&#39;s traits are fetched from the origin engines and stored in a JSON file</span>
 
+<span class="sd">in the *data folder*.  Most often traits are languages and region codes and</span>
 
+<span class="sd">their mapping from SearXNG&#39;s representation to the representation in the origin</span>
 
+<span class="sd">search engine.  For new traits new properties can be added to the class</span>
 
+<span class="sd">:py:class:`EngineTraits`.</span>
 
+
 
+<span class="sd">To load traits from the persistence :py:obj:`EngineTraitsMap.from_data` can be</span>
 
+<span class="sd">used.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">dataclasses</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">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Literal</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">TYPE_CHECKING</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">locales</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">data_dir</span><span class="p">,</span> <span class="n">ENGINE_TRAITS</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">Engine</span>
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraitsEncoder">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsEncoder">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">EngineTraitsEncoder</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">JSONEncoder</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Encodes :class:`EngineTraits` to a serializable object, see</span>
 
+<span class="sd">    :class:`json.JSONEncoder`.&quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="EngineTraitsEncoder.default">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsEncoder.default">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Return dictionary of a :class:`EngineTraits` object.&quot;&quot;&quot;</span>
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+            <span class="k">return</span> <span class="n">o</span><span class="o">.</span><span class="vm">__dict__</span>
 
+        <span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">default</span><span class="p">(</span><span class="n">o</span><span class="p">)</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraits">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits">[docs]</a>
 
+<span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">EngineTraits</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The class is intended to be instantiated for each engine.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">regions</span><span class="p">:</span> <span class="n">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="n">dataclasses</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Maps SearXNG&#39;s internal representation of a region to the one of the engine.</span>
 
+
 
+<span class="sd">    SearXNG&#39;s internal representation can be parsed by babel and the value is</span>
 
+<span class="sd">    send to the engine:</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">       regions ={</span>
 
+<span class="sd">           &#39;fr-BE&#39; : &lt;engine&#39;s region name&gt;,</span>
 
+<span class="sd">       }</span>
 
+
 
+<span class="sd">       for key, egnine_region regions.items():</span>
 
+<span class="sd">          searxng_region = babel.Locale.parse(key, sep=&#39;-&#39;)</span>
 
+<span class="sd">          ...</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">languages</span><span class="p">:</span> <span class="n">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="n">dataclasses</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Maps SearXNG&#39;s internal representation of a language to the one of the engine.</span>
 
+
 
+<span class="sd">    SearXNG&#39;s internal representation can be parsed by babel and the value is</span>
 
+<span class="sd">    send to the engine:</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">       languages = {</span>
 
+<span class="sd">           &#39;ca&#39; : &lt;engine&#39;s language name&gt;,</span>
 
+<span class="sd">       }</span>
 
+
 
+<span class="sd">       for key, egnine_lang in languages.items():</span>
 
+<span class="sd">          searxng_lang = babel.Locale.parse(key)</span>
 
+<span class="sd">          ...</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">all_locale</span><span class="p">:</span> <span class="n">Optional</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="w">    </span><span class="sd">&quot;&quot;&quot;To which locale value SearXNG&#39;s ``all`` language is mapped (shown a &quot;Default</span>
 
+<span class="sd">    language&quot;).</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">data_type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;traits_v1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;traits_v1&#39;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Data type, default is &#39;traits_v1&#39;.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">custom</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Union</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">],</span> <span class="n">Iterable</span><span class="p">[</span><span class="nb">str</span><span class="p">]]]</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A place to store engine&#39;s custom traits, not related to the SearXNG core.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="EngineTraits.get_language">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.get_language">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_language</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">searxng_locale</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Return engine&#39;s language string that *best fits* to SearXNG&#39;s locale.</span>
 
+
 
+<span class="sd">        :param searxng_locale: SearXNG&#39;s internal representation of locale</span>
 
+<span class="sd">          selected by the user.</span>
 
+
 
+<span class="sd">        :param default: engine&#39;s default language</span>
 
+
 
+<span class="sd">        The *best fits* rules are implemented in</span>
 
+<span class="sd">        :py:obj:`searx.locales.get_engine_locale`.  Except for the special value ``all``</span>
 
+<span class="sd">        which is determined from :py:obj:`EngineTraits.all_locale`.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">if</span> <span class="n">searxng_locale</span> <span class="o">==</span> <span class="s1">&#39;all&#39;</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_locale</span>
 
+        <span class="k">return</span> <span class="n">locales</span><span class="o">.</span><span class="n">get_engine_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">languages</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">default</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraits.get_region">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.get_region">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_region</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">searxng_locale</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Return engine&#39;s region string that best fits to SearXNG&#39;s locale.</span>
 
+
 
+<span class="sd">        :param searxng_locale: SearXNG&#39;s internal representation of locale</span>
 
+<span class="sd">          selected by the user.</span>
 
+
 
+<span class="sd">        :param default: engine&#39;s default region</span>
 
+
 
+<span class="sd">        The *best fits* rules are implemented in</span>
 
+<span class="sd">        :py:obj:`searx.locales.get_engine_locale`.  Except for the special value ``all``</span>
 
+<span class="sd">        which is determined from :py:obj:`EngineTraits.all_locale`.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">if</span> <span class="n">searxng_locale</span> <span class="o">==</span> <span class="s1">&#39;all&#39;</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_locale</span>
 
+        <span class="k">return</span> <span class="n">locales</span><span class="o">.</span><span class="n">get_engine_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">regions</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">default</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraits.is_locale_supported">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.is_locale_supported">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">is_locale_supported</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">searxng_locale</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;A *locale* (SearXNG&#39;s internal representation) is considered to be</span>
 
+<span class="sd">        supported by the engine if the *region* or the *language* is supported</span>
 
+<span class="sd">        by the engine.</span>
 
+
 
+<span class="sd">        For verification the functions :py:func:`EngineTraits.get_region` and</span>
 
+<span class="sd">        :py:func:`EngineTraits.get_language` are used.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_type</span> <span class="o">==</span> <span class="s1">&#39;traits_v1&#39;</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">))</span>
 
+
 
+        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;engine traits of type </span><span class="si">%s</span><span class="s1"> is unknown&#39;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_type</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraits.copy">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.copy">[docs]</a>
 
+    <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="w">        </span><span class="sd">&quot;&quot;&quot;Create a copy of the dataclass object.&quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="n">EngineTraits</span><span class="p">(</span><span class="o">**</span><span class="n">dataclasses</span><span class="o">.</span><span class="n">asdict</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraits.fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.fetch_traits">[docs]</a>
 
+    <span class="nd">@classmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">engine</span><span class="p">:</span> <span class="n">Engine</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Union</span><span class="p">[</span><span class="s1">&#39;EngineTraits&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Call a function ``fetch_traits(engine_traits)`` from engines namespace to fetch</span>
 
+<span class="sd">        and set properties from the origin engine in the object ``engine_traits``.  If</span>
 
+<span class="sd">        function does not exists, ``None`` is returned.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="n">fetch_traits</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;fetch_traits&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="n">engine_traits</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+        <span class="k">if</span> <span class="n">fetch_traits</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
 
+            <span class="n">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">engine_traits</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraits.set_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.set_traits">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">set_traits</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="n">Engine</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Set traits from self object in a :py:obj:`.Engine` namespace.</span>
 
+
 
+<span class="sd">        :param engine: engine instance build by :py:func:`searx.engines.load_engine`</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_type</span> <span class="o">==</span> <span class="s1">&#39;traits_v1&#39;</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">_set_traits_v1</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;engine traits of type </span><span class="si">%s</span><span class="s1"> is unknown&#39;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_type</span><span class="p">)</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_set_traits_v1</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="n">Engine</span><span class="p">):</span>
 
+        <span class="c1"># For an engine, when there is `language: ...` in the YAML settings the engine</span>
 
+        <span class="c1"># does support only this one language (region)::</span>
 
+        <span class="c1">#</span>
 
+        <span class="c1">#   - name: google italian</span>
 
+        <span class="c1">#     engine: google</span>
 
+        <span class="c1">#     language: it</span>
 
+        <span class="c1">#     region: it-IT                                      # type: ignore</span>
 
+
 
+        <span class="n">traits</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
 
+
 
+        <span class="n">_msg</span> <span class="o">=</span> <span class="s2">&quot;settings.yml - engine: &#39;</span><span class="si">%s</span><span class="s2">&#39; / </span><span class="si">%s</span><span class="s2">: &#39;</span><span class="si">%s</span><span class="s2">&#39; not supported&quot;</span>
 
+
 
+        <span class="n">languages</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">languages</span>
 
+        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;language&#39;</span><span class="p">):</span>
 
+            <span class="k">if</span> <span class="n">engine</span><span class="o">.</span><span class="n">language</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">languages</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_msg</span> <span class="o">%</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="s1">&#39;language&#39;</span><span class="p">,</span> <span class="n">engine</span><span class="o">.</span><span class="n">language</span><span class="p">))</span>
 
+            <span class="n">traits</span><span class="o">.</span><span class="n">languages</span> <span class="o">=</span> <span class="p">{</span><span class="n">engine</span><span class="o">.</span><span class="n">language</span><span class="p">:</span> <span class="n">languages</span><span class="p">[</span><span class="n">engine</span><span class="o">.</span><span class="n">language</span><span class="p">]}</span>
 
+
 
+        <span class="n">regions</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">regions</span>
 
+        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;region&#39;</span><span class="p">):</span>
 
+            <span class="k">if</span> <span class="n">engine</span><span class="o">.</span><span class="n">region</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">regions</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_msg</span> <span class="o">%</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="s1">&#39;region&#39;</span><span class="p">,</span> <span class="n">engine</span><span class="o">.</span><span class="n">region</span><span class="p">))</span>
 
+            <span class="n">traits</span><span class="o">.</span><span class="n">regions</span> <span class="o">=</span> <span class="p">{</span><span class="n">engine</span><span class="o">.</span><span class="n">region</span><span class="p">:</span> <span class="n">regions</span><span class="p">[</span><span class="n">engine</span><span class="o">.</span><span class="n">region</span><span class="p">]}</span>
 
+
 
+        <span class="n">engine</span><span class="o">.</span><span class="n">language_support</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">traits</span><span class="o">.</span><span class="n">languages</span> <span class="ow">or</span> <span class="n">traits</span><span class="o">.</span><span class="n">regions</span><span class="p">)</span>
 
+
 
+        <span class="c1"># set the copied &amp; modified traits in engine&#39;s namespace</span>
 
+        <span class="n">engine</span><span class="o">.</span><span class="n">traits</span> <span class="o">=</span> <span class="n">traits</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraitsMap">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsMap">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">EngineTraitsMap</span><span class="p">(</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">EngineTraits</span><span class="p">]):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A python dictionary to map :class:`EngineTraits` by engine name.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">ENGINE_TRAITS_FILE</span> <span class="o">=</span> <span class="p">(</span><span class="n">data_dir</span> <span class="o">/</span> <span class="s1">&#39;engine_traits.json&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;File with persistence of the :py:obj:`EngineTraitsMap`.&quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="EngineTraitsMap.save_data">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsMap.save_data">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">save_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Store EngineTraitsMap in in file :py:obj:`self.ENGINE_TRAITS_FILE`&quot;&quot;&quot;</span>
 
+        <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ENGINE_TRAITS_FILE</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
 
+            <span class="n">json</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">sort_keys</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="bp">cls</span><span class="o">=</span><span class="n">EngineTraitsEncoder</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="EngineTraitsMap.from_data">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsMap.from_data">[docs]</a>
 
+    <span class="nd">@classmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">from_data</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;EngineTraitsMap&#39;</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Instantiate :class:`EngineTraitsMap` object from :py:obj:`ENGINE_TRAITS`&quot;&quot;&quot;</span>
 
+        <span class="n">obj</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
 
+        <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">ENGINE_TRAITS</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="n">obj</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">EngineTraits</span><span class="p">(</span><span class="o">**</span><span class="n">v</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">obj</span></div>
 
+
 
+
 
+    <span class="nd">@classmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">log</span><span class="p">:</span> <span class="n">Callable</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s1">&#39;EngineTraitsMap&#39;</span><span class="p">:</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">engines</span>  <span class="c1"># pylint: disable=cyclic-import, import-outside-toplevel</span>
 
+
 
+        <span class="n">names</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">engines</span><span class="o">.</span><span class="n">engines</span><span class="p">)</span>
 
+        <span class="n">names</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
 
+        <span class="n">obj</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
 
+
 
+        <span class="k">for</span> <span class="n">engine_name</span> <span class="ow">in</span> <span class="n">names</span><span class="p">:</span>
 
+            <span class="n">engine</span> <span class="o">=</span> <span class="n">engines</span><span class="o">.</span><span class="n">engines</span><span class="p">[</span><span class="n">engine_name</span><span class="p">]</span>
 
+            <span class="n">traits</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+            <span class="c1"># pylint: disable=broad-exception-caught</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="n">traits</span> <span class="o">=</span> <span class="n">EngineTraits</span><span class="o">.</span><span class="n">fetch_traits</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
 
+            <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
 
+                <span class="n">log</span><span class="p">(</span><span class="s2">&quot;FATAL: while fetch_traits </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">engine_name</span><span class="p">,</span> <span class="n">exc</span><span class="p">))</span>
 
+                <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;FORCE&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;on&#39;</span><span class="p">,</span> <span class="s1">&#39;true&#39;</span><span class="p">,</span> <span class="s1">&#39;1&#39;</span><span class="p">]:</span>
 
+                    <span class="k">raise</span>
 
+                <span class="n">v</span> <span class="o">=</span> <span class="n">ENGINE_TRAITS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">engine_name</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="n">v</span><span class="p">:</span>
 
+                    <span class="n">log</span><span class="p">(</span><span class="s2">&quot;FORCE: re-use old values from fetch_traits - ENGINE_TRAITS[</span><span class="si">%s</span><span class="s2">]&quot;</span> <span class="o">%</span> <span class="n">engine_name</span><span class="p">)</span>
 
+                    <span class="n">traits</span> <span class="o">=</span> <span class="n">EngineTraits</span><span class="p">(</span><span class="o">**</span><span class="n">v</span><span class="p">)</span>
 
+
 
+            <span class="k">if</span> <span class="n">traits</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="n">log</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%-20s</span><span class="s2">: SearXNG languages --&gt; </span><span class="si">%s</span><span class="s2"> &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">engine_name</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">traits</span><span class="o">.</span><span class="n">languages</span><span class="p">)))</span>
 
+                <span class="n">log</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%-20s</span><span class="s2">: SearXNG regions   --&gt; </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">engine_name</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">traits</span><span class="o">.</span><span class="n">regions</span><span class="p">)))</span>
 
+                <span class="n">obj</span><span class="p">[</span><span class="n">engine_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">traits</span>
 
+
 
+        <span class="k">return</span> <span class="n">obj</span>
 
+
 
+<div class="viewcode-block" id="EngineTraitsMap.set_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsMap.set_traits">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">set_traits</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="n">Engine</span> <span class="o">|</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Set traits in a :py:obj:`Engine` namespace.</span>
 
+
 
+<span class="sd">        :param engine: engine instance build by :py:func:`searx.engines.load_engine`</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="n">engine_traits</span> <span class="o">=</span> <span class="n">EngineTraits</span><span class="p">(</span><span class="n">data_type</span><span class="o">=</span><span class="s1">&#39;traits_v1&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">engine</span><span class="o">.</span><span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
 
+            <span class="n">engine_traits</span> <span class="o">=</span> <span class="bp">self</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="k">elif</span> <span class="n">engine</span><span class="o">.</span><span class="n">engine</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
 
+            <span class="c1"># The key of the dictionary traits_map is the *engine name*</span>
 
+            <span class="c1"># configured in settings.xml.  When multiple engines are configured</span>
 
+            <span class="c1"># in settings.yml to use the same origin engine (python module)</span>
 
+            <span class="c1"># these additional engines can use the languages from the origin</span>
 
+            <span class="c1"># engine.  For this use the configured ``engine: ...`` from</span>
 
+            <span class="c1"># settings.yml</span>
 
+            <span class="n">engine_traits</span> <span class="o">=</span> <span class="bp">self</span><span class="p">[</span><span class="n">engine</span><span class="o">.</span><span class="n">engine</span><span class="p">]</span>
 
+
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">set_traits</span><span class="p">(</span><span class="n">engine</span><span class="p">)</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="../enginelib.html">searx.enginelib</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 369 - 0
_modules/searx/engines.html
View File 

@@ -0,0 +1,369 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Load and initialize the ``engines``, see :py:func:`load_engines` and register</span>
 
+<span class="sd">:py:obj:`engine_shortcuts`.</span>
 
+
 
+<span class="sd">usage::</span>
 
+
 
+<span class="sd">    load_engines( settings[&#39;engines&#39;] )</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">copy</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">os.path</span><span class="w"> </span><span class="kn">import</span> <span class="n">realpath</span><span class="p">,</span> <span class="n">dirname</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">Dict</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">types</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">inspect</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="p">,</span> <span class="n">settings</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">load_module</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</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="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="s1">&#39;engines&#39;</span><span class="p">)</span>
 
+<span class="n">ENGINE_DIR</span> <span class="o">=</span> <span class="n">dirname</span><span class="p">(</span><span class="n">realpath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
 
+<span class="n">ENGINE_DEFAULT_ARGS</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="c1"># Common options in the engine module</span>
 
+    <span class="s2">&quot;engine_type&quot;</span><span class="p">:</span> <span class="s2">&quot;online&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;paging&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;time_range_support&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;safesearch&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="c1"># settings.yml</span>
 
+    <span class="s2">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;general&quot;</span><span class="p">],</span>
 
+    <span class="s2">&quot;enable_http&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s2">&quot;-&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;timeout&quot;</span><span class="p">:</span> <span class="n">settings</span><span class="p">[</span><span class="s2">&quot;outgoing&quot;</span><span class="p">][</span><span class="s2">&quot;request_timeout&quot;</span><span class="p">],</span>
 
+    <span class="s2">&quot;display_error_messages&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;disabled&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;inactive&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;about&quot;</span><span class="p">:</span> <span class="p">{},</span>
 
+    <span class="s2">&quot;using_tor_proxy&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;send_accept_language_header&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;tokens&quot;</span><span class="p">:</span> <span class="p">[],</span>
 
+    <span class="s2">&quot;max_page&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="c1"># set automatically when an engine does not have any tab category</span>
 
+<span class="n">DEFAULT_CATEGORY</span> <span class="o">=</span> <span class="s1">&#39;other&#39;</span>
 
+
 
+
 
+<span class="c1"># Defaults for the namespace of an engine module, see :py:func:`load_engine`</span>
 
+
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;general&#39;</span><span class="p">:</span> <span class="p">[]}</span>
 
+<span class="n">engines</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Engine</span> <span class="o">|</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="n">engine_shortcuts</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="sd">&quot;&quot;&quot;Simple map of registered *shortcuts* to name of the engine (or ``None``).</span>
 
+
 
+<span class="sd">::</span>
 
+
 
+<span class="sd">    engine_shortcuts[engine.shortcut] = engine.name</span>
 
+
 
+<span class="sd">:meta hide-value:</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">check_engine_module</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">):</span>
 
+    <span class="c1"># probe unintentional name collisions / for example name collisions caused</span>
 
+    <span class="c1"># by import statements in the engine module ..</span>
 
+
 
+    <span class="c1"># network: https://github.com/searxng/searxng/issues/762#issuecomment-1605323861</span>
 
+    <span class="n">obj</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="s1">&#39;network&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">obj</span> <span class="ow">and</span> <span class="n">inspect</span><span class="o">.</span><span class="n">ismodule</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
 
+        <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;type of </span><span class="si">{</span><span class="n">module</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s1">.network is a module (</span><span class="si">{</span><span class="n">obj</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s1">), expected a string&#39;</span>
 
+        <span class="c1"># logger.error(msg)</span>
 
+        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="load_engine">
 
+<a class="viewcode-back" href="../../dev/engines/engines.html#searx.engines.load_engine">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">load_engine</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="o">-&gt;</span> <span class="n">Engine</span> <span class="o">|</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Load engine from ``engine_data``.</span>
 
+
 
+<span class="sd">    :param dict engine_data:  Attributes from YAML ``settings:engines/&lt;engine&gt;``</span>
 
+<span class="sd">    :return: initialized namespace of the ``&lt;engine&gt;``.</span>
 
+
 
+<span class="sd">    1. create a namespace and load module of the ``&lt;engine&gt;``</span>
 
+<span class="sd">    2. update namespace with the defaults from :py:obj:`ENGINE_DEFAULT_ARGS`</span>
 
+<span class="sd">    3. update namespace with values from ``engine_data``</span>
 
+
 
+<span class="sd">    If engine *is active*, return namespace of the engine, otherwise return</span>
 
+<span class="sd">    ``None``.</span>
 
+
 
+<span class="sd">    This function also returns ``None`` if initialization of the namespace fails</span>
 
+<span class="sd">    for one of the following reasons:</span>
 
+
 
+<span class="sd">    - engine name contains underscore</span>
 
+<span class="sd">    - engine name is not lowercase</span>
 
+<span class="sd">    - required attribute is not set :py:func:`is_missing_required_attributes`</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=too-many-return-statements</span>
 
+
 
+    <span class="n">engine_name</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="s1">&#39;name&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">engine_name</span> <span class="ow">is</span> <span class="kc">None</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="s1">&#39;An engine does not have a &quot;name&quot; field&#39;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+    <span class="k">if</span> <span class="s1">&#39;_&#39;</span> <span class="ow">in</span> <span class="n">engine_name</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="s1">&#39;Engine name contains underscore: &quot;</span><span class="si">{}</span><span class="s1">&quot;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">engine_name</span><span class="p">))</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="k">if</span> <span class="n">engine_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">!=</span> <span class="n">engine_name</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">&#39;Engine name is not lowercase: &quot;</span><span class="si">{}</span><span class="s1">&quot;, converting to lowercase&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">engine_name</span><span class="p">))</span>
 
+        <span class="n">engine_name</span> <span class="o">=</span> <span class="n">engine_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
 
+        <span class="n">engine_data</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine_name</span>
 
+
 
+    <span class="c1"># load_module</span>
 
+    <span class="n">module_name</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="s1">&#39;engine&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">module_name</span> <span class="ow">is</span> <span class="kc">None</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="s1">&#39;The &quot;engine&quot; field is missing for the engine named &quot;</span><span class="si">{}</span><span class="s1">&quot;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">engine_name</span><span class="p">))</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">engine</span> <span class="o">=</span> <span class="n">load_module</span><span class="p">(</span><span class="n">module_name</span> <span class="o">+</span> <span class="s1">&#39;.py&#39;</span><span class="p">,</span> <span class="n">ENGINE_DIR</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="p">(</span><span class="ne">SyntaxError</span><span class="p">,</span> <span class="ne">KeyboardInterrupt</span><span class="p">,</span> <span class="ne">SystemExit</span><span class="p">,</span> <span class="ne">SystemError</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">,</span> <span class="ne">RuntimeError</span><span class="p">):</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s1">&#39;Fatal exception in engine &quot;</span><span class="si">{}</span><span class="s1">&quot;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">module_name</span><span class="p">))</span>
 
+        <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="ne">BaseException</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s1">&#39;Cannot load engine &quot;</span><span class="si">{}</span><span class="s1">&quot;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">module_name</span><span class="p">))</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="n">check_engine_module</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
 
+    <span class="n">update_engine_attributes</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">engine_data</span><span class="p">)</span>
 
+    <span class="n">update_attributes_for_tor</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
 
+
 
+    <span class="c1"># avoid cyclic imports</span>
 
+    <span class="c1"># pylint: disable=import-outside-toplevel</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraitsMap</span>
 
+
 
+    <span class="n">trait_map</span> <span class="o">=</span> <span class="n">EngineTraitsMap</span><span class="o">.</span><span class="n">from_data</span><span class="p">()</span>
 
+    <span class="n">trait_map</span><span class="o">.</span><span class="n">set_traits</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">is_engine_active</span><span class="p">(</span><span class="n">engine</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="k">if</span> <span class="n">is_missing_required_attributes</span><span class="p">(</span><span class="n">engine</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="n">set_loggers</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">engine_name</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">cat</span> <span class="ow">in</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;categories_as_tabs&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">cat</span> <span class="ow">in</span> <span class="n">engine</span><span class="o">.</span><span class="n">categories</span><span class="p">):</span>
 
+        <span class="n">engine</span><span class="o">.</span><span class="n">categories</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">DEFAULT_CATEGORY</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">engine</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">set_loggers</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">engine_name</span><span class="p">):</span>
 
+    <span class="c1"># set the logger for engine</span>
 
+    <span class="n">engine</span><span class="o">.</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="n">engine_name</span><span class="p">)</span>
 
+    <span class="c1"># the engine may have load some other engines</span>
 
+    <span class="c1"># may sure the logger is initialized</span>
 
+    <span class="c1"># use sys.modules.copy() to avoid &quot;RuntimeError: dictionary changed size during iteration&quot;</span>
 
+    <span class="c1"># see https://github.com/python/cpython/issues/89516</span>
 
+    <span class="c1"># and https://docs.python.org/3.10/library/sys.html#sys.modules</span>
 
+    <span class="n">modules</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
 
+    <span class="k">for</span> <span class="n">module_name</span><span class="p">,</span> <span class="n">module</span> <span class="ow">in</span> <span class="n">modules</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="p">(</span>
 
+            <span class="n">module_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;searx.engines&quot;</span><span class="p">)</span>
 
+            <span class="ow">and</span> <span class="n">module_name</span> <span class="o">!=</span> <span class="s2">&quot;searx.engines.__init__&quot;</span>
 
+            <span class="ow">and</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="s2">&quot;logger&quot;</span><span class="p">)</span>
 
+        <span class="p">):</span>
 
+            <span class="n">module_engine_name</span> <span class="o">=</span> <span class="n">module_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;.&quot;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+            <span class="n">module</span><span class="o">.</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="n">module_engine_name</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">update_engine_attributes</span><span class="p">(</span><span class="n">engine</span><span class="p">:</span> <span class="n">Engine</span> <span class="o">|</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">,</span> <span class="n">engine_data</span><span class="p">):</span>
 
+    <span class="c1"># set engine attributes from engine_data</span>
 
+    <span class="k">for</span> <span class="n">param_name</span><span class="p">,</span> <span class="n">param_value</span> <span class="ow">in</span> <span class="n">engine_data</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="n">param_name</span> <span class="o">==</span> <span class="s1">&#39;categories&#39;</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">param_value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+                <span class="n">param_value</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">strip</span><span class="p">,</span> <span class="n">param_value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">)))</span>
 
+            <span class="n">engine</span><span class="o">.</span><span class="n">categories</span> <span class="o">=</span> <span class="n">param_value</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;about&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">param_name</span> <span class="o">==</span> <span class="s1">&#39;about&#39;</span><span class="p">:</span>
 
+            <span class="n">engine</span><span class="o">.</span><span class="n">about</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="n">engine</span><span class="o">.</span><span class="n">about</span><span class="p">,</span> <span class="o">**</span><span class="n">engine_data</span><span class="p">[</span><span class="s1">&#39;about&#39;</span><span class="p">]}</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="nb">setattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">param_name</span><span class="p">,</span> <span class="n">param_value</span><span class="p">)</span>
 
+
 
+    <span class="c1"># set default attributes</span>
 
+    <span class="k">for</span> <span class="n">arg_name</span><span class="p">,</span> <span class="n">arg_value</span> <span class="ow">in</span> <span class="n">ENGINE_DEFAULT_ARGS</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">):</span>
 
+            <span class="nb">setattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">,</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">arg_value</span><span class="p">))</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">update_attributes_for_tor</span><span class="p">(</span><span class="n">engine</span><span class="p">:</span> <span class="n">Engine</span> <span class="o">|</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="n">using_tor_proxy</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;onion_url&#39;</span><span class="p">):</span>
 
+        <span class="n">engine</span><span class="o">.</span><span class="n">search_url</span> <span class="o">=</span> <span class="n">engine</span><span class="o">.</span><span class="n">onion_url</span> <span class="o">+</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;search_path&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">engine</span><span class="o">.</span><span class="n">timeout</span> <span class="o">+=</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;outgoing&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;extra_proxy_timeout&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+
 
+<div class="viewcode-block" id="is_missing_required_attributes">
 
+<a class="viewcode-back" href="../../dev/engines/engines.html#searx.engines.is_missing_required_attributes">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">is_missing_required_attributes</span><span class="p">(</span><span class="n">engine</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;An attribute is required when its name doesn&#39;t start with ``_`` (underline).</span>
 
+<span class="sd">    Required attributes must not be ``None``.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">missing</span> <span class="o">=</span> <span class="kc">False</span>
 
+    <span class="k">for</span> <span class="n">engine_attr</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">engine</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">engine_attr</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">engine_attr</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</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="s1">&#39;Missing engine config attribute: &quot;</span><span class="si">{0}</span><span class="s1">.</span><span class="si">{1}</span><span class="s1">&quot;&#39;</span><span class="o">.</span><span class="n">format</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="n">engine_attr</span><span class="p">))</span>
 
+            <span class="n">missing</span> <span class="o">=</span> <span class="kc">True</span>
 
+    <span class="k">return</span> <span class="n">missing</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="using_tor_proxy">
 
+<a class="viewcode-back" href="../../dev/engines/engines.html#searx.engines.using_tor_proxy">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">using_tor_proxy</span><span class="p">(</span><span class="n">engine</span><span class="p">:</span> <span class="n">Engine</span> <span class="o">|</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return True if the engine configuration declares to use Tor.&quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;outgoing&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;using_tor_proxy&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;using_tor_proxy&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">is_engine_active</span><span class="p">(</span><span class="n">engine</span><span class="p">:</span> <span class="n">Engine</span> <span class="o">|</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">):</span>
 
+    <span class="c1"># check if engine is inactive</span>
 
+    <span class="k">if</span> <span class="n">engine</span><span class="o">.</span><span class="n">inactive</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">False</span>
 
+
 
+    <span class="c1"># exclude onion engines if not using tor</span>
 
+    <span class="k">if</span> <span class="s1">&#39;onions&#39;</span> <span class="ow">in</span> <span class="n">engine</span><span class="o">.</span><span class="n">categories</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">using_tor_proxy</span><span class="p">(</span><span class="n">engine</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">False</span>
 
+
 
+    <span class="k">return</span> <span class="kc">True</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">register_engine</span><span class="p">(</span><span class="n">engine</span><span class="p">:</span> <span class="n">Engine</span> <span class="o">|</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="n">engine</span><span class="o">.</span><span class="n">name</span> <span class="ow">in</span> <span class="n">engines</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="s1">&#39;Engine config error: ambiguous name: </span><span class="si">{0}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</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="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</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">engine</span>
 
+
 
+    <span class="k">if</span> <span class="n">engine</span><span class="o">.</span><span class="n">shortcut</span> <span class="ow">in</span> <span class="n">engine_shortcuts</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="s1">&#39;Engine config error: ambiguous shortcut: </span><span class="si">{0}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">engine</span><span class="o">.</span><span class="n">shortcut</span><span class="p">))</span>
 
+        <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
 
+    <span class="n">engine_shortcuts</span><span class="p">[</span><span class="n">engine</span><span class="o">.</span><span class="n">shortcut</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine</span><span class="o">.</span><span class="n">name</span>
 
+
 
+    <span class="k">for</span> <span class="n">category_name</span> <span class="ow">in</span> <span class="n">engine</span><span class="o">.</span><span class="n">categories</span><span class="p">:</span>
 
+        <span class="n">categories</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">category_name</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="load_engines">
 
+<a class="viewcode-back" href="../../dev/engines/engines.html#searx.engines.load_engines">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">load_engines</span><span class="p">(</span><span class="n">engine_list</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;usage: ``engine_list = settings[&#39;engines&#39;]``&quot;&quot;&quot;</span>
 
+    <span class="n">engines</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
 
+    <span class="n">engine_shortcuts</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
 
+    <span class="n">categories</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
 
+    <span class="n">categories</span><span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">engine_data</span> <span class="ow">in</span> <span class="n">engine_list</span><span class="p">:</span>
 
+        <span class="n">engine</span> <span class="o">=</span> <span class="n">load_engine</span><span class="p">(</span><span class="n">engine_data</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">engine</span><span class="p">:</span>
 
+            <span class="n">register_engine</span><span class="p">(</span><span class="n">engine</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">engines</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 316 - 0
_modules/searx/engines/annas_archive.html
View File 

@@ -0,0 +1,316 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.annas_archive &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.annas_archive</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.annas_archive</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;`Anna&#39;s Archive`_ is a free non-profit online shadow library metasearch</span>
 
+<span class="sd">engine providing access to a variety of book resources (also via IPFS), created</span>
 
+<span class="sd">by a team of anonymous archivists (AnnaArchivist_).</span>
 
+
 
+<span class="sd">.. _Anna&#39;s Archive: https://annas-archive.org/</span>
 
+<span class="sd">.. _AnnaArchivist: https://annas-software.org/AnnaArchivist/annas-archive</span>
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">The engine has the following additional settings:</span>
 
+
 
+<span class="sd">- :py:obj:`aa_content`</span>
 
+<span class="sd">- :py:obj:`aa_ext`</span>
 
+<span class="sd">- :py:obj:`aa_sort`</span>
 
+
 
+<span class="sd">With this options a SearXNG maintainer is able to configure **additional**</span>
 
+<span class="sd">engines for specific searches in Anna&#39;s Archive.  For example a engine to search</span>
 
+<span class="sd">for *newest* articles and journals (PDF) / by shortcut ``!aaa &lt;search-term&gt;``.</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: annas articles</span>
 
+<span class="sd">    engine: annas_archive</span>
 
+<span class="sd">    shortcut: aaa</span>
 
+<span class="sd">    aa_content: &#39;magazine&#39;</span>
 
+<span class="sd">    aa_ext: &#39;pdf&#39;</span>
 
+<span class="sd">    aa_sort: &#39;newest&#39;</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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">extract_text</span><span class="p">,</span> <span class="n">eval_xpath</span><span class="p">,</span> <span class="n">eval_xpath_getindex</span><span class="p">,</span> <span class="n">eval_xpath_list</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</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">ENGINE_TRAITS</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s2">&quot;https://annas-archive.org/&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s2">&quot;Q115288326&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s2">&quot;HTML&quot;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;files&quot;</span><span class="p">]</span>
 
+<span class="n">paging</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+<span class="c1"># search-url</span>
 
+<span class="n">base_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;https://annas-archive.org&quot;</span>
 
+<span class="n">aa_content</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;Anan&#39;s search form field **Content** / possible values::</span>
 
+
 
+<span class="sd">    book_fiction, book_unknown, book_nonfiction,</span>
 
+<span class="sd">    book_comic, magazine, standards_document</span>
 
+
 
+<span class="sd">To not filter use an empty string (default).</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="n">aa_sort</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Sort Anna&#39;s results, possible values::</span>
 
+
 
+<span class="sd">    newest, oldest, largest, smallest</span>
 
+
 
+<span class="sd">To sort by *most relevant* use an empty string (default).&quot;&quot;&quot;</span>
 
+
 
+<span class="n">aa_ext</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Filter Anna&#39;s results by a file ending.  Common filters for example are</span>
 
+<span class="sd">``pdf`` and ``epub``.</span>
 
+
 
+<span class="sd">.. note::</span>
 
+
 
+<span class="sd">   Anna&#39;s Archive is a beta release: Filter results by file extension does not</span>
 
+<span class="sd">   really work on Anna&#39;s Archive.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="init">
 
+<a class="viewcode-back" href="../../../dev/engines/online/annas_archive.html#searx.engines.annas_archive.init">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Check of engine&#39;s settings.&quot;&quot;&quot;</span>
 
+    <span class="n">traits</span> <span class="o">=</span> <span class="n">EngineTraits</span><span class="p">(</span><span class="o">**</span><span class="n">ENGINE_TRAITS</span><span class="p">[</span><span class="s1">&#39;annas archive&#39;</span><span class="p">])</span>
 
+
 
+    <span class="k">if</span> <span class="n">aa_content</span> <span class="ow">and</span> <span class="n">aa_content</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;content&#39;</span><span class="p">]:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;invalid setting content: </span><span class="si">{</span><span class="n">aa_content</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">aa_sort</span> <span class="ow">and</span> <span class="n">aa_sort</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;sort&#39;</span><span class="p">]:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;invalid setting sort: </span><span class="si">{</span><span class="n">aa_sort</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">aa_ext</span> <span class="ow">and</span> <span class="n">aa_ext</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;ext&#39;</span><span class="p">]:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;invalid setting ext: </span><span class="si">{</span><span class="n">aa_ext</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
 
+    <span class="n">lang</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;language&quot;</span><span class="p">],</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;lang&#39;</span><span class="p">:</span> <span class="n">lang</span><span class="p">,</span>
 
+        <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">aa_content</span><span class="p">,</span>
 
+        <span class="s1">&#39;ext&#39;</span><span class="p">:</span> <span class="n">aa_ext</span><span class="p">,</span>
 
+        <span class="s1">&#39;sort&#39;</span><span class="p">:</span> <span class="n">aa_sort</span><span class="p">,</span>
 
+        <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;page&#39;</span><span class="p">:</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">],</span>
 
+    <span class="p">}</span>
 
+    <span class="c1"># filter out None and empty values</span>
 
+    <span class="n">filtered_args</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">args</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="n">v</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s2">/search?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">(</span><span class="n">filtered_args</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]]]:</span>
 
+    <span class="n">results</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]]]</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//main//div[contains(@class, &quot;h-[125]&quot;)]/a&#39;</span><span class="p">):</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_get_result</span><span class="p">(</span><span class="n">item</span><span class="p">))</span>
 
+
 
+    <span class="c1"># The rendering of the WEB page is very strange; except the first position</span>
 
+    <span class="c1"># all other positions of Anna&#39;s result page are enclosed in SGML comments.</span>
 
+    <span class="c1"># These comments are *uncommented* by some JS code, see query of class</span>
 
+    <span class="c1"># &#39;.js-scroll-hidden&#39; in Anna&#39;s HTML template:</span>
 
+    <span class="c1">#   https://annas-software.org/AnnaArchivist/annas-archive/-/blob/main/allthethings/templates/macros/md5_list.html</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//main//div[contains(@class, &quot;js-scroll-hidden&quot;)]&#39;</span><span class="p">):</span>
 
+        <span class="n">item</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;./comment()&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_get_result</span><span class="p">(</span><span class="n">item</span><span class="p">))</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_get_result</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
 
+    <span class="k">return</span> <span class="p">{</span>
 
+        <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;paper.html&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;./@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)),</span>
 
+        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//h3/text()[1]&#39;</span><span class="p">)),</span>
 
+        <span class="s1">&#39;publisher&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;text-sm&quot;)]&#39;</span><span class="p">)),</span>
 
+        <span class="s1">&#39;authors&#39;</span><span class="p">:</span> <span class="p">[</span><span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;italic&quot;)]&#39;</span><span class="p">))],</span>
 
+        <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;text-xs&quot;)]&#39;</span><span class="p">)),</span>
 
+        <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//img/@src&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">),</span> <span class="n">allow_none</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span>
 
+    <span class="p">}</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/annas_archive.html#searx.engines.annas_archive.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages and other search arguments from Anna&#39;s search form.&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=import-outside-toplevel</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.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">get</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">language_tag</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;content&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;ext&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;sort&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;/search&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Response from Anna&#39;s search page is not OK.&quot;</span><span class="p">)</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="c1"># supported language codes</span>
 
+
 
+    <span class="n">lang_map</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//form//input[@name=&#39;lang&#39;]&quot;</span><span class="p">):</span>
 
+        <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">eng_lang</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;_empty&#39;</span><span class="p">,</span> <span class="s1">&#39;nl-BE&#39;</span><span class="p">,</span> <span class="s1">&#39;und&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">eng_lang</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;anti__&#39;</span><span class="p">):</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">try</span><span class="p">:</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="n">lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_lang</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="c1"># silently ignore unknown languages</span>
 
+            <span class="c1"># print(&quot;ERROR: %s -&gt; %s is unknown by babel&quot; % (x.get(&quot;data-name&quot;), eng_lang))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">sxng_lang</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_lang</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_lang</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_lang</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_lang</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_lang</span>
 
+
 
+    <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//form//input[@name=&#39;content&#39;]&quot;</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;anti__&quot;</span><span class="p">):</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;content&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">))</span>
 
+
 
+    <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//form//input[@name=&#39;ext&#39;]&quot;</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;anti__&quot;</span><span class="p">):</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;ext&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">))</span>
 
+
 
+    <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//form//select[@name=&#39;sort&#39;]//option&quot;</span><span class="p">):</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;sort&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">))</span>
 
+
 
+    <span class="c1"># for better diff; sort the persistence of these traits</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;content&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;ext&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;sort&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">sort</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 262 - 0
_modules/searx/engines/archlinux.html
View File 

@@ -0,0 +1,262 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.archlinux &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.archlinux</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.archlinux</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">Arch Linux Wiki</span>
 
+<span class="sd">~~~~~~~~~~~~~~~</span>
 
+
 
+<span class="sd">This implementation does not use a official API: Mediawiki provides API, but</span>
 
+<span class="sd">Arch Wiki blocks access to it.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span><span class="p">,</span> <span class="n">urljoin</span><span class="p">,</span> <span class="n">urlparse</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">lxml</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.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">,</span> <span class="n">eval_xpath_getindex</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">language_tag</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://wiki.archlinux.org/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q101445877&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;it&#39;</span><span class="p">,</span> <span class="s1">&#39;software wikis&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">main_wiki</span> <span class="o">=</span> <span class="s1">&#39;wiki.archlinux.org&#39;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+
 
+    <span class="n">sxng_lang</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+    <span class="n">netloc</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_lang</span><span class="p">,</span> <span class="n">main_wiki</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">title</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_lang</span><span class="p">,</span> <span class="s1">&#39;Special:Search&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://&#39;</span> <span class="o">+</span> <span class="n">netloc</span> <span class="o">+</span> <span class="s1">&#39;/index.php?&#39;</span>
 
+    <span class="n">offset</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">20</span>
 
+
 
+    <span class="k">if</span> <span class="n">netloc</span> <span class="o">==</span> <span class="n">main_wiki</span><span class="p">:</span>
 
+        <span class="n">eng_lang</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">sxng_lang</span><span class="p">,</span> <span class="s1">&#39;English&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">query</span> <span class="o">+=</span> <span class="s1">&#39; (&#39;</span> <span class="o">+</span> <span class="n">eng_lang</span> <span class="o">+</span> <span class="s1">&#39;)&#39;</span>
 
+    <span class="k">elif</span> <span class="n">netloc</span> <span class="o">==</span> <span class="s1">&#39;wiki.archlinuxcn.org&#39;</span><span class="p">:</span>
 
+        <span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://&#39;</span> <span class="o">+</span> <span class="n">netloc</span> <span class="o">+</span> <span class="s1">&#39;/wzh/index.php?&#39;</span>
 
+
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;search&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+        <span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
 
+        <span class="s1">&#39;offset&#39;</span><span class="p">:</span> <span class="n">offset</span><span class="p">,</span>
 
+        <span class="s1">&#39;profile&#39;</span><span class="p">:</span> <span class="s1">&#39;default&#39;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="c1"># get the base URL for the language in which request was made</span>
 
+    <span class="n">sxng_lang</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">search_params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+    <span class="n">netloc</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_lang</span><span class="p">,</span> <span class="n">main_wiki</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://&#39;</span> <span class="o">+</span> <span class="n">netloc</span> <span class="o">+</span> <span class="s1">&#39;/index.php?&#39;</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//ul[@class=&quot;mw-search-results&quot;]/li&#39;</span><span class="p">):</span>
 
+        <span class="n">link</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[@class=&quot;mw-search-result-heading&quot;]/a&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//div[@class=&quot;searchresult&quot;]&#39;</span><span class="p">))</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">urljoin</span><span class="p">(</span><span class="n">base_url</span><span class="p">,</span> <span class="n">link</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;href&#39;</span><span class="p">)),</span>  <span class="c1"># type: ignore</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">link</span><span class="p">),</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/archlinux.html#searx.engines.archlinux.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages from Archlinux-Wiki.  The location of the Wiki address of a</span>
 
+<span class="sd">    language is mapped in a :py:obj:`custom field</span>
 
+<span class="sd">    &lt;searx.enginelib.traits.EngineTraits.custom&gt;` (``wiki_netloc``).  Depending</span>
 
+<span class="sd">    on the location, the ``title`` argument in the request is translated.</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">       &quot;custom&quot;: {</span>
 
+<span class="sd">         &quot;wiki_netloc&quot;: {</span>
 
+<span class="sd">           &quot;de&quot;: &quot;wiki.archlinux.de&quot;,</span>
 
+<span class="sd">            # ...</span>
 
+<span class="sd">           &quot;zh&quot;: &quot;wiki.archlinuxcn.org&quot;</span>
 
+<span class="sd">         }</span>
 
+<span class="sd">         &quot;title&quot;: {</span>
 
+<span class="sd">           &quot;de&quot;: &quot;Spezial:Suche&quot;,</span>
 
+<span class="sd">            # ...</span>
 
+<span class="sd">           &quot;zh&quot;: &quot;Special:\u641c\u7d22&quot;</span>
 
+<span class="sd">         },</span>
 
+<span class="sd">       },</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=import-outside-toplevel</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</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="n">title_map</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;de&#39;</span><span class="p">:</span> <span class="s1">&#39;Spezial:Suche&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;fa&#39;</span><span class="p">:</span> <span class="s1">&#39;ویژه:جستجو&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;ja&#39;</span><span class="p">:</span> <span class="s1">&#39;特別:検索&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;zh&#39;</span><span class="p">:</span> <span class="s1">&#39;Special:搜索&#39;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://wiki.archlinux.org/&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from wiki.archlinux.org is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//a[@class=&#39;interlanguage-link-target&#39;]&quot;</span><span class="p">):</span>
 
+
 
+        <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</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="n">a</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;lang&#39;</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">))</span>
 
+        <span class="c1"># zh_Hans --&gt; zh</span>
 
+        <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">sxng_tag</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+
 
+        <span class="n">netloc</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">a</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;href&#39;</span><span class="p">))</span><span class="o">.</span><span class="n">netloc</span>
 
+        <span class="k">if</span> <span class="n">netloc</span> <span class="o">!=</span> <span class="s1">&#39;wiki.archlinux.org&#39;</span><span class="p">:</span>
 
+            <span class="n">title</span> <span class="o">=</span> <span class="n">title_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">title</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: title tag from </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">) is unknown&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">netloc</span><span class="p">,</span> <span class="n">sxng_tag</span><span class="p">))</span>
 
+                <span class="k">continue</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">][</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">netloc</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">][</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">title</span>  <span class="c1"># type: ignore</span>
 
+
 
+        <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="s2">&quot;.//span&quot;</span><span class="p">))</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="s1">&#39;en&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;English&#39;</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 391 - 0
_modules/searx/engines/bing.html
View File 

@@ -0,0 +1,391 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.bing &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.bing</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.bing</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This is the implementation of the Bing-WEB engine. Some of this</span>
 
+<span class="sd">implementations are shared by other engines:</span>
 
+
 
+<span class="sd">- :ref:`bing images engine`</span>
 
+<span class="sd">- :ref:`bing news engine`</span>
 
+<span class="sd">- :ref:`bing videos engine`</span>
 
+
 
+<span class="sd">On the `preference page`_ Bing offers a lot of languages an regions (see section</span>
 
+<span class="sd">LANGUAGE and COUNTRY/REGION).  The Language is the language of the UI, we need</span>
 
+<span class="sd">in SearXNG to get the translations of data such as *&quot;published last week&quot;*.</span>
 
+
 
+<span class="sd">There is a description of the official search-APIs_, unfortunately this is not</span>
 
+<span class="sd">the API we can use or that bing itself would use.  You can look up some things</span>
 
+<span class="sd">in the API to get a better picture of bing, but the value specifications like</span>
 
+<span class="sd">the market codes are usually outdated or at least no longer used by bing itself.</span>
 
+
 
+<span class="sd">The market codes have been harmonized and are identical for web, video and</span>
 
+<span class="sd">images.  The news area has also been harmonized with the other categories.  Only</span>
 
+<span class="sd">political adjustments still seem to be made -- for example, there is no news</span>
 
+<span class="sd">category for the Chinese market.</span>
 
+
 
+<span class="sd">.. _preference page: https://www.bing.com/account/general</span>
 
+<span class="sd">.. _search-APIs: https://learn.microsoft.com/en-us/bing/search-apis/</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=too-many-branches, invalid-name</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">base64</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">time</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">parse_qs</span><span class="p">,</span> <span class="n">urlencode</span><span class="p">,</span> <span class="n">urlparse</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.languages</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">eval_xpath</span><span class="p">,</span> <span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">,</span> <span class="n">eval_xpath_getindex</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">language_tag</span><span class="p">,</span> <span class="n">region_tag</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
 
+
 
+    <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.bing.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q182496&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.microsoft.com/en-us/bing/apis/bing-web-search-api&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">200</span>
 
+<span class="sd">&quot;&quot;&quot;200 pages maximum (``&amp;first=1991``)&quot;&quot;&quot;</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="sd">&quot;&quot;&quot;Bing results are always SFW.  To get NSFW links from bing some age</span>
 
+<span class="sd">verification by a cookie is needed / thats not possible in SearXNG.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://www.bing.com/search&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Bing (Web) search URL&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_page_offset</span><span class="p">(</span><span class="n">pageno</span><span class="p">):</span>
 
+    <span class="k">return</span> <span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">pageno</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span> <span class="o">+</span> <span class="mi">1</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">set_bing_cookies</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">engine_language</span><span class="p">,</span> <span class="n">engine_region</span><span class="p">):</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;_EDGE_CD&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;m=</span><span class="si">{</span><span class="n">engine_region</span><span class="si">}</span><span class="s1">&amp;u=</span><span class="si">{</span><span class="n">engine_language</span><span class="si">}</span><span class="s1">&#39;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;_EDGE_S&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;mkt=</span><span class="si">{</span><span class="n">engine_region</span><span class="si">}</span><span class="s1">&amp;ui=</span><span class="si">{</span><span class="n">engine_language</span><span class="si">}</span><span class="s1">&#39;</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;bing cookies: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">])</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Assemble a Bing-Web request.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_region</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">engine_language</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">set_bing_cookies</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">engine_language</span><span class="p">,</span> <span class="n">engine_region</span><span class="p">)</span>
 
+
 
+    <span class="n">page</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="s1">&#39;pageno&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
 
+    <span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="c1"># if arg &#39;pq&#39; is missed, sometimes on page 4 we get results from page 1,</span>
 
+        <span class="c1"># don&#39;t ask why it is only sometimes / its M$ and they have never been</span>
 
+        <span class="c1"># deterministic ;)</span>
 
+        <span class="s1">&#39;pq&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="c1"># To get correct page, arg first and this arg FORM is needed, the value PERE</span>
 
+    <span class="c1"># is on page 2, on page 3 its PERE1 and on page 4 its PERE2 .. and so forth.</span>
 
+    <span class="c1"># The &#39;first&#39; arg should never send on page 1.</span>
 
+
 
+    <span class="k">if</span> <span class="n">page</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;first&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_page_offset</span><span class="p">(</span><span class="n">page</span><span class="p">)</span>  <span class="c1"># see also arg FORM</span>
 
+    <span class="k">if</span> <span class="n">page</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;FORM&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;PERE&#39;</span>
 
+    <span class="k">elif</span> <span class="n">page</span> <span class="o">&gt;</span> <span class="mi">2</span><span class="p">:</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;FORM&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;PERE</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">page</span> <span class="o">-</span> <span class="mi">2</span><span class="p">)</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s1">?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">(</span><span class="n">query_params</span><span class="p">)</span><span class="si">}</span><span class="s1">&#39;</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;time_range&#39;</span><span class="p">):</span>
 
+        <span class="n">unix_day</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">/</span> <span class="mi">86400</span><span class="p">)</span>
 
+        <span class="n">time_ranges</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="s1">&#39;1&#39;</span><span class="p">,</span> <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="s1">&#39;2&#39;</span><span class="p">,</span> <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="s1">&#39;3&#39;</span><span class="p">,</span> <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="sa">f</span><span class="s1">&#39;5_</span><span class="si">{</span><span class="n">unix_day</span><span class="o">-</span><span class="mi">365</span><span class="si">}</span><span class="s1">_</span><span class="si">{</span><span class="n">unix_day</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">}</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="sa">f</span><span class="s1">&#39;&amp;filters=ex1:&quot;ez</span><span class="si">{</span><span class="n">time_ranges</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;time_range&quot;</span><span class="p">]]</span><span class="si">}</span><span class="s1">&quot;&#39;</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="c1"># pylint: disable=too-many-locals</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">result_len</span> <span class="o">=</span> <span class="mi">0</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="c1"># parse results again if nothing is found yet</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//ol[@id=&quot;b_results&quot;]/li[contains(@class, &quot;b_algo&quot;)]&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">link</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//h2/a&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">link</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">link</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;href&#39;</span><span class="p">)</span>
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">link</span><span class="p">)</span>
 
+
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//p&#39;</span><span class="p">)</span>
 
+        <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">content</span><span class="p">:</span>
 
+            <span class="c1"># Make sure that the element is free of:</span>
 
+            <span class="c1">#  &lt;span class=&quot;algoSlug_icon&quot; # data-priority=&quot;2&quot;&gt;Web&lt;/span&gt;</span>
 
+            <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">p</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//span[@class=&quot;algoSlug_icon&quot;]&#39;</span><span class="p">):</span>
 
+                <span class="n">e</span><span class="o">.</span><span class="n">getparent</span><span class="p">()</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
 
+
 
+        <span class="c1"># get the real URL</span>
 
+        <span class="k">if</span> <span class="n">url</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;https://www.bing.com/ck/a?&#39;</span><span class="p">):</span>
 
+            <span class="c1"># get the first value of u parameter</span>
 
+            <span class="n">url_query</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">url</span><span class="p">)</span><span class="o">.</span><span class="n">query</span>
 
+            <span class="n">parsed_url_query</span> <span class="o">=</span> <span class="n">parse_qs</span><span class="p">(</span><span class="n">url_query</span><span class="p">)</span>
 
+            <span class="n">param_u</span> <span class="o">=</span> <span class="n">parsed_url_query</span><span class="p">[</span><span class="s2">&quot;u&quot;</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
 
+            <span class="c1"># remove &quot;a1&quot; in front</span>
 
+            <span class="n">encoded_url</span> <span class="o">=</span> <span class="n">param_u</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span>
 
+            <span class="c1"># add padding</span>
 
+            <span class="n">encoded_url</span> <span class="o">=</span> <span class="n">encoded_url</span> <span class="o">+</span> <span class="s1">&#39;=&#39;</span> <span class="o">*</span> <span class="p">(</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">encoded_url</span><span class="p">)</span> <span class="o">%</span> <span class="mi">4</span><span class="p">)</span>
 
+            <span class="c1"># decode base64 encoded URL</span>
 
+            <span class="n">url</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">urlsafe_b64decode</span><span class="p">(</span><span class="n">encoded_url</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
 
+
 
+        <span class="c1"># append result</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">})</span>
 
+
 
+    <span class="c1"># get number_of_results</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">result_len_container</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//span[@class=&quot;sb_count&quot;]//text()&#39;</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="s2">&quot;-&quot;</span> <span class="ow">in</span> <span class="n">result_len_container</span><span class="p">:</span>
 
+
 
+            <span class="c1"># Remove the part &quot;from-to&quot; for paginated request ...</span>
 
+            <span class="n">result_len_container</span> <span class="o">=</span> <span class="n">result_len_container</span><span class="p">[</span><span class="n">result_len_container</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span> <span class="p">:]</span>
 
+
 
+        <span class="n">result_len_container</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="s1">&#39;[^0-9]&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">result_len_container</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">result_len_container</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 
+            <span class="n">result_len</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">result_len_container</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="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;result error :</span><span class="se">\n</span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">result_len</span> <span class="ow">and</span> <span class="n">_page_offset</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">search_params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;pageno&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span> <span class="o">&gt;</span> <span class="n">result_len</span><span class="p">:</span>
 
+        <span class="c1"># Avoid reading more results than available.</span>
 
+        <span class="c1"># For example, if there is 100 results from some search and we try to get results from 120 to 130,</span>
 
+        <span class="c1"># Bing will send back the results from 0 to 10 and no error.</span>
 
+        <span class="c1"># If we compare results count with the first parameter of the request we can avoid this &quot;invalid&quot; results.</span>
 
+        <span class="k">return</span> <span class="p">[]</span>
 
+
 
+    <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;number_of_results&#39;</span><span class="p">:</span> <span class="n">result_len</span><span class="p">})</span>
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages and regions from Bing-Web.&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=import-outside-toplevel</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</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</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="n">headers</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;User-Agent&quot;</span><span class="p">:</span> <span class="n">gen_useragent</span><span class="p">(),</span>
 
+        <span class="s2">&quot;Accept&quot;</span><span class="p">:</span> <span class="s2">&quot;text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;Accept-Language&quot;</span><span class="p">:</span> <span class="s2">&quot;en-US;q=0.5,en;q=0.3&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;Accept-Encoding&quot;</span><span class="p">:</span> <span class="s2">&quot;gzip, deflate, br&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;DNT&quot;</span><span class="p">:</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;Connection&quot;</span><span class="p">:</span> <span class="s2">&quot;keep-alive&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;Upgrade-Insecure-Requests&quot;</span><span class="p">:</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;Sec-GPC&quot;</span><span class="p">:</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;Cache-Control&quot;</span><span class="p">:</span> <span class="s2">&quot;max-age=0&quot;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s2">&quot;https://www.bing.com/account/general&quot;</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from bing is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="c1"># languages</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="s1">&#39;zh&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;zh-hans&#39;</span>
 
+
 
+    <span class="n">map_lang</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;prs&#39;</span><span class="p">:</span> <span class="s1">&#39;fa-AF&#39;</span><span class="p">,</span> <span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="s1">&#39;en-us&#39;</span><span class="p">}</span>
 
+    <span class="n">bing_ui_lang_map</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="c1"># HINT: this list probably needs to be supplemented</span>
 
+        <span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="s1">&#39;us&#39;</span><span class="p">,</span>  <span class="c1"># en --&gt; en-us</span>
 
+        <span class="s1">&#39;da&#39;</span><span class="p">:</span> <span class="s1">&#39;dk&#39;</span><span class="p">,</span>  <span class="c1"># da --&gt; da-dk</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="k">for</span> <span class="n">href</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[@id=&quot;language-section-content&quot;]//div[@class=&quot;languageItem&quot;]/a/@href&#39;</span><span class="p">):</span>
 
+        <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">parse_qs</span><span class="p">(</span><span class="n">urlparse</span><span class="p">(</span><span class="n">href</span><span class="p">)</span><span class="o">.</span><span class="n">query</span><span class="p">)[</span><span class="s1">&#39;setlang&#39;</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">babel_lang</span> <span class="o">=</span> <span class="n">map_lang</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_lang</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">)</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</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="n">babel_lang</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">,</span> <span class="s1">&#39;_&#39;</span><span class="p">)))</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: language (</span><span class="si">%s</span><span class="s2">) is unknown by babel&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">babel_lang</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="c1"># Language (e.g. &#39;en&#39; or &#39;de&#39;) from https://www.bing.com/account/general</span>
 
+        <span class="c1"># is converted by bing to &#39;en-us&#39; or &#39;de-de&#39;.  But only if there is not</span>
 
+        <span class="c1"># already a &#39;-&#39; delemitter in the language.  For instance &#39;pt-PT&#39; --&gt;</span>
 
+        <span class="c1"># &#39;pt-pt&#39; and &#39;pt-br&#39; --&gt; &#39;pt-br&#39;</span>
 
+        <span class="n">bing_ui_lang</span> <span class="o">=</span> <span class="n">eng_lang</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="s1">&#39;-&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">bing_ui_lang</span><span class="p">:</span>
 
+            <span class="n">bing_ui_lang</span> <span class="o">=</span> <span class="n">bing_ui_lang</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">bing_ui_lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">bing_ui_lang</span><span class="p">,</span> <span class="n">bing_ui_lang</span><span class="p">)</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">bing_ui_lang</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">{</span><span class="n">sxng_tag</span><span class="si">}</span><span class="s2"> --&gt; </span><span class="si">{</span><span class="n">conflict</span><span class="si">}</span><span class="s2">, </span><span class="si">{</span><span class="n">bing_ui_lang</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">bing_ui_lang</span>
 
+
 
+    <span class="c1"># regions (aka &quot;market codes&quot;)</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="s1">&#39;zh-CN&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;zh-cn&#39;</span>
 
+
 
+    <span class="n">map_market_codes</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;zh-hk&#39;</span><span class="p">:</span> <span class="s1">&#39;en-hk&#39;</span><span class="p">,</span>  <span class="c1"># not sure why, but at M$ this is the market code for Hongkong</span>
 
+    <span class="p">}</span>
 
+    <span class="k">for</span> <span class="n">href</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[@id=&quot;region-section-content&quot;]//div[@class=&quot;regionItem&quot;]/a/@href&#39;</span><span class="p">):</span>
 
+        <span class="n">cc_tag</span> <span class="o">=</span> <span class="n">parse_qs</span><span class="p">(</span><span class="n">urlparse</span><span class="p">(</span><span class="n">href</span><span class="p">)</span><span class="o">.</span><span class="n">query</span><span class="p">)[</span><span class="s1">&#39;cc&#39;</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="n">cc_tag</span> <span class="o">==</span> <span class="s1">&#39;clear&#39;</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="n">cc_tag</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="c1"># add market codes from official languages of the country ..</span>
 
+        <span class="k">for</span> <span class="n">lang_tag</span> <span class="ow">in</span> <span class="n">babel</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get_official_languages</span><span class="p">(</span><span class="n">cc_tag</span><span class="p">,</span> <span class="n">de_facto</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+            <span class="k">if</span> <span class="n">lang_tag</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
 
+                <span class="c1"># print(&quot;ignore lang: %s &lt;-- %s&quot; % (cc_tag, lang_tag))</span>
 
+                <span class="k">continue</span>
 
+            <span class="n">lang_tag</span> <span class="o">=</span> <span class="n">lang_tag</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>  <span class="c1"># zh_Hant --&gt; zh</span>
 
+            <span class="n">market_code</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">lang_tag</span><span class="si">}</span><span class="s2">-</span><span class="si">{</span><span class="n">cc_tag</span><span class="si">}</span><span class="s2">&quot;</span>  <span class="c1"># zh-tw</span>
 
+
 
+            <span class="n">market_code</span> <span class="o">=</span> <span class="n">map_market_codes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">market_code</span><span class="p">,</span> <span class="n">market_code</span><span class="p">)</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</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="s1">&#39;</span><span class="si">%s</span><span class="s1">_</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">lang_tag</span><span class="p">,</span> <span class="n">cc_tag</span><span class="o">.</span><span class="n">upper</span><span class="p">())))</span>
 
+            <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+                <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">market_code</span><span class="p">:</span>
 
+                    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">market_code</span><span class="p">))</span>
 
+                    <span class="k">continue</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">market_code</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 223 - 0
_modules/searx/engines/bing_images.html
View File 

@@ -0,0 +1,223 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.bing_images &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.bing_images</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.bing_images</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Bing-Images: description see :py:obj:`searx.engines.bing`.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=invalid-name</span>
 
+
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.bing</span><span class="w"> </span><span class="kn">import</span> <span class="n">set_bing_cookies</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.bing</span><span class="w"> </span><span class="kn">import</span> <span class="n">fetch_traits</span>  <span class="c1"># pylint: disable=unused-import</span>
 
+
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
 
+
 
+    <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.bing.com/images&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q182496&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.microsoft.com/en-us/bing/apis/bing-image-search-api&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;images&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://www.bing.com/images/async&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Bing (Images) search URL&quot;&quot;&quot;</span>
 
+
 
+<span class="n">time_map</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span><span class="p">,</span>
 
+    <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">7</span><span class="p">,</span>
 
+    <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">31</span><span class="p">,</span>
 
+    <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">365</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing_images.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Assemble a Bing-Image request.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_region</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">engine_language</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">set_bing_cookies</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">engine_language</span><span class="p">,</span> <span class="n">engine_region</span><span class="p">)</span>
 
+
 
+    <span class="c1"># build URL query</span>
 
+    <span class="c1"># - example: https://www.bing.com/images/async?q=foo&amp;async=content&amp;first=1&amp;count=35</span>
 
+    <span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;async&#39;</span><span class="p">:</span> <span class="s1">&#39;1&#39;</span><span class="p">,</span>
 
+        <span class="c1"># to simplify the page count lets use the default of 35 images per page</span>
 
+        <span class="s1">&#39;first&#39;</span><span class="p">:</span> <span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;pageno&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">35</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span>
 
+        <span class="s1">&#39;count&#39;</span><span class="p">:</span> <span class="mi">35</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="c1"># time range</span>
 
+    <span class="c1"># - example: one year (525600 minutes) &#39;qft=+filterui:age-lt525600&#39;</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]:</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;qft&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;filterui:age-lt</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">time_map</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;?&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">query_params</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing_images.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get response from Bing-Images&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//ul[contains(@class, &quot;dgControl_list&quot;)]/li&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">metadata</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//a[@class=&quot;iusc&quot;]/@m&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">metadata</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">metadata</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//a[@class=&quot;iusc&quot;]/@m&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
 
+        <span class="n">title</span> <span class="o">=</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//div[@class=&quot;infnmpt&quot;]//a/text()&#39;</span><span class="p">))</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+        <span class="n">img_format</span> <span class="o">=</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//div[@class=&quot;imgpt&quot;]/div/span/text()&#39;</span><span class="p">))</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot; · &quot;</span><span class="p">)</span>
 
+        <span class="n">source</span> <span class="o">=</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//div[@class=&quot;imgpt&quot;]//div[@class=&quot;lnkw&quot;]//a/text()&#39;</span><span class="p">))</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;images.html&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;purl&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;thumbnail_src&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;turl&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;murl&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;desc&#39;</span><span class="p">),</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                <span class="s1">&#39;source&#39;</span><span class="p">:</span> <span class="n">source</span><span class="p">,</span>
 
+                <span class="s1">&#39;resolution&#39;</span><span class="p">:</span> <span class="n">img_format</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
 
+                <span class="s1">&#39;img_format&#39;</span><span class="p">:</span> <span class="n">img_format</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">img_format</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">2</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 277 - 0
_modules/searx/engines/bing_news.html
View File 

@@ -0,0 +1,277 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.bing_news &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.bing_news</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.bing_news</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Bing-News: description see :py:obj:`searx.engines.bing`.</span>
 
+
 
+<span class="sd">.. hint::</span>
 
+
 
+<span class="sd">   Bing News is *different* in some ways!</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="c1"># pylint: disable=invalid-name</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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">eval_xpath</span><span class="p">,</span> <span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">,</span> <span class="n">eval_xpath_getindex</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.bing</span><span class="w"> </span><span class="kn">import</span> <span class="n">set_bing_cookies</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.bing.com/news&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q2878637&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.microsoft.com/en-us/bing/apis/bing-news-search-api&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;RSS&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;news&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="sd">&quot;&quot;&quot;If go through the pages and there are actually no new results for another</span>
 
+<span class="sd">page, then bing returns the results from the last page again.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_map</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="s1">&#39;interval=&quot;4&quot;&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="s1">&#39;interval=&quot;7&quot;&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="s1">&#39;interval=&quot;9&quot;&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="sd">&quot;&quot;&quot;A string &#39;4&#39; means *last hour*.  We use *last hour* for ``day`` here since the</span>
 
+<span class="sd">difference of *last day* and *last week* in the result list is just marginally.</span>
 
+<span class="sd">Bing does not have news range ``year`` / we use ``month`` instead.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://www.bing.com/news/infinitescrollajax&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Bing (News) search URL&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing_news.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Assemble a Bing-News request.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_region</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">engine_language</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">set_bing_cookies</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">engine_language</span><span class="p">,</span> <span class="n">engine_region</span><span class="p">)</span>
 
+
 
+    <span class="c1"># build URL query</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># example: https://www.bing.com/news/infinitescrollajax?q=london&amp;first=1</span>
 
+
 
+    <span class="n">page</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;pageno&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span> <span class="o">-</span> <span class="mi">1</span>
 
+    <span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;InfiniteScroll&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
 
+        <span class="c1"># to simplify the page count lets use the default of 10 images per page</span>
 
+        <span class="s1">&#39;first&#39;</span><span class="p">:</span> <span class="n">page</span> <span class="o">*</span> <span class="mi">10</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span>
 
+        <span class="s1">&#39;SFX&#39;</span><span class="p">:</span> <span class="n">page</span><span class="p">,</span>
 
+        <span class="s1">&#39;form&#39;</span><span class="p">:</span> <span class="s1">&#39;PTFTNR&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;setlang&#39;</span><span class="p">:</span> <span class="n">engine_region</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
 
+        <span class="s1">&#39;cc&#39;</span><span class="p">:</span> <span class="n">engine_region</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]:</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;qft&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">],</span> <span class="s1">&#39;interval=&quot;9&quot;&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;?&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">query_params</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing_news.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get response from Bing-Video&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">results</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">newsitem</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[contains(@class, &quot;newsitem&quot;)]&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">link</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">newsitem</span><span class="p">,</span> <span class="s1">&#39;.//a[@class=&quot;title&quot;]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">link</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">link</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;href&#39;</span><span class="p">)</span>
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">link</span><span class="p">)</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">newsitem</span><span class="p">,</span> <span class="s1">&#39;.//div[@class=&quot;snippet&quot;]&#39;</span><span class="p">))</span>
 
+
 
+        <span class="n">metadata</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="n">source</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">newsitem</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;source&quot;)]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">source</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="p">(</span>
 
+                <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="s1">&#39;.//span[@aria-label]/@aria-label&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>
 
+                <span class="c1"># eval_xpath_getindex(source, &#39;.//a&#39;, 0, None),</span>
 
+                <span class="c1"># eval_xpath_getindex(source, &#39;./div/span&#39;, 3, None),</span>
 
+                <span class="n">link</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;data-author&#39;</span><span class="p">),</span>
 
+            <span class="p">):</span>
 
+                <span class="k">if</span> <span class="n">item</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                    <span class="n">t</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+                    <span class="k">if</span> <span class="n">t</span> <span class="ow">and</span> <span class="n">t</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
 
+                        <span class="n">metadata</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
 
+        <span class="n">metadata</span> <span class="o">=</span> <span class="s1">&#39; | &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">metadata</span><span class="p">)</span>
 
+
 
+        <span class="n">thumbnail</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="n">imagelink</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">newsitem</span><span class="p">,</span> <span class="s1">&#39;.//a[@class=&quot;imagelink&quot;]//img&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">imagelink</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">imagelink</span><span class="o">.</span><span class="n">attrib</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;src&#39;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">thumbnail</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;https://www.bing.com&quot;</span><span class="p">):</span>
 
+                <span class="n">thumbnail</span> <span class="o">=</span> <span class="s1">&#39;https://www.bing.com/&#39;</span> <span class="o">+</span> <span class="n">thumbnail</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+                <span class="s1">&#39;metadata&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing_news.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages and regions from Bing-News.&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=import-outside-toplevel</span>
 
+
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.bing</span><span class="w"> </span><span class="kn">import</span> <span class="n">fetch_traits</span> <span class="k">as</span> <span class="n">_f</span>
 
+
 
+    <span class="n">_f</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">)</span>
 
+
 
+    <span class="c1"># fix market codes not known by bing news:</span>
 
+
 
+    <span class="c1"># In bing the market code &#39;zh-cn&#39; exists, but there is no &#39;news&#39; category in</span>
 
+    <span class="c1"># bing for this market.  Alternatively we use the the market code from Honk</span>
 
+    <span class="c1"># Kong.  Even if this is not correct, it is better than having no hits at</span>
 
+    <span class="c1"># all, or sending false queries to bing that could raise the suspicion of a</span>
 
+    <span class="c1"># bot.</span>
 
+
 
+    <span class="c1"># HINT: &#39;en-hk&#39; is the region code it does not indicate the language en!!</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="s1">&#39;zh-CN&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;en-hk&#39;</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 212 - 0
_modules/searx/engines/bing_videos.html
View File 

@@ -0,0 +1,212 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.bing_videos &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.bing_videos</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.bing_videos</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="c1"># pylint: disable=invalid-name</span>
 
+<span class="sd">&quot;&quot;&quot;Bing-Videos: description see :py:obj:`searx.engines.bing`.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.bing</span><span class="w"> </span><span class="kn">import</span> <span class="n">set_bing_cookies</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.bing</span><span class="w"> </span><span class="kn">import</span> <span class="n">fetch_traits</span>  <span class="c1"># pylint: disable=unused-import</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.bing_images</span><span class="w"> </span><span class="kn">import</span> <span class="n">time_map</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.bing.com/videos&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q4914152&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.microsoft.com/en-us/bing/apis/bing-video-search-api&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;videos&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://www.bing.com/videos/asyncv2&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Bing (Videos) async search URL.&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing_videos.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Assemble a Bing-Video request.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_region</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">engine_language</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">set_bing_cookies</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">engine_language</span><span class="p">,</span> <span class="n">engine_region</span><span class="p">)</span>
 
+
 
+    <span class="c1"># build URL query</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># example: https://www.bing.com/videos/asyncv2?q=foo&amp;async=content&amp;first=1&amp;count=35</span>
 
+
 
+    <span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;async&#39;</span><span class="p">:</span> <span class="s1">&#39;content&#39;</span><span class="p">,</span>
 
+        <span class="c1"># to simplify the page count lets use the default of 35 images per page</span>
 
+        <span class="s1">&#39;first&#39;</span><span class="p">:</span> <span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;pageno&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">35</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span>
 
+        <span class="s1">&#39;count&#39;</span><span class="p">:</span> <span class="mi">35</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="c1"># time range</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># example: one week (10080 minutes) &#39;&amp;qft= filterui:videoage-lt10080&#39;  &#39;&amp;form=VRFLTR&#39;</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]:</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;form&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;VRFLTR&#39;</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;qft&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39; filterui:videoage-lt</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">time_map</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;?&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">query_params</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/bing.html#searx.engines.bing_videos.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get response from Bing-Video&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//div[@class=&quot;dg_u&quot;]//div[contains(@id, &quot;mc_vtvc_video&quot;)]&#39;</span><span class="p">):</span>
 
+        <span class="n">metadata</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//div[@class=&quot;vrhdata&quot;]/@vrhm&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
 
+        <span class="n">info</span> <span class="o">=</span> <span class="s1">&#39; - &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//div[@class=&quot;mc_vtvc_meta_block&quot;]//span/text()&#39;</span><span class="p">))</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">{0}</span><span class="s1"> - </span><span class="si">{1}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;du&#39;</span><span class="p">],</span> <span class="n">info</span><span class="p">)</span>
 
+        <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//div[contains(@class, &quot;mc_vtvc_th&quot;)]//img/@src&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;murl&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">metadata</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;vt&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;videos.html&#39;</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 616 - 0
_modules/searx/engines/brave.html
View File 

@@ -0,0 +1,616 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.brave &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.brave</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.brave</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Brave supports the categories listed in :py:obj:`brave_category` (General,</span>
 
+<span class="sd">news, videos, images).  The support of :py:obj:`paging` and :py:obj:`time range</span>
 
+<span class="sd">&lt;time_range_support&gt;` is limited (see remarks).</span>
 
+
 
+<span class="sd">Configured ``brave`` engines:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: brave</span>
 
+<span class="sd">    engine: brave</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">    brave_category: search</span>
 
+<span class="sd">    time_range_support: true</span>
 
+<span class="sd">    paging: true</span>
 
+
 
+<span class="sd">  - name: brave.images</span>
 
+<span class="sd">    engine: brave</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">    brave_category: images</span>
 
+
 
+<span class="sd">  - name: brave.videos</span>
 
+<span class="sd">    engine: brave</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">    brave_category: videos</span>
 
+
 
+<span class="sd">  - name: brave.news</span>
 
+<span class="sd">    engine: brave</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">    brave_category: news</span>
 
+
 
+<span class="sd">  - name: brave.goggles</span>
 
+<span class="sd">    time_range_support: true</span>
 
+<span class="sd">    paging: true</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">    brave_category: goggles</span>
 
+
 
+
 
+<span class="sd">.. _brave regions:</span>
 
+
 
+<span class="sd">Brave regions</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">Brave uses two-digit tags for the regions like ``ca`` while SearXNG deals with</span>
 
+<span class="sd">locales.  To get a mapping, all *officiat de-facto* languages of the Brave</span>
 
+<span class="sd">region are mapped to regions in SearXNG (see :py:obj:`babel</span>
 
+<span class="sd">&lt;babel.languages.get_official_languages&gt;`):</span>
 
+
 
+<span class="sd">.. code:: python</span>
 
+
 
+<span class="sd">    &quot;regions&quot;: {</span>
 
+<span class="sd">      ..</span>
 
+<span class="sd">      &quot;en-CA&quot;: &quot;ca&quot;,</span>
 
+<span class="sd">      &quot;fr-CA&quot;: &quot;ca&quot;,</span>
 
+<span class="sd">      ..</span>
 
+<span class="sd">     }</span>
 
+
 
+
 
+<span class="sd">.. note::</span>
 
+
 
+<span class="sd">   The language (aka region) support of Brave&#39;s index is limited to very basic</span>
 
+<span class="sd">   languages.  The search results for languages like Chinese or Arabic are of</span>
 
+<span class="sd">   low quality.</span>
 
+
 
+
 
+<span class="sd">.. _brave googles:</span>
 
+
 
+<span class="sd">Brave Goggles</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">.. _list of Goggles: https://search.brave.com/goggles/discover</span>
 
+<span class="sd">.. _Goggles Whitepaper: https://brave.com/static-assets/files/goggles.pdf</span>
 
+<span class="sd">.. _Goggles Quickstart: https://github.com/brave/goggles-quickstart</span>
 
+
 
+<span class="sd">Goggles allow you to choose, alter, or extend the ranking of Brave Search</span>
 
+<span class="sd">results (`Goggles Whitepaper`_).  Goggles are openly developed by the community</span>
 
+<span class="sd">of Brave Search users.</span>
 
+
 
+<span class="sd">Select from the `list of Goggles`_ people have published, or create your own</span>
 
+<span class="sd">(`Goggles Quickstart`_).</span>
 
+
 
+
 
+<span class="sd">.. _brave languages:</span>
 
+
 
+<span class="sd">Brave languages</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">Brave&#39;s language support is limited to the UI (menus, area local notations,</span>
 
+<span class="sd">etc).  Brave&#39;s index only seems to support a locale, but it does not seem to</span>
 
+<span class="sd">support any languages in its index.  The choice of available languages is very</span>
 
+<span class="sd">small (and its not clear to me where the difference in UI is when switching</span>
 
+<span class="sd">from en-us to en-ca or en-gb).</span>
 
+
 
+<span class="sd">In the :py:obj:`EngineTraits object &lt;searx.enginelib.traits.EngineTraits&gt;` the</span>
 
+<span class="sd">UI languages are stored in a custom field named ``ui_lang``:</span>
 
+
 
+<span class="sd">.. code:: python</span>
 
+
 
+<span class="sd">    &quot;custom&quot;: {</span>
 
+<span class="sd">      &quot;ui_lang&quot;: {</span>
 
+<span class="sd">        &quot;ca&quot;: &quot;ca&quot;,</span>
 
+<span class="sd">        &quot;de-DE&quot;: &quot;de-de&quot;,</span>
 
+<span class="sd">        &quot;en-CA&quot;: &quot;en-ca&quot;,</span>
 
+<span class="sd">        &quot;en-GB&quot;: &quot;en-gb&quot;,</span>
 
+<span class="sd">        &quot;en-US&quot;: &quot;en-us&quot;,</span>
 
+<span class="sd">        &quot;es&quot;: &quot;es&quot;,</span>
 
+<span class="sd">        &quot;fr-CA&quot;: &quot;fr-ca&quot;,</span>
 
+<span class="sd">        &quot;fr-FR&quot;: &quot;fr-fr&quot;,</span>
 
+<span class="sd">        &quot;ja-JP&quot;: &quot;ja-jp&quot;,</span>
 
+<span class="sd">        &quot;pt-BR&quot;: &quot;pt-br&quot;,</span>
 
+<span class="sd">        &quot;sq-AL&quot;: &quot;sq-al&quot;</span>
 
+<span class="sd">      }</span>
 
+<span class="sd">    },</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">urlencode</span><span class="p">,</span>
 
+    <span class="n">urlparse</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">dateutil</span><span class="w"> </span><span class="kn">import</span> <span class="n">parser</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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">locales</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="p">(</span>
 
+    <span class="n">extr</span><span class="p">,</span>
 
+    <span class="n">extract_text</span><span class="p">,</span>
 
+    <span class="n">eval_xpath</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_list</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_getindex</span><span class="p">,</span>
 
+    <span class="n">js_variable_to_python</span><span class="p">,</span>
 
+    <span class="n">get_embeded_stream_url</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</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">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://search.brave.com/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q22906900&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s2">&quot;https://search.brave.com/&quot;</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="n">brave_category</span> <span class="o">=</span> <span class="s1">&#39;search&#39;</span>
 
+<span class="n">Goggles</span> <span class="o">=</span> <span class="n">Any</span>
 
+<span class="sd">&quot;&quot;&quot;Brave supports common web-search, videos, images, news, and goggles search.</span>
 
+
 
+<span class="sd">- ``search``: Common WEB search</span>
 
+<span class="sd">- ``videos``: search for videos</span>
 
+<span class="sd">- ``images``: search for images</span>
 
+<span class="sd">- ``news``: search for news</span>
 
+<span class="sd">- ``goggles``: Common WEB search with custom rules</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">brave_spellcheck</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="sd">&quot;&quot;&quot;Brave supports some kind of spell checking.  When activated, Brave tries to</span>
 
+<span class="sd">fix typos, e.g. it searches for ``food`` when the user queries for ``fooh``.  In</span>
 
+<span class="sd">the UI of Brave the user gets warned about this, since we can not warn the user</span>
 
+<span class="sd">in SearXNG, the spellchecking is disabled by default.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="sd">&quot;&quot;&quot;Brave only supports paging in :py:obj:`brave_category` ``search`` (UI</span>
 
+<span class="sd">category All) and in the goggles category.&quot;&quot;&quot;</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">10</span>
 
+<span class="sd">&quot;&quot;&quot;Tested 9 pages maximum (``&amp;offset=8``), to be save max is set to 10.  Trying</span>
 
+<span class="sd">to do more won&#39;t return any result and you will most likely be flagged as a bot.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch_map</span> <span class="o">=</span> <span class="p">{</span><span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;strict&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;moderate&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;off&#39;</span><span class="p">}</span>  <span class="c1"># cookie: safesearch=off</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="sd">&quot;&quot;&quot;Brave only supports time-range in :py:obj:`brave_category` ``search`` (UI</span>
 
+<span class="sd">category All) and in the goggles category.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">time_range_map</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="s1">&#39;pd&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="s1">&#39;pw&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="s1">&#39;pm&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="s1">&#39;py&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+
 
+    <span class="c1"># Don&#39;t accept br encoding / see https://github.com/searxng/searxng/pull/1787</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Accept-Encoding&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;gzip, deflate&#39;</span>
 
+
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;source&#39;</span><span class="p">:</span> <span class="s1">&#39;web&#39;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+    <span class="k">if</span> <span class="n">brave_spellcheck</span><span class="p">:</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;spellcheck&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;1&#39;</span>
 
+
 
+    <span class="k">if</span> <span class="n">brave_category</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;search&#39;</span><span class="p">,</span> <span class="s1">&#39;goggles&#39;</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;pageno&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="n">args</span><span class="p">[</span><span class="s1">&#39;offset&#39;</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="s1">&#39;pageno&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span>
 
+        <span class="k">if</span> <span class="n">time_range_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]):</span>
 
+            <span class="n">args</span><span class="p">[</span><span class="s1">&#39;tf&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_range_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">])</span>
 
+
 
+    <span class="k">if</span> <span class="n">brave_category</span> <span class="o">==</span> <span class="s1">&#39;goggles&#39;</span><span class="p">:</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;goggles_id&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">Goggles</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">base_url</span><span class="si">}{</span><span class="n">brave_category</span><span class="si">}</span><span class="s2">?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+    <span class="c1"># set properties in the cookies</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">safesearch_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">],</span> <span class="s1">&#39;off&#39;</span><span class="p">)</span>
 
+    <span class="c1"># the useLocation is IP based, we use cookie &#39;country&#39; for the region</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;useLocation&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;0&#39;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;summarizer&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;0&#39;</span>
 
+
 
+    <span class="n">engine_region</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;all&#39;</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;country&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine_region</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="n">ui_lang</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">get_engine_locale</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;ui_lang&quot;</span><span class="p">],</span> <span class="s1">&#39;en-us&#39;</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;ui_lang&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ui_lang</span>
 
+
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;cookies </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">])</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Sec-Fetch-Dest&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;document&quot;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Sec-Fetch-Mode&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;navigate&quot;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Sec-Fetch-Site&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;same-origin&quot;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Sec-Fetch-User&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;?1&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_extract_published_date</span><span class="p">(</span><span class="n">published_date_raw</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="n">published_date_raw</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="k">try</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">published_date_raw</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="n">parser</span><span class="o">.</span><span class="n">ParserError</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+
 
+    <span class="k">if</span> <span class="n">brave_category</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;search&#39;</span><span class="p">,</span> <span class="s1">&#39;goggles&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">_parse_search</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">brave_category</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;news&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">_parse_news</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+    <span class="c1"># Example script source containing the data:</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># kit.start(app, element, {</span>
 
+    <span class="c1">#    node_ids: [0, 19],</span>
 
+    <span class="c1">#    data: [{type:&quot;data&quot;,data: .... [&quot;q&quot;,&quot;goggles_id&quot;],route:1,url:1}}]</span>
 
+    <span class="c1">#          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^</span>
 
+    <span class="n">js_object</span> <span class="o">=</span> <span class="s2">&quot;[{&quot;</span> <span class="o">+</span> <span class="n">extr</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="s2">&quot;data: [{&quot;</span><span class="p">,</span> <span class="s2">&quot;}}],&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;}}]&quot;</span>
 
+    <span class="n">json_data</span> <span class="o">=</span> <span class="n">js_variable_to_python</span><span class="p">(</span><span class="n">js_object</span><span class="p">)</span>
 
+
 
+    <span class="c1"># json_data is a list and at the second position (0,1) in this list we find the &quot;response&quot; data we need ..</span>
 
+    <span class="n">json_resp</span> <span class="o">=</span> <span class="n">json_data</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;body&#39;</span><span class="p">][</span><span class="s1">&#39;response&#39;</span><span class="p">]</span>
 
+
 
+    <span class="k">if</span> <span class="n">brave_category</span> <span class="o">==</span> <span class="s1">&#39;images&#39;</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">_parse_images</span><span class="p">(</span><span class="n">json_resp</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">brave_category</span> <span class="o">==</span> <span class="s1">&#39;videos&#39;</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">_parse_videos</span><span class="p">(</span><span class="n">json_resp</span><span class="p">)</span>
 
+
 
+    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unsupported brave category: </span><span class="si">{</span><span class="n">brave_category</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_parse_search</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+    <span class="n">result_list</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="c1"># I doubt that Brave is still providing the &quot;answer&quot; class / I haven&#39;t seen</span>
 
+    <span class="c1"># answers in brave for a long time.</span>
 
+    <span class="n">answer_tag</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[@class=&quot;answer&quot;]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">answer_tag</span><span class="p">:</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[@id=&quot;featured_snippet&quot;]/a[@class=&quot;result-header&quot;]/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
+        <span class="n">answer</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">answer_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">answer</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">result_list</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">result_list</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="n">answer</span><span class="p">,</span> <span class="n">url</span><span class="o">=</span><span class="n">url</span><span class="p">))</span>
 
+
 
+    <span class="c1"># xpath_results = &#39;//div[contains(@class, &quot;snippet fdb&quot;) and @data-type=&quot;web&quot;]&#39;</span>
 
+    <span class="n">xpath_results</span> <span class="o">=</span> <span class="s1">&#39;//div[contains(@class, &quot;snippet &quot;)]&#39;</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">xpath_results</span><span class="p">):</span>
 
+
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//a[contains(@class, &quot;h&quot;)]/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
+        <span class="n">title_tag</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span>
 
+            <span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//a[contains(@class, &quot;h&quot;)]//div[contains(@class, &quot;title&quot;)]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span>
 
+        <span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">url</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">title_tag</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">url</span><span class="p">)</span><span class="o">.</span><span class="n">netloc</span><span class="p">:</span>  <span class="c1"># partial url likely means it&#39;s an ad</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">content</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span>
 
+            <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;snippet-description&quot;)]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+        <span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">pub_date_raw</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;substring-before(.//div[contains(@class, &quot;snippet-description&quot;)], &quot;-&quot;)&#39;</span><span class="p">)</span>
 
+        <span class="n">pub_date</span> <span class="o">=</span> <span class="n">_extract_published_date</span><span class="p">(</span><span class="n">pub_date_raw</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">pub_date</span> <span class="ow">and</span> <span class="n">content</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">pub_date_raw</span><span class="p">):</span>
 
+            <span class="n">content</span> <span class="o">=</span> <span class="n">content</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="n">pub_date_raw</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">&quot;- </span><span class="se">\n\t</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+        <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//img[contains(@class, &quot;thumb&quot;)]/@src&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+
 
+        <span class="n">item</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+            <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">title_tag</span><span class="p">),</span>
 
+            <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+            <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">pub_date</span><span class="p">,</span>
 
+            <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+
 
+        <span class="n">video_tag</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span>
 
+            <span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;video-snippet&quot;) and @data-macro=&quot;video&quot;]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span>
 
+        <span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">video_tag</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+
 
+            <span class="c1"># In my tests a video tag in the WEB search was most often not a</span>
 
+            <span class="c1"># video, except the ones from youtube ..</span>
 
+
 
+            <span class="n">iframe_src</span> <span class="o">=</span> <span class="n">get_embeded_stream_url</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">iframe_src</span><span class="p">:</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;iframe_src&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">iframe_src</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;template&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;videos.html&#39;</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">video_tag</span><span class="p">,</span> <span class="s1">&#39;.//img/@src&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+                <span class="n">pub_date_raw</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span>
 
+                    <span class="n">eval_xpath</span><span class="p">(</span><span class="n">video_tag</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;snippet-attributes&quot;)]/div/text()&#39;</span><span class="p">)</span>
 
+                <span class="p">)</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;publishedDate&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_extract_published_date</span><span class="p">(</span><span class="n">pub_date_raw</span><span class="p">)</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">video_tag</span><span class="p">,</span> <span class="s1">&#39;.//img/@src&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+
 
+        <span class="n">result_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">result_list</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_parse_news</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+
 
+    <span class="n">result_list</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[contains(@class, &quot;results&quot;)]//div[@data-type=&quot;news&quot;]&#39;</span><span class="p">):</span>
 
+
 
+        <span class="c1"># import pdb</span>
 
+        <span class="c1"># pdb.set_trace()</span>
 
+
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//a[contains(@class, &quot;result-header&quot;)]/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">url</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//span[contains(@class, &quot;snippet-title&quot;)]&#39;</span><span class="p">))</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//p[contains(@class, &quot;desc&quot;)]&#39;</span><span class="p">))</span>
 
+        <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;image-wrapper&quot;)]//img/@src&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+
 
+        <span class="n">item</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+            <span class="s2">&quot;title&quot;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+            <span class="s2">&quot;content&quot;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+            <span class="s2">&quot;thumbnail&quot;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+
 
+        <span class="n">result_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">result_list</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_parse_images</span><span class="p">(</span><span class="n">json_resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+    <span class="n">result_list</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">json_resp</span><span class="p">[</span><span class="s2">&quot;results&quot;</span><span class="p">]:</span>
 
+        <span class="n">item</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;description&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;images.html&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;resolution&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;properties&#39;</span><span class="p">][</span><span class="s1">&#39;format&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;source&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;source&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;properties&#39;</span><span class="p">][</span><span class="s1">&#39;url&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;thumbnail_src&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">][</span><span class="s1">&#39;src&#39;</span><span class="p">],</span>
 
+        <span class="p">}</span>
 
+        <span class="n">result_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">result_list</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_parse_videos</span><span class="p">(</span><span class="n">json_resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+    <span class="n">result_list</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">json_resp</span><span class="p">[</span><span class="s2">&quot;results&quot;</span><span class="p">]:</span>
 
+
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span>
 
+        <span class="n">item</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+            <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;description&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;videos.html&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;length&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;video&#39;</span><span class="p">][</span><span class="s1">&#39;duration&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;duration&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;video&#39;</span><span class="p">][</span><span class="s1">&#39;duration&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">_extract_published_date</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;age&#39;</span><span class="p">]),</span>
 
+        <span class="p">}</span>
 
+
 
+        <span class="k">if</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">item</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">][</span><span class="s1">&#39;src&#39;</span><span class="p">]</span>
 
+
 
+        <span class="n">iframe_src</span> <span class="o">=</span> <span class="n">get_embeded_stream_url</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">iframe_src</span><span class="p">:</span>
 
+            <span class="n">item</span><span class="p">[</span><span class="s1">&#39;iframe_src&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">iframe_src</span>
 
+
 
+        <span class="n">result_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">result_list</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/brave.html#searx.engines.brave.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch :ref:`languages &lt;brave languages&gt;` and :ref:`regions &lt;brave</span>
 
+<span class="sd">    regions&gt;` from Brave.&quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># pylint: disable=import-outside-toplevel, too-many-branches</span>
 
+
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">babel.languages</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">region_tag</span><span class="p">,</span> <span class="n">language_tag</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</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;ui_lang&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;Accept-Encoding&#39;</span><span class="p">:</span> <span class="s1">&#39;gzip, deflate&#39;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+    <span class="n">lang_map</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;no&#39;</span><span class="p">:</span> <span class="s1">&#39;nb&#39;</span><span class="p">}</span>  <span class="c1"># norway</span>
 
+
 
+    <span class="c1"># languages (UI)</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://search.brave.com/settings&#39;</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from Brave is not OK.&quot;</span><span class="p">)</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//section//option[@value=&quot;en-us&quot;]/../option&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">ui_lang</span> <span class="o">=</span> <span class="n">option</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;value&#39;</span><span class="p">)</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">l</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="n">ui_lang</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">l</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
 
+                <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</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="n">ui_lang</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">))</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</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="n">ui_lang</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">))</span>
 
+
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: can&#39;t determine babel locale of Brave&#39;s (UI) language </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">ui_lang</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;ui_lang&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">ui_lang</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">ui_lang</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;ui_lang&quot;</span><span class="p">][</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">ui_lang</span>
 
+
 
+    <span class="c1"># search regions of brave</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://cdn.search.brave.com/serp/v2/_app/immutable/chunks/parameters.734c106a.js&#39;</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from Brave is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">country_js</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">[</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s2">&quot;options:{all&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="s1">&#39;options:&#39;</span><span class="p">)</span> <span class="p">:]</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">country_js</span> <span class="o">=</span> <span class="n">country_js</span><span class="p">[:</span> <span class="n">country_js</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s2">&quot;},k={default&quot;</span><span class="p">)]</span>
 
+    <span class="n">country_tags</span> <span class="o">=</span> <span class="n">js_variable_to_python</span><span class="p">(</span><span class="n">country_js</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">country_tags</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="s1">&#39;all&#39;</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="s1">&#39;all&#39;</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">country_tag</span> <span class="o">=</span> <span class="n">v</span><span class="p">[</span><span class="s1">&#39;value&#39;</span><span class="p">]</span>
 
+
 
+        <span class="c1"># add official languages of the country ..</span>
 
+        <span class="k">for</span> <span class="n">lang_tag</span> <span class="ow">in</span> <span class="n">babel</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get_official_languages</span><span class="p">(</span><span class="n">country_tag</span><span class="p">,</span> <span class="n">de_facto</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+            <span class="n">lang_tag</span> <span class="o">=</span> <span class="n">lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">lang_tag</span><span class="p">,</span> <span class="n">lang_tag</span><span class="p">)</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</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="s1">&#39;</span><span class="si">%s</span><span class="s1">_</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">lang_tag</span><span class="p">,</span> <span class="n">country_tag</span><span class="o">.</span><span class="n">upper</span><span class="p">())))</span>
 
+            <span class="c1"># print(&quot;%-20s: %s &lt;-- %s&quot; % (v[&#39;label&#39;], country_tag, sxng_tag))</span>
 
+
 
+            <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+                <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">country_tag</span><span class="p">:</span>
 
+                    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">country_tag</span><span class="p">))</span>
 
+                    <span class="k">continue</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">country_tag</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 354 - 0
_modules/searx/engines/command.html
View File 

@@ -0,0 +1,354 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.command &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.command</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.command</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;With *command engines* administrators can run engines to integrate arbitrary</span>
 
+<span class="sd">shell commands.</span>
 
+
 
+<span class="sd">.. attention::</span>
 
+
 
+<span class="sd">   When creating and enabling a ``command`` engine on a public instance, you</span>
 
+<span class="sd">   must be careful to avoid leaking private data.</span>
 
+
 
+<span class="sd">The easiest solution is to limit the access by setting ``tokens`` as described</span>
 
+<span class="sd">in section :ref:`private engines`.  The engine base is flexible.  Only your</span>
 
+<span class="sd">imagination can limit the power of this engine (and maybe security concerns).</span>
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">The following options are available:</span>
 
+
 
+<span class="sd">``command``:</span>
 
+<span class="sd">  A comma separated list of the elements of the command.  A special token</span>
 
+<span class="sd">  ``{{QUERY}}`` tells where to put the search terms of the user. Example:</span>
 
+
 
+<span class="sd">  .. code:: yaml</span>
 
+
 
+<span class="sd">     [&#39;ls&#39;, &#39;-l&#39;, &#39;-h&#39;, &#39;{{QUERY}}&#39;]</span>
 
+
 
+<span class="sd">``delimiter``:</span>
 
+<span class="sd">  A mapping containing a delimiter ``char`` and the *titles* of each element in</span>
 
+<span class="sd">  ``keys``.</span>
 
+
 
+<span class="sd">``parse_regex``:</span>
 
+<span class="sd">  A dict containing the regular expressions for each result key.</span>
 
+
 
+<span class="sd">``query_type``:</span>
 
+
 
+<span class="sd">  The expected type of user search terms.  Possible values: ``path`` and</span>
 
+<span class="sd">  ``enum``.</span>
 
+
 
+<span class="sd">  ``path``:</span>
 
+<span class="sd">    Checks if the user provided path is inside the working directory.  If not,</span>
 
+<span class="sd">    the query is not executed.</span>
 
+
 
+<span class="sd">  ``enum``:</span>
 
+<span class="sd">    Is a list of allowed search terms.  If the user submits something which is</span>
 
+<span class="sd">    not included in the list, the query returns an error.</span>
 
+
 
+<span class="sd">``query_enum``:</span>
 
+<span class="sd">  A list containing allowed search terms if ``query_type`` is set to ``enum``.</span>
 
+
 
+<span class="sd">``working_dir``:</span>
 
+<span class="sd">  The directory where the command has to be executed.  Default: ``./``.</span>
 
+
 
+<span class="sd">``result_separator``:</span>
 
+<span class="sd">  The character that separates results. Default: ``\\n``.</span>
 
+
 
+<span class="sd">Example</span>
 
+<span class="sd">=======</span>
 
+
 
+<span class="sd">The example engine below can be used to find files with a specific name in the</span>
 
+<span class="sd">configured working directory:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: find</span>
 
+<span class="sd">    engine: command</span>
 
+<span class="sd">    command: [&#39;find&#39;, &#39;.&#39;, &#39;-name&#39;, &#39;{{QUERY}}&#39;]</span>
 
+<span class="sd">    query_type: path</span>
 
+<span class="sd">    shortcut: fnd</span>
 
+<span class="sd">    delimiter:</span>
 
+<span class="sd">        chars: &#39; &#39;</span>
 
+<span class="sd">        keys: [&#39;line&#39;]</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+<span class="sd">&quot;&quot;&quot;</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">os.path</span><span class="w"> </span><span class="kn">import</span> <span class="n">expanduser</span><span class="p">,</span> <span class="n">isabs</span><span class="p">,</span> <span class="n">realpath</span><span class="p">,</span> <span class="n">commonprefix</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">shlex</span><span class="w"> </span><span class="kn">import</span> <span class="n">split</span> <span class="k">as</span> <span class="n">shlex_split</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">subprocess</span><span class="w"> </span><span class="kn">import</span> <span class="n">Popen</span><span class="p">,</span> <span class="n">PIPE</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">threading</span><span class="w"> </span><span class="kn">import</span> <span class="n">Thread</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.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineResults</span>
 
+
 
+
 
+<span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;offline&#39;</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="n">delimiter</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="n">parse_regex</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="n">query_type</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="n">query_enum</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="n">environment_variables</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="n">working_dir</span> <span class="o">=</span> <span class="n">realpath</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
 
+<span class="n">result_separator</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span>
 
+<span class="n">timeout</span> <span class="o">=</span> <span class="mf">4.0</span>
 
+
 
+<span class="n">_command_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="s1">&#39;command&#39;</span><span class="p">)</span>
 
+<span class="n">_compiled_parse_regex</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">):</span>
 
+    <span class="n">check_parsing_options</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;command&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;engine command : missing configuration key: command&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">global</span> <span class="n">command</span><span class="p">,</span> <span class="n">working_dir</span><span class="p">,</span> <span class="n">delimiter</span><span class="p">,</span> <span class="n">parse_regex</span><span class="p">,</span> <span class="n">environment_variables</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+
 
+    <span class="n">command</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;command&#39;</span><span class="p">]</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;working_dir&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="n">working_dir</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;working_dir&#39;</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">isabs</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;working_dir&#39;</span><span class="p">]):</span>
 
+            <span class="n">working_dir</span> <span class="o">=</span> <span class="n">realpath</span><span class="p">(</span><span class="n">working_dir</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;parse_regex&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="n">parse_regex</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;parse_regex&#39;</span><span class="p">]</span>
 
+        <span class="k">for</span> <span class="n">result_key</span><span class="p">,</span> <span class="n">regex</span> <span class="ow">in</span> <span class="n">parse_regex</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="n">_compiled_parse_regex</span><span class="p">[</span><span class="n">result_key</span><span class="p">]</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="n">regex</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="n">re</span><span class="o">.</span><span class="n">MULTILINE</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="s1">&#39;delimiter&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="n">delimiter</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;delimiter&#39;</span><span class="p">]</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;environment_variables&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="n">environment_variables</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;environment_variables&#39;</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="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+    <span class="n">res</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+    <span class="n">cmd</span> <span class="o">=</span> <span class="n">_get_command_to_run</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">cmd</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">res</span>
 
+
 
+    <span class="n">reader_thread</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">_get_results_from_process</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]))</span>
 
+    <span class="n">reader_thread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
 
+    <span class="n">reader_thread</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">res</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_get_command_to_run</span><span class="p">(</span><span class="n">query</span><span class="p">):</span>
 
+    <span class="n">params</span> <span class="o">=</span> <span class="n">shlex_split</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
 
+    <span class="n">__check_query_params</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
 
+
 
+    <span class="n">cmd</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">command</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s1">&#39;{{QUERY}}&#39;</span><span class="p">:</span>
 
+            <span class="n">cmd</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">cmd</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">cmd</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_get_results_from_process</span><span class="p">(</span><span class="n">res</span><span class="p">:</span> <span class="n">EngineResults</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">pageno</span><span class="p">):</span>
 
+    <span class="n">leftover</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+    <span class="n">count</span> <span class="o">=</span> <span class="mi">0</span>
 
+    <span class="n">start</span><span class="p">,</span> <span class="n">end</span> <span class="o">=</span> <span class="n">__get_results_limits</span><span class="p">(</span><span class="n">pageno</span><span class="p">)</span>
 
+    <span class="k">with</span> <span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="n">environment_variables</span><span class="p">)</span> <span class="k">as</span> <span class="n">process</span><span class="p">:</span>
 
+        <span class="n">line</span> <span class="o">=</span> <span class="n">process</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>
 
+        <span class="k">while</span> <span class="n">line</span><span class="p">:</span>
 
+            <span class="n">buf</span> <span class="o">=</span> <span class="n">leftover</span> <span class="o">+</span> <span class="n">line</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span>
 
+            <span class="n">raw_results</span> <span class="o">=</span> <span class="n">buf</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">result_separator</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">raw_results</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
 
+                <span class="n">leftover</span> <span class="o">=</span> <span class="n">raw_results</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+            <span class="n">raw_results</span> <span class="o">=</span> <span class="n">raw_results</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+
 
+            <span class="k">for</span> <span class="n">raw_result</span> <span class="ow">in</span> <span class="n">raw_results</span><span class="p">:</span>
 
+                <span class="n">result</span> <span class="o">=</span> <span class="n">__parse_single_result</span><span class="p">(</span><span class="n">raw_result</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="n">result</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                    <span class="n">_command_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;skipped result:&#39;</span><span class="p">,</span> <span class="n">raw_result</span><span class="p">)</span>
 
+                    <span class="k">continue</span>
 
+
 
+                <span class="k">if</span> <span class="n">start</span> <span class="o">&lt;=</span> <span class="n">count</span> <span class="ow">and</span> <span class="n">count</span> <span class="o">&lt;=</span> <span class="n">end</span><span class="p">:</span>  <span class="c1"># pylint: disable=chained-comparison</span>
 
+                    <span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">KeyValue</span><span class="p">(</span><span class="n">kvmap</span><span class="o">=</span><span class="n">result</span><span class="p">))</span>
 
+
 
+                <span class="n">count</span> <span class="o">+=</span> <span class="mi">1</span>
 
+                <span class="k">if</span> <span class="n">end</span> <span class="o">&lt;</span> <span class="n">count</span><span class="p">:</span>
 
+                    <span class="k">return</span> <span class="n">res</span>
 
+
 
+            <span class="n">line</span> <span class="o">=</span> <span class="n">process</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span>
 
+
 
+        <span class="n">return_code</span> <span class="o">=</span> <span class="n">process</span><span class="o">.</span><span class="n">wait</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">return_code</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;non-zero return code when running command&#39;</span><span class="p">,</span> <span class="n">cmd</span><span class="p">,</span> <span class="n">return_code</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">__get_results_limits</span><span class="p">(</span><span class="n">pageno</span><span class="p">):</span>
 
+    <span class="n">start</span> <span class="o">=</span> <span class="p">(</span><span class="n">pageno</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span>
 
+    <span class="n">end</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="mi">9</span>
 
+    <span class="k">return</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">__check_query_params</span><span class="p">(</span><span class="n">params</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">query_type</span><span class="p">:</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="k">if</span> <span class="n">query_type</span> <span class="o">==</span> <span class="s1">&#39;path&#39;</span><span class="p">:</span>
 
+        <span class="n">query_path</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+        <span class="n">query_path</span> <span class="o">=</span> <span class="n">expanduser</span><span class="p">(</span><span class="n">query_path</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">commonprefix</span><span class="p">([</span><span class="n">realpath</span><span class="p">(</span><span class="n">query_path</span><span class="p">),</span> <span class="n">working_dir</span><span class="p">])</span> <span class="o">!=</span> <span class="n">working_dir</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;requested path is outside of configured working directory&#39;</span><span class="p">)</span>
 
+    <span class="k">elif</span> <span class="n">query_type</span> <span class="o">==</span> <span class="s1">&#39;enum&#39;</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">query_enum</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 
+        <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">param</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">query_enum</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;submitted query params is not allowed&#39;</span><span class="p">,</span> <span class="n">param</span><span class="p">,</span> <span class="s1">&#39;allowed params:&#39;</span><span class="p">,</span> <span class="n">query_enum</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="check_parsing_options">
 
+<a class="viewcode-back" href="../../../dev/engines/offline/command-line-engines.html#searx.engines.command.check_parsing_options">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">check_parsing_options</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Checks if delimiter based parsing or regex parsing is configured correctly&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;delimiter&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span> <span class="ow">and</span> <span class="s1">&#39;parse_regex&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;failed to init settings for parsing lines: missing delimiter or parse_regex&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="s1">&#39;delimiter&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span> <span class="ow">and</span> <span class="s1">&#39;parse_regex&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;failed to init settings for parsing lines: too many settings&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;delimiter&#39;</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="s1">&#39;chars&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;delimiter&#39;</span><span class="p">]</span> <span class="ow">or</span> <span class="s1">&#39;keys&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;delimiter&#39;</span><span class="p">]:</span>
 
+            <span class="k">raise</span> <span class="ne">ValueError</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">__parse_single_result</span><span class="p">(</span><span class="n">raw_result</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parses command line output based on configuration&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="k">if</span> <span class="n">delimiter</span><span class="p">:</span>
 
+        <span class="n">elements</span> <span class="o">=</span> <span class="n">raw_result</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">delimiter</span><span class="p">[</span><span class="s1">&#39;chars&#39;</span><span class="p">],</span> <span class="n">maxsplit</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">delimiter</span><span class="p">[</span><span class="s1">&#39;keys&#39;</span><span class="p">])</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">elements</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">delimiter</span><span class="p">[</span><span class="s1">&#39;keys&#39;</span><span class="p">]):</span>
 
+            <span class="k">return</span> <span class="p">{}</span>
 
+        <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">elements</span><span class="p">)):</span>  <span class="c1"># pylint: disable=consider-using-enumerate</span>
 
+            <span class="n">result</span><span class="p">[</span><span class="n">delimiter</span><span class="p">[</span><span class="s1">&#39;keys&#39;</span><span class="p">][</span><span class="n">i</span><span class="p">]]</span> <span class="o">=</span> <span class="n">elements</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
 
+
 
+    <span class="k">if</span> <span class="n">parse_regex</span><span class="p">:</span>
 
+        <span class="k">for</span> <span class="n">result_key</span><span class="p">,</span> <span class="n">regex</span> <span class="ow">in</span> <span class="n">_compiled_parse_regex</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="n">found</span> <span class="o">=</span> <span class="n">regex</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">raw_result</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">found</span><span class="p">:</span>
 
+                <span class="k">return</span> <span class="p">{}</span>
 
+            <span class="n">result</span><span class="p">[</span><span class="n">result_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">raw_result</span><span class="p">[</span><span class="n">found</span><span class="o">.</span><span class="n">start</span><span class="p">()</span> <span class="p">:</span> <span class="n">found</span><span class="o">.</span><span class="n">end</span><span class="p">()]</span>
 
+
 
+    <span class="k">return</span> <span class="n">result</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 362 - 0
_modules/searx/engines/dailymotion.html
View File 

@@ -0,0 +1,362 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.dailymotion &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.dailymotion</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.dailymotion</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">Dailymotion (Videos)</span>
 
+<span class="sd">~~~~~~~~~~~~~~~~~~~~</span>
 
+
 
+<span class="sd">.. _REST GET: https://developers.dailymotion.com/tools/</span>
 
+<span class="sd">.. _Global API Parameters: https://developers.dailymotion.com/api/#global-parameters</span>
 
+<span class="sd">.. _Video filters API: https://developers.dailymotion.com/api/#video-filters</span>
 
+<span class="sd">.. _Fields selection: https://developers.dailymotion.com/api/#fields-selection</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">time</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.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">get</span><span class="p">,</span> <span class="n">raise_for_httperror</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</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">html_to_text</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">SearxEngineAPIException</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">region_tag</span><span class="p">,</span> <span class="n">language_tag</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.dailymotion.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q769222&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.dailymotion.com/developer&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;videos&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">number_of_results</span> <span class="o">=</span> <span class="mi">10</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_delta_dict</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;day&quot;</span><span class="p">:</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">),</span>
 
+    <span class="s2">&quot;week&quot;</span><span class="p">:</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">7</span><span class="p">),</span>
 
+    <span class="s2">&quot;month&quot;</span><span class="p">:</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">31</span><span class="p">),</span>
 
+    <span class="s2">&quot;year&quot;</span><span class="p">:</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">365</span><span class="p">),</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch_params</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="mi">2</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;is_created_for_kids&#39;</span><span class="p">:</span> <span class="s1">&#39;true&#39;</span><span class="p">},</span>
 
+    <span class="mi">1</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;is_created_for_kids&#39;</span><span class="p">:</span> <span class="s1">&#39;true&#39;</span><span class="p">},</span>
 
+    <span class="mi">0</span><span class="p">:</span> <span class="p">{},</span>
 
+<span class="p">}</span>
 
+<span class="sd">&quot;&quot;&quot;True if this video is &quot;Created for Kids&quot; / intends to target an audience</span>
 
+<span class="sd">under the age of 16 (``is_created_for_kids`` in `Video filters API`_ )</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">family_filter_map</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;true&#39;</span><span class="p">,</span>
 
+    <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;true&#39;</span><span class="p">,</span>
 
+    <span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;false&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="sd">&quot;&quot;&quot;By default, the family filter is turned on. Setting this parameter to</span>
 
+<span class="sd">``false`` will stop filtering-out explicit content from searches and global</span>
 
+<span class="sd">contexts (``family_filter`` in `Global API Parameters`_ ).</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">result_fields</span> <span class="o">=</span> <span class="p">[</span>
 
+    <span class="s1">&#39;allow_embed&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;description&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;title&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;created_time&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;duration&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;url&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;thumbnail_360_url&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;id&#39;</span><span class="p">,</span>
 
+<span class="p">]</span>
 
+<span class="sd">&quot;&quot;&quot;`Fields selection`_, by default, a few fields are returned. To request more</span>
 
+<span class="sd">specific fields, the ``fields`` parameter is used with the list of fields</span>
 
+<span class="sd">SearXNG needs in the response to build a video result list.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">search_url</span> <span class="o">=</span> <span class="s1">&#39;https://api.dailymotion.com/videos?&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;URL to retrieve a list of videos.</span>
 
+
 
+<span class="sd">- `REST GET`_</span>
 
+<span class="sd">- `Global API Parameters`_</span>
 
+<span class="sd">- `Video filters API`_</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">iframe_src</span> <span class="o">=</span> <span class="s2">&quot;https://www.dailymotion.com/embed/video/</span><span class="si">{video_id}</span><span class="s2">&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;URL template to embed video in SearXNG&#39;s result list.&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">query</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">False</span>
 
+
 
+    <span class="n">eng_region</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;en_US&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;search&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;family_filter&#39;</span><span class="p">:</span> <span class="n">family_filter_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">],</span> <span class="s1">&#39;false&#39;</span><span class="p">),</span>
 
+        <span class="s1">&#39;thumbnail_ratio&#39;</span><span class="p">:</span> <span class="s1">&#39;original&#39;</span><span class="p">,</span>  <span class="c1"># original|widescreen|square</span>
 
+        <span class="c1"># https://developers.dailymotion.com/api/#video-filters</span>
 
+        <span class="s1">&#39;languages&#39;</span><span class="p">:</span> <span class="n">eng_lang</span><span class="p">,</span>
 
+        <span class="s1">&#39;page&#39;</span><span class="p">:</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">],</span>
 
+        <span class="s1">&#39;password_protected&#39;</span><span class="p">:</span> <span class="s1">&#39;false&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;private&#39;</span><span class="p">:</span> <span class="s1">&#39;false&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;sort&#39;</span><span class="p">:</span> <span class="s1">&#39;relevance&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">number_of_results</span><span class="p">,</span>
 
+        <span class="s1">&#39;fields&#39;</span><span class="p">:</span> <span class="s1">&#39;,&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result_fields</span><span class="p">),</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">args</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">safesearch_params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">],</span> <span class="p">{}))</span>
 
+
 
+    <span class="c1"># Don&#39;t add localization and country arguments if the user does select a</span>
 
+    <span class="c1"># language (:de, :en, ..)</span>
 
+
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">))</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="c1"># https://developers.dailymotion.com/api/#global-parameters</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;localization&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;country&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
 
+        <span class="c1"># Insufficient rights for the `ams_country&#39; parameter of route `GET /videos&#39;</span>
 
+        <span class="c1"># &#39;ams_country&#39;: eng_region.split(&#39;_&#39;)[1],</span>
 
+
 
+    <span class="n">time_delta</span> <span class="o">=</span> <span class="n">time_delta_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;time_range&quot;</span><span class="p">])</span>
 
+    <span class="k">if</span> <span class="n">time_delta</span><span class="p">:</span>
 
+        <span class="n">created_after</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">-</span> <span class="n">time_delta</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;created_after&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timestamp</span><span class="p">(</span><span class="n">created_after</span><span class="p">)</span>
 
+
 
+    <span class="n">query_str</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span> <span class="o">+</span> <span class="n">query_str</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="c1"># get response from search-request</span>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="n">search_res</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+
 
+    <span class="c1"># check for an API error</span>
 
+    <span class="k">if</span> <span class="s1">&#39;error&#39;</span> <span class="ow">in</span> <span class="n">search_res</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineAPIException</span><span class="p">(</span><span class="n">search_res</span><span class="p">[</span><span class="s1">&#39;error&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;message&#39;</span><span class="p">))</span>
 
+
 
+    <span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+    <span class="c1"># parse results</span>
 
+    <span class="k">for</span> <span class="n">res</span> <span class="ow">in</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;list&#39;</span><span class="p">,</span> <span class="p">[]):</span>
 
+
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">res</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">res</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span>
 
+
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">html_to_text</span><span class="p">(</span><span class="n">res</span><span class="p">[</span><span class="s1">&#39;description&#39;</span><span class="p">])</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">content</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">300</span><span class="p">:</span>
 
+            <span class="n">content</span> <span class="o">=</span> <span class="n">content</span><span class="p">[:</span><span class="mi">300</span><span class="p">]</span> <span class="o">+</span> <span class="s1">&#39;...&#39;</span>
 
+
 
+        <span class="n">publishedDate</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">res</span><span class="p">[</span><span class="s1">&#39;created_time&#39;</span><span class="p">],</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+        <span class="n">length</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">gmtime</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;duration&#39;</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="n">length</span><span class="o">.</span><span class="n">tm_hour</span><span class="p">:</span>
 
+            <span class="n">length</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%H:%M:%S&quot;</span><span class="p">,</span> <span class="n">length</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">length</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%M:%S&quot;</span><span class="p">,</span> <span class="n">length</span><span class="p">)</span>
 
+
 
+        <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">res</span><span class="p">[</span><span class="s1">&#39;thumbnail_360_url&#39;</span><span class="p">]</span>
 
+        <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">thumbnail</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;http://&quot;</span><span class="p">,</span> <span class="s2">&quot;https://&quot;</span><span class="p">)</span>
 
+
 
+        <span class="n">item</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;videos.html&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+            <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+            <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+            <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">publishedDate</span><span class="p">,</span>
 
+            <span class="s1">&#39;length&#39;</span><span class="p">:</span> <span class="n">length</span><span class="p">,</span>
 
+            <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+
 
+        <span class="c1"># HINT: no mater what the value is, without API token videos can&#39;t shown</span>
 
+        <span class="c1"># embedded</span>
 
+        <span class="k">if</span> <span class="n">res</span><span class="p">[</span><span class="s1">&#39;allow_embed&#39;</span><span class="p">]:</span>
 
+            <span class="n">item</span><span class="p">[</span><span class="s1">&#39;iframe_src&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">iframe_src</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">video_id</span><span class="o">=</span><span class="n">res</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">])</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+    <span class="c1"># return results</span>
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/dailymotion.html#searx.engines.dailymotion.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch locales &amp; languages from dailymotion.</span>
 
+
 
+<span class="sd">    Locales fetched from `api/locales &lt;https://api.dailymotion.com/locales&gt;`_.</span>
 
+<span class="sd">    There are duplications in the locale codes returned from Dailymotion which</span>
 
+<span class="sd">    can be ignored::</span>
 
+
 
+<span class="sd">      en_EN --&gt; en_GB, en_US</span>
 
+<span class="sd">      ar_AA --&gt; ar_EG, ar_AE, ar_SA</span>
 
+
 
+<span class="sd">    The language list `api/languages &lt;https://api.dailymotion.com/languages&gt;`_</span>
 
+<span class="sd">    contains over 7000 *languages* codes (see PR1071_).  We use only those</span>
 
+<span class="sd">    language codes that are used in the locales.</span>
 
+
 
+<span class="sd">    .. _PR1071: https://github.com/searxng/searxng/pull/1071</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://api.dailymotion.com/locales&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from dailymotion/locales is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()[</span><span class="s1">&#39;list&#39;</span><span class="p">]:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;locale&#39;</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="n">eng_tag</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;en_EN&#39;</span><span class="p">,</span> <span class="s1">&#39;ar_AA&#39;</span><span class="p">):</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</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="n">eng_tag</span><span class="p">))</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: item unknown --&gt; </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">item</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+
 
+    <span class="n">locale_lang_list</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="o">.</span><span class="n">values</span><span class="p">()]</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://api.dailymotion.com/languages&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from dailymotion/languages is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()[</span><span class="s1">&#39;list&#39;</span><span class="p">]:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;code&#39;</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="n">eng_tag</span> <span class="ow">in</span> <span class="n">locale_lang_list</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</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="n">eng_tag</span><span class="p">))</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 192 - 0
_modules/searx/engines/demo_offline.html
View File 

@@ -0,0 +1,192 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.demo_offline &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.demo_offline</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.demo_offline</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Within this module we implement a *demo offline engine*.  Do not look to</span>
 
+<span class="sd">close to the implementation, its just a simple example.  To get in use of this</span>
 
+<span class="sd">*demo* engine add the following entry to your engines list in ``settings.yml``:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: my offline engine</span>
 
+<span class="sd">    engine: demo_offline</span>
 
+<span class="sd">    shortcut: demo</span>
 
+<span class="sd">    disabled: false</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">json</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="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;offline&#39;</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span>
 
+<span class="n">disabled</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">timeout</span> <span class="o">=</span> <span class="mf">2.0</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># if there is a need for globals, use a leading underline</span>
 
+<span class="n">_my_offline_engine</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="init">
 
+<a class="viewcode-back" href="../../../dev/engines/demo/demo_offline.html#searx.engines.demo_offline.init">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialization of the (offline) engine.  The origin of this demo engine is a</span>
 
+<span class="sd">    simple json string which is loaded in this example while the engine is</span>
 
+<span class="sd">    initialized.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">global</span> <span class="n">_my_offline_engine</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+
 
+    <span class="n">_my_offline_engine</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s1">&#39;[ {&quot;value&quot;: &quot;</span><span class="si">%s</span><span class="s1">&quot;}&#39;</span>
 
+        <span class="s1">&#39;, {&quot;value&quot;:&quot;first item&quot;}&#39;</span>
 
+        <span class="s1">&#39;, {&quot;value&quot;:&quot;second item&quot;}&#39;</span>
 
+        <span class="s1">&#39;, {&quot;value&quot;:&quot;third item&quot;}&#39;</span>
 
+        <span class="s1">&#39;]&#39;</span> <span class="o">%</span> <span class="n">engine_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">)</span>
 
+    <span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="search">
 
+<a class="viewcode-back" href="../../../dev/engines/demo/demo_offline.html#searx.engines.demo_offline.search">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">request_params</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Query (offline) engine and return results.  Assemble the list of results</span>
 
+<span class="sd">    from your local engine.  In this demo engine we ignore the &#39;query&#39; term,</span>
 
+<span class="sd">    usual you would pass the &#39;query&#39; term to your local engine to filter out the</span>
 
+<span class="sd">    results.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">res</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="n">count</span> <span class="o">=</span> <span class="mi">0</span>
 
+    <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">_my_offline_engine</span><span class="p">):</span>
 
+        <span class="n">count</span> <span class="o">+=</span> <span class="mi">1</span>
 
+        <span class="n">kvmap</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+            <span class="s1">&#39;language&#39;</span><span class="p">:</span> <span class="n">request_params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="n">row</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">),</span>
 
+        <span class="p">}</span>
 
+        <span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
 
+            <span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">KeyValue</span><span class="p">(</span>
 
+                <span class="n">caption</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;Demo Offline Engine Result #</span><span class="si">{</span><span class="n">count</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
 
+                <span class="n">key_title</span><span class="o">=</span><span class="s2">&quot;Name&quot;</span><span class="p">,</span>
 
+                <span class="n">value_title</span><span class="o">=</span><span class="s2">&quot;Value&quot;</span><span class="p">,</span>
 
+                <span class="n">kvmap</span><span class="o">=</span><span class="n">kvmap</span><span class="p">,</span>
 
+            <span class="p">)</span>
 
+        <span class="p">)</span>
 
+    <span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">LegacyResult</span><span class="p">(</span><span class="n">number_of_results</span><span class="o">=</span><span class="n">count</span><span class="p">))</span>
 
+    <span class="k">return</span> <span class="n">res</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 223 - 0
_modules/searx/engines/demo_online.html
View File 

@@ -0,0 +1,223 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.demo_online &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.demo_online</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.demo_online</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Within this module we implement a *demo online engine*.  Do not look to</span>
 
+<span class="sd">close to the implementation, its just a simple example which queries `The Art</span>
 
+<span class="sd">Institute of Chicago &lt;https://www.artic.edu&gt;`_</span>
 
+
 
+<span class="sd">To get in use of this *demo* engine add the following entry to your engines</span>
 
+<span class="sd">list in ``settings.yml``:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: my online engine</span>
 
+<span class="sd">    engine: demo_online</span>
 
+<span class="sd">    shortcut: demo</span>
 
+<span class="sd">    disabled: false</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="kn">import</span> <span class="n">loads</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineResults</span>
 
+
 
+<span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;online&#39;</span>
 
+<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span>
 
+<span class="n">disabled</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">timeout</span> <span class="o">=</span> <span class="mf">2.0</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;images&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">page_size</span> <span class="o">=</span> <span class="mi">20</span>
 
+
 
+<span class="n">search_api</span> <span class="o">=</span> <span class="s1">&#39;https://api.artic.edu/api/v1/artworks/search?&#39;</span>
 
+<span class="n">image_api</span> <span class="o">=</span> <span class="s1">&#39;https://www.artic.edu/iiif/2/&#39;</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.artic.edu&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q239303&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;http://api.artic.edu/docs/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<span class="c1"># if there is a need for globals, use a leading underline</span>
 
+<span class="n">_my_online_engine</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+
 
+<div class="viewcode-block" id="init">
 
+<a class="viewcode-back" href="../../../dev/engines/demo/demo_online.html#searx.engines.demo_online.init">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialization of the (online) engine.  If no initialization is needed, drop</span>
 
+<span class="sd">    this init function.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">global</span> <span class="n">_my_online_engine</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+    <span class="n">_my_online_engine</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/demo/demo_online.html#searx.engines.demo_online.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Build up the ``params`` for the online request.  In this example we build a</span>
 
+<span class="sd">    URL to fetch images from `artic.edu &lt;https://artic.edu&gt;`__</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">(</span>
 
+        <span class="p">{</span>
 
+            <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+            <span class="s1">&#39;page&#39;</span><span class="p">:</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">],</span>
 
+            <span class="s1">&#39;fields&#39;</span><span class="p">:</span> <span class="s1">&#39;id,title,artist_display,medium_display,image_id,date_display,dimensions,artist_titles&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">page_size</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+    <span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_api</span> <span class="o">+</span> <span class="n">args</span>
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/demo/demo_online.html#searx.engines.demo_online.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse out the result items from the response.  In this example we parse the</span>
 
+<span class="sd">    response from `api.artic.edu &lt;https://artic.edu&gt;`__ and filter out all</span>
 
+<span class="sd">    images.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">res</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+    <span class="n">json_data</span> <span class="o">=</span> <span class="n">loads</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
 
+        <span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span>
 
+            <span class="n">answer</span><span class="o">=</span><span class="s2">&quot;this is a dummy answer ..&quot;</span><span class="p">,</span>
 
+            <span class="n">url</span><span class="o">=</span><span class="s2">&quot;https://example.org&quot;</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">json_data</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]:</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;image_id&#39;</span><span class="p">]:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="s1">&#39;https://artic.edu/artworks/</span><span class="si">%(id)s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">result</span><span class="p">,</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]</span> <span class="o">+</span> <span class="s2">&quot; (</span><span class="si">%(date_display)s</span><span class="s2">) // </span><span class="si">%(artist_display)s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">result</span><span class="p">,</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="s2">&quot;</span><span class="si">%(medium_display)s</span><span class="s2"> // </span><span class="si">%(dimensions)s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">result</span><span class="p">,</span>
 
+                <span class="s1">&#39;author&#39;</span><span class="p">:</span> <span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;artist_titles&#39;</span><span class="p">]),</span>
 
+                <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">image_api</span> <span class="o">+</span> <span class="s1">&#39;/</span><span class="si">%(image_id)s</span><span class="s1">/full/843,/0/default.jpg&#39;</span> <span class="o">%</span> <span class="n">result</span><span class="p">,</span>
 
+                <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;images.html&#39;</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">res</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 632 - 0
_modules/searx/engines/duckduckgo.html
View File 

@@ -0,0 +1,632 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.duckduckgo &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.duckduckgo</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.duckduckgo</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">DuckDuckGo WEB</span>
 
+<span class="sd">~~~~~~~~~~~~~~</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</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">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">quote_plus</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">lxml.html</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="p">(</span>
 
+    <span class="n">locales</span><span class="p">,</span>
 
+    <span class="n">redislib</span><span class="p">,</span>
 
+    <span class="n">external_bang</span><span class="p">,</span>
 
+<span class="p">)</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="p">(</span>
 
+    <span class="n">eval_xpath</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_getindex</span><span class="p">,</span>
 
+    <span class="n">extr</span><span class="p">,</span>
 
+    <span class="n">extract_text</span><span class="p">,</span>
 
+<span class="p">)</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</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</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">redisdb</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</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">SearxEngineCaptchaException</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">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://lite.duckduckgo.com/lite/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q12805&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="sd">&quot;&quot;&quot;DuckDuckGo-Lite tries to guess user&#39;s preferred language from the HTTP</span>
 
+<span class="sd">``Accept-Language``.  Optional the user can select a region filter (but not a</span>
 
+<span class="sd">language).</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>  <span class="c1"># user can&#39;t select but the results are filtered</span>
 
+
 
+<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://html.duckduckgo.com/html&quot;</span>
 
+
 
+<span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="s1">&#39;d&#39;</span><span class="p">,</span> <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="s1">&#39;w&#39;</span><span class="p">,</span> <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="s1">&#39;m&#39;</span><span class="p">,</span> <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="s1">&#39;y&#39;</span><span class="p">}</span>
 
+<span class="n">form_data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;v&#39;</span><span class="p">:</span> <span class="s1">&#39;l&#39;</span><span class="p">,</span> <span class="s1">&#39;api&#39;</span><span class="p">:</span> <span class="s1">&#39;d.js&#39;</span><span class="p">,</span> <span class="s1">&#39;o&#39;</span><span class="p">:</span> <span class="s1">&#39;json&#39;</span><span class="p">}</span>
 
+<span class="n">__CACHE</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_cache_key</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">region</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
 
+    <span class="k">return</span> <span class="s1">&#39;SearXNG_ddg_web_vqd&#39;</span> <span class="o">+</span> <span class="n">redislib</span><span class="o">.</span><span class="n">secret_hash</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">query</span><span class="si">}</span><span class="s2">//</span><span class="si">{</span><span class="n">region</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="cache_vqd">
 
+<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.cache_vqd">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">cache_vqd</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">region</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Caches a ``vqd`` value from a query.&quot;&quot;&quot;</span>
 
+    <span class="n">c</span> <span class="o">=</span> <span class="n">redisdb</span><span class="o">.</span><span class="n">client</span><span class="p">()</span>
 
+    <span class="k">if</span> <span class="n">c</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;VALKEY cache vqd value: </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">)&quot;</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">region</span><span class="p">)</span>
 
+        <span class="n">c</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">_cache_key</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">region</span><span class="p">),</span> <span class="n">value</span><span class="p">,</span> <span class="n">ex</span><span class="o">=</span><span class="mi">600</span><span class="p">)</span>
 
+
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;MEM cache vqd value: </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">)&quot;</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">region</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">__CACHE</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">100</span><span class="p">:</span>  <span class="c1"># cache vqd from last 100 queries</span>
 
+            <span class="n">__CACHE</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 
+        <span class="n">__CACHE</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">_cache_key</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">region</span><span class="p">),</span> <span class="n">value</span><span class="p">))</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_vqd">
 
+<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.get_vqd">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_vqd</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">region</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">force_request</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="w">    </span><span class="sd">&quot;&quot;&quot;Returns the ``vqd`` that fits to the *query*.</span>
 
+
 
+<span class="sd">    :param query: The query term</span>
 
+<span class="sd">    :param region: DDG&#39;s region code</span>
 
+<span class="sd">    :param force_request: force a request to get a vqd value from DDG</span>
 
+
 
+<span class="sd">    TL;DR; the ``vqd`` value is needed to pass DDG&#39;s bot protection and is used</span>
 
+<span class="sd">    by all request to DDG:</span>
 
+
 
+<span class="sd">    - DuckDuckGo Lite: ``https://lite.duckduckgo.com/lite`` (POST form data)</span>
 
+<span class="sd">    - DuckDuckGo Web: ``https://links.duckduckgo.com/d.js?q=...&amp;vqd=...``</span>
 
+<span class="sd">    - DuckDuckGo Images: ``https://duckduckgo.com/i.js??q=...&amp;vqd=...``</span>
 
+<span class="sd">    - DuckDuckGo Videos: ``https://duckduckgo.com/v.js??q=...&amp;vqd=...``</span>
 
+<span class="sd">    - DuckDuckGo News: ``https://duckduckgo.com/news.js??q=...&amp;vqd=...``</span>
 
+
 
+<span class="sd">    DDG&#39;s bot detection is sensitive to the ``vqd`` value.  For some search terms</span>
 
+<span class="sd">    (such as extremely long search terms that are often sent by bots), no ``vqd``</span>
 
+<span class="sd">    value can be determined.</span>
 
+
 
+<span class="sd">    If SearXNG cannot determine a ``vqd`` value, then no request should go out</span>
 
+<span class="sd">    to DDG.</span>
 
+
 
+<span class="sd">    .. attention::</span>
 
+
 
+<span class="sd">       A request with a wrong ``vqd`` value leads to DDG temporarily putting</span>
 
+<span class="sd">       SearXNG&#39;s IP on a block list.</span>
 
+
 
+<span class="sd">    Requests from IPs in this block list run into timeouts.  Not sure, but it</span>
 
+<span class="sd">    seems the block list is a sliding window: to get my IP rid from the bot list</span>
 
+<span class="sd">    I had to cool down my IP for 1h (send no requests from that IP to DDG).</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">key</span> <span class="o">=</span> <span class="n">_cache_key</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">region</span><span class="p">)</span>
 
+
 
+    <span class="n">c</span> <span class="o">=</span> <span class="n">redisdb</span><span class="o">.</span><span class="n">client</span><span class="p">()</span>
 
+    <span class="k">if</span> <span class="n">c</span><span class="p">:</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">value</span> <span class="ow">or</span> <span class="n">value</span> <span class="o">==</span> <span class="sa">b</span><span class="s1">&#39;&#39;</span><span class="p">:</span>
 
+            <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;re-use CACHED vqd value: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="n">value</span>
 
+
 
+    <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">__CACHE</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="n">key</span><span class="p">:</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;MEM re-use CACHED vqd value: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="n">value</span>
 
+
 
+    <span class="k">if</span> <span class="n">force_request</span><span class="p">:</span>
 
+        <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;https://duckduckgo.com/?q=</span><span class="si">{</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+            <span class="n">value</span> <span class="o">=</span> <span class="n">extr</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="s1">&#39;vqd=&quot;&#39;</span><span class="p">,</span> <span class="s1">&#39;&quot;&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+            <span class="k">if</span> <span class="n">value</span><span class="p">:</span>
 
+                <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;vqd value from DDG request: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 
+                <span class="n">cache_vqd</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">region</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 
+                <span class="k">return</span> <span class="n">value</span>
 
+
 
+    <span class="k">return</span> <span class="kc">None</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_ddg_lang">
 
+<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.get_ddg_lang">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_ddg_lang</span><span class="p">(</span><span class="n">eng_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">,</span> <span class="n">sxng_locale</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;en_US&#39;</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get DuckDuckGo&#39;s language identifier from SearXNG&#39;s locale.</span>
 
+
 
+<span class="sd">    DuckDuckGo defines its languages by region codes (see</span>
 
+<span class="sd">    :py:obj:`fetch_traits`).</span>
 
+
 
+<span class="sd">    To get region and language of a DDG service use:</span>
 
+
 
+<span class="sd">    .. code: python</span>
 
+
 
+<span class="sd">       eng_region = traits.get_region(params[&#39;searxng_locale&#39;], traits.all_locale)</span>
 
+<span class="sd">       eng_lang = get_ddg_lang(traits, params[&#39;searxng_locale&#39;])</span>
 
+
 
+<span class="sd">    It might confuse, but the ``l`` value of the cookie is what SearXNG calls</span>
 
+<span class="sd">    the *region*:</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">        # !ddi paris :es-AR --&gt; {&#39;ad&#39;: &#39;es_AR&#39;, &#39;ah&#39;: &#39;ar-es&#39;, &#39;l&#39;: &#39;ar-es&#39;}</span>
 
+<span class="sd">        params[&#39;cookies&#39;][&#39;ad&#39;] = eng_lang</span>
 
+<span class="sd">        params[&#39;cookies&#39;][&#39;ah&#39;] = eng_region</span>
 
+<span class="sd">        params[&#39;cookies&#39;][&#39;l&#39;] = eng_region</span>
 
+
 
+<span class="sd">    .. hint::</span>
 
+
 
+<span class="sd">       `DDG-lite &lt;https://lite.duckduckgo.com/lite&gt;`__ and the *no Javascript*</span>
 
+<span class="sd">       page https://html.duckduckgo.com/html do not offer a language selection</span>
 
+<span class="sd">       to the user, only a region can be selected by the user (``eng_region``</span>
 
+<span class="sd">       from the example above).  DDG-lite and *no Javascript* store the selected</span>
 
+<span class="sd">       region in a cookie::</span>
 
+
 
+<span class="sd">         params[&#39;cookies&#39;][&#39;kl&#39;] = eng_region  # &#39;ar-es&#39;</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;lang_region&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">sxng_locale</span><span class="p">,</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
 
+    <span class="p">)</span></div>
 
+
 
+
 
+
 
+<span class="n">ddg_reg_map</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;tw-tzh&#39;</span><span class="p">:</span> <span class="s1">&#39;zh_TW&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;hk-tzh&#39;</span><span class="p">:</span> <span class="s1">&#39;zh_HK&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ct-ca&#39;</span><span class="p">:</span> <span class="s1">&#39;skip&#39;</span><span class="p">,</span>  <span class="c1"># ct-ca and es-ca both map to ca_ES</span>
 
+    <span class="s1">&#39;es-ca&#39;</span><span class="p">:</span> <span class="s1">&#39;ca_ES&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;id-en&#39;</span><span class="p">:</span> <span class="s1">&#39;id_ID&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;no-no&#39;</span><span class="p">:</span> <span class="s1">&#39;nb_NO&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;jp-jp&#39;</span><span class="p">:</span> <span class="s1">&#39;ja_JP&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;kr-kr&#39;</span><span class="p">:</span> <span class="s1">&#39;ko_KR&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;xa-ar&#39;</span><span class="p">:</span> <span class="s1">&#39;ar_SA&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;sl-sl&#39;</span><span class="p">:</span> <span class="s1">&#39;sl_SI&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;th-en&#39;</span><span class="p">:</span> <span class="s1">&#39;th_TH&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;vn-en&#39;</span><span class="p">:</span> <span class="s1">&#39;vi_VN&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">ddg_lang_map</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="c1"># use ar --&gt; ar_EG (Egypt&#39;s arabic)</span>
 
+    <span class="s2">&quot;ar_DZ&quot;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;ar_JO&quot;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;ar_SA&quot;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="c1"># use bn --&gt; bn_BD</span>
 
+    <span class="s1">&#39;bn_IN&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="c1"># use de --&gt; de_DE</span>
 
+    <span class="s1">&#39;de_CH&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="c1"># use en --&gt; en_US,</span>
 
+    <span class="s1">&#39;en_AU&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;en_CA&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;en_GB&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="c1"># Esperanto</span>
 
+    <span class="s1">&#39;eo_XX&#39;</span><span class="p">:</span> <span class="s1">&#39;eo&#39;</span><span class="p">,</span>
 
+    <span class="c1"># use es --&gt; es_ES,</span>
 
+    <span class="s1">&#39;es_AR&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_CL&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_CO&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_CR&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_EC&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_MX&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_PE&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_UY&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_VE&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="c1"># use fr --&gt; rf_FR</span>
 
+    <span class="s1">&#39;fr_CA&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;fr_CH&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;fr_BE&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="c1"># use nl --&gt; nl_NL</span>
 
+    <span class="s1">&#39;nl_BE&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="c1"># use pt --&gt; pt_PT</span>
 
+    <span class="s1">&#39;pt_BR&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">,</span>
 
+    <span class="c1"># skip these languages</span>
 
+    <span class="s1">&#39;od_IN&#39;</span><span class="p">:</span> <span class="s1">&#39;skip&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;io_XX&#39;</span><span class="p">:</span> <span class="s1">&#39;skip&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;tokipona_XX&#39;</span><span class="p">:</span> <span class="s1">&#39;skip&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">quote_ddg_bangs</span><span class="p">(</span><span class="n">query</span><span class="p">):</span>
 
+    <span class="c1"># quote ddg bangs</span>
 
+    <span class="n">query_parts</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="c1"># for val in re.split(r&#39;(\s+)&#39;, query):</span>
 
+    <span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="sa">r</span><span class="s1">&#39;(\s+)&#39;</span><span class="p">,</span> <span class="n">query</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">val</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">if</span> <span class="n">val</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;!&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">external_bang</span><span class="o">.</span><span class="n">get_node</span><span class="p">(</span><span class="n">external_bang</span><span class="o">.</span><span class="n">EXTERNAL_BANGS</span><span class="p">,</span> <span class="n">val</span><span class="p">[</span><span class="mi">1</span><span class="p">:]):</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">val</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
 
+        <span class="n">query_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">val</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">query_parts</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+
 
+    <span class="n">query</span> <span class="o">=</span> <span class="n">quote_ddg_bangs</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">query</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">500</span><span class="p">:</span>
 
+        <span class="c1"># DDG does not accept queries with more than 499 chars</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="c1"># Advanced search syntax ends in CAPTCHA</span>
 
+    <span class="c1"># https://duckduckgo.com/duckduckgo-help-pages/results/syntax/</span>
 
+    <span class="n">query</span> <span class="o">=</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
 
+        <span class="p">[</span>
 
+            <span class="n">x</span><span class="o">.</span><span class="n">removeprefix</span><span class="p">(</span><span class="s2">&quot;site:&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">removeprefix</span><span class="p">(</span><span class="s2">&quot;intitle:&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">removeprefix</span><span class="p">(</span><span class="s2">&quot;inurl:&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">removeprefix</span><span class="p">(</span><span class="s2">&quot;filetype:&quot;</span><span class="p">)</span>
 
+            <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
 
+        <span class="p">]</span>
 
+    <span class="p">)</span>
 
+    <span class="n">eng_region</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="k">if</span> <span class="n">eng_region</span> <span class="o">==</span> <span class="s2">&quot;wt-wt&quot;</span><span class="p">:</span>
 
+        <span class="c1"># https://html.duckduckgo.com/html sets an empty value for &quot;all&quot;.</span>
 
+        <span class="n">eng_region</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;kl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;kl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_region</span>
 
+
 
+    <span class="c1"># eng_lang = get_ddg_lang(traits, params[&#39;searxng_locale&#39;])</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">url</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;method&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;POST&#39;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;q&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span>
 
+
 
+    <span class="c1"># The API is not documented, so we do some reverse engineering and emulate</span>
 
+    <span class="c1"># what https://html.duckduckgo.com/html does when you press &quot;next Page&quot; link</span>
 
+    <span class="c1"># again and again ..</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Content-Type&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;application/x-www-form-urlencoded&#39;</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Sec-Fetch-Dest&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;document&quot;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Sec-Fetch-Mode&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;navigate&quot;</span>  <span class="c1"># at least this one is used by ddg&#39;s bot detection</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Sec-Fetch-Site&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;same-origin&quot;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Sec-Fetch-User&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;?1&quot;</span>
 
+
 
+    <span class="c1"># Form of the initial search page does have empty values in the form</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
 
+
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;b&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;df&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
 
+
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;df&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_range_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;df&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_range_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
 
+
 
+        <span class="c1"># second page does have an offset of 20</span>
 
+        <span class="n">offset</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">20</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;s&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">offset</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;dc&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">offset</span> <span class="o">+</span> <span class="mi">1</span>
 
+
 
+    <span class="k">elif</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">&gt;</span> <span class="mi">2</span><span class="p">:</span>
 
+
 
+        <span class="c1"># third and following pages do have an offset of 20 + n*50</span>
 
+        <span class="n">offset</span> <span class="o">=</span> <span class="mi">20</span> <span class="o">+</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">2</span><span class="p">)</span> <span class="o">*</span> <span class="mi">50</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;s&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">offset</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;dc&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">offset</span> <span class="o">+</span> <span class="mi">1</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+
 
+        <span class="c1"># initial page does not have these additional data in the input form</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;o&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">form_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;o&#39;</span><span class="p">,</span> <span class="s1">&#39;json&#39;</span><span class="p">)</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;api&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">form_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;api&#39;</span><span class="p">,</span> <span class="s1">&#39;d.js&#39;</span><span class="p">)</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;nextParams&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">form_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;nextParams&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;v&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">form_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;v&#39;</span><span class="p">,</span> <span class="s1">&#39;l&#39;</span><span class="p">)</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Referer&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">url</span>
 
+
 
+        <span class="n">vqd</span> <span class="o">=</span> <span class="n">get_vqd</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">eng_region</span><span class="p">,</span> <span class="n">force_request</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 
+
 
+        <span class="c1"># Certain conditions must be met in order to call up one of the</span>
 
+        <span class="c1"># following pages ...</span>
 
+
 
+        <span class="k">if</span> <span class="n">vqd</span><span class="p">:</span>
 
+            <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;vqd&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">vqd</span>  <span class="c1"># follow up pages / requests needs a vqd argument</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="c1"># Don&#39;t try to call follow up pages without a vqd value.  DDG</span>
 
+            <span class="c1"># recognizes this as a request from a bot.  This lowers the</span>
 
+            <span class="c1"># reputation of the SearXNG IP and DDG starts to activate CAPTCHAs.</span>
 
+            <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
 
+            <span class="k">return</span>
 
+
 
+        <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;zh&quot;</span><span class="p">):</span>
 
+            <span class="c1"># Some locales (at least China) do not have a &quot;next page&quot; button and ddg</span>
 
+            <span class="c1"># will return a HTTP/2 403 Forbidden for a request of such a page.</span>
 
+            <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
 
+            <span class="k">return</span>
 
+
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;param data: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">])</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;param cookies: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">])</span>
 
+
 
+
 
+<div class="viewcode-block" id="is_ddg_captcha">
 
+<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.is_ddg_captcha">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">is_ddg_captcha</span><span class="p">(</span><span class="n">dom</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;In case of CAPTCHA ddg response its own *not a Robot* dialog and is not</span>
 
+<span class="sd">    redirected to a CAPTCHA page.&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//form[@id=&#39;challenge-form&#39;]&quot;</span><span class="p">))</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">303</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">results</span>
 
+
 
+    <span class="n">doc</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">is_ddg_captcha</span><span class="p">(</span><span class="n">doc</span><span class="p">):</span>
 
+        <span class="c1"># set suspend time to zero is OK --&gt; ddg does not block the IP</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">(</span><span class="n">suspended_time</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;CAPTCHA (</span><span class="si">{</span><span class="n">resp</span><span class="o">.</span><span class="n">search_params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;kl&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">)&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">form</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="s1">&#39;//input[@name=&quot;vqd&quot;]/..&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">form</span><span class="p">):</span>
 
+        <span class="c1"># some locales (at least China) does not have a &quot;next page&quot; button</span>
 
+        <span class="n">form</span> <span class="o">=</span> <span class="n">form</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">form_vqd</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">form</span><span class="p">,</span> <span class="s1">&#39;//input[@name=&quot;vqd&quot;]/@value&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+
 
+        <span class="n">cache_vqd</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">search_params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;q&#39;</span><span class="p">],</span> <span class="n">resp</span><span class="o">.</span><span class="n">search_params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;kl&#39;</span><span class="p">],</span> <span class="n">form_vqd</span><span class="p">)</span>
 
+
 
+    <span class="c1"># just select &quot;web-result&quot; and ignore results of class &quot;result--ad result--ad--small&quot;</span>
 
+    <span class="k">for</span> <span class="n">div_result</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="s1">&#39;//div[@id=&quot;links&quot;]/div[contains(@class, &quot;web-result&quot;)]&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">item</span> <span class="o">=</span> <span class="p">{}</span>
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">div_result</span><span class="p">,</span> <span class="s1">&#39;.//h2/a&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">title</span><span class="p">:</span>
 
+            <span class="c1"># this is the &quot;No results.&quot; item in the result list</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">item</span><span class="p">[</span><span class="s2">&quot;title&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
 
+        <span class="n">item</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">div_result</span><span class="p">,</span> <span class="s1">&#39;.//h2/a/@href&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">item</span><span class="p">[</span><span class="s2">&quot;content&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">div_result</span><span class="p">,</span> <span class="s1">&#39;.//a[contains(@class, &quot;result__snippet&quot;)]&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+    <span class="n">zero_click_info_xpath</span> <span class="o">=</span> <span class="s1">&#39;//div[@id=&quot;zero_click_abstract&quot;]&#39;</span>
 
+    <span class="n">zero_click</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="n">zero_click_info_xpath</span><span class="p">))</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="k">if</span> <span class="n">zero_click</span> <span class="ow">and</span> <span class="p">(</span>
 
+        <span class="s2">&quot;Your IP address is&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">zero_click</span>
 
+        <span class="ow">and</span> <span class="s2">&quot;Your user agent:&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">zero_click</span>
 
+        <span class="ow">and</span> <span class="s2">&quot;URL Decoded:&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">zero_click</span>
 
+    <span class="p">):</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span>
 
+                <span class="n">answer</span><span class="o">=</span><span class="n">zero_click</span><span class="p">,</span>
 
+                <span class="n">url</span><span class="o">=</span><span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span> <span class="s1">&#39;//div[@id=&quot;zero_click_abstract&quot;]/a/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
 
+            <span class="p">)</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages &amp; regions from DuckDuckGo.</span>
 
+
 
+<span class="sd">    SearXNG&#39;s ``all`` locale maps DuckDuckGo&#39;s &quot;Alle regions&quot; (``wt-wt``).</span>
 
+<span class="sd">    DuckDuckGo&#39;s language &quot;Browsers preferred language&quot; (``wt_WT``) makes no</span>
 
+<span class="sd">    sense in a SearXNG request since SearXNG&#39;s ``all`` will not add a</span>
 
+<span class="sd">    ``Accept-Language`` HTTP header.  The value in ``engine_traits.all_locale``</span>
 
+<span class="sd">    is ``wt-wt`` (the region).</span>
 
+
 
+<span class="sd">    Beside regions DuckDuckGo also defines its languages by region codes.  By</span>
 
+<span class="sd">    example these are the english languages in DuckDuckGo:</span>
 
+
 
+<span class="sd">    - en_US</span>
 
+<span class="sd">    - en_AU</span>
 
+<span class="sd">    - en_CA</span>
 
+<span class="sd">    - en_GB</span>
 
+
 
+<span class="sd">    The function :py:obj:`get_ddg_lang` evaluates DuckDuckGo&#39;s language from</span>
 
+<span class="sd">    SearXNG&#39;s locale.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=too-many-branches, too-many-statements, disable=import-outside-toplevel</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">js_variable_to_python</span>
 
+
 
+    <span class="c1"># fetch regions</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="s1">&#39;wt-wt&#39;</span>
 
+
 
+    <span class="c1"># updated from u661.js to u.7669f071a13a7daa57cb / should be updated automatically?</span>
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://duckduckgo.com/dist/util/u.7669f071a13a7daa57cb.js&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from DuckDuckGo is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">js_code</span> <span class="o">=</span> <span class="n">extr</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="s1">&#39;regions:&#39;</span><span class="p">,</span> <span class="s1">&#39;,snippetLengths&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="n">regions</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">js_code</span><span class="p">)</span>
 
+    <span class="k">for</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">regions</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+
 
+        <span class="k">if</span> <span class="n">eng_tag</span> <span class="o">==</span> <span class="s1">&#39;wt-wt&#39;</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="s1">&#39;wt-wt&#39;</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">region</span> <span class="o">=</span> <span class="n">ddg_reg_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">region</span> <span class="o">==</span> <span class="s1">&#39;skip&#39;</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">region</span><span class="p">:</span>
 
+            <span class="n">eng_territory</span><span class="p">,</span> <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">eng_tag</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+            <span class="n">region</span> <span class="o">=</span> <span class="n">eng_lang</span> <span class="o">+</span> <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">eng_territory</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
 
+
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">region_tag</span><span class="p">(</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="n">region</span><span class="p">))</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">) -&gt; </span><span class="si">%s</span><span class="s2"> is unknown by babel&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">region</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+
 
+    <span class="c1"># fetch languages</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;lang_region&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="n">js_code</span> <span class="o">=</span> <span class="n">extr</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="s1">&#39;languages:&#39;</span><span class="p">,</span> <span class="s1">&#39;,regions&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="n">languages</span> <span class="o">=</span> <span class="n">js_variable_to_python</span><span class="p">(</span><span class="n">js_code</span><span class="p">)</span>
 
+    <span class="k">for</span> <span class="n">eng_lang</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">languages</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+
 
+        <span class="k">if</span> <span class="n">eng_lang</span> <span class="o">==</span> <span class="s1">&#39;wt_WT&#39;</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">babel_tag</span> <span class="o">=</span> <span class="n">ddg_lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_lang</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">babel_tag</span> <span class="o">==</span> <span class="s1">&#39;skip&#39;</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="k">try</span><span class="p">:</span>
 
+
 
+            <span class="k">if</span> <span class="n">babel_tag</span> <span class="o">==</span> <span class="s1">&#39;lang_region&#39;</span><span class="p">:</span>
 
+                <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">region_tag</span><span class="p">(</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="n">eng_lang</span><span class="p">))</span>
 
+                <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;lang_region&#39;</span><span class="p">][</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_lang</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">language_tag</span><span class="p">(</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="n">babel_tag</span><span class="p">))</span>
 
+
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: language </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">) is unknown by babel&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_lang</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_lang</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 378 - 0
_modules/searx/engines/duckduckgo_definitions.html
View File 

@@ -0,0 +1,378 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.duckduckgo_definitions &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.duckduckgo_definitions</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.duckduckgo_definitions</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">DuckDuckGo Instant Answer API</span>
 
+<span class="sd">~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</span>
 
+
 
+<span class="sd">The `DDG-API &lt;https://duckduckgo.com/api&gt;`__ is no longer documented but from</span>
 
+<span class="sd">reverse engineering we can see that some services (e.g. instant answers) still</span>
 
+<span class="sd">in use from the DDG search engine.</span>
 
+
 
+<span class="sd">As far we can say the *instant answers* API does not support languages, or at</span>
 
+<span class="sd">least we could not find out how language support should work.  It seems that</span>
 
+<span class="sd">most of the features are based on English terms.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span><span class="p">,</span> <span class="n">urlparse</span><span class="p">,</span> <span class="n">urljoin</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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">WIKIDATA_UNITS</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">extract_text</span><span class="p">,</span> <span class="n">html_to_text</span><span class="p">,</span> <span class="n">get_string_replaces_function</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.external_urls</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_external_url</span><span class="p">,</span> <span class="n">get_earth_coordinates_url</span><span class="p">,</span> <span class="n">area_to_osm_zoom</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">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://duckduckgo.com/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q12805&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://duckduckgo.com/api&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+<span class="n">URL</span> <span class="o">=</span> <span class="s1">&#39;https://api.duckduckgo.com/&#39;</span> <span class="o">+</span> <span class="s1">&#39;?</span><span class="si">{query}</span><span class="s1">&amp;format=json&amp;pretty=0&amp;no_redirect=1&amp;d=1&#39;</span>
 
+
 
+<span class="n">WIKIDATA_PREFIX</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;http://www.wikidata.org/entity/&#39;</span><span class="p">,</span> <span class="s1">&#39;https://www.wikidata.org/entity/&#39;</span><span class="p">]</span>
 
+
 
+<span class="n">replace_http_by_https</span> <span class="o">=</span> <span class="n">get_string_replaces_function</span><span class="p">({</span><span class="s1">&#39;http:&#39;</span><span class="p">:</span> <span class="s1">&#39;https:&#39;</span><span class="p">})</span>
 
+
 
+
 
+<div class="viewcode-block" id="is_broken_text">
 
+<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo_definitions.is_broken_text">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">is_broken_text</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;duckduckgo may return something like ``&lt;a href=&quot;xxxx&quot;&gt;http://somewhere Related website&lt;a/&gt;``</span>
 
+
 
+<span class="sd">    The href URL is broken, the &quot;Related website&quot; may contains some HTML.</span>
 
+
 
+<span class="sd">    The best solution seems to ignore these results.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="n">text</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;http&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="s1">&#39; &#39;</span> <span class="ow">in</span> <span class="n">text</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">result_to_text</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">htmlResult</span><span class="p">):</span>
 
+    <span class="c1"># TODO : remove result ending with &quot;Meaning&quot; or &quot;Category&quot;  # pylint: disable=fixme</span>
 
+    <span class="n">result</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">htmlResult</span><span class="p">)</span>
 
+    <span class="n">a</span> <span class="o">=</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//a&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">a</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="n">result</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">result</span> <span class="o">=</span> <span class="n">text</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">is_broken_text</span><span class="p">(</span><span class="n">result</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">result</span>
 
+    <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">URL</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}))</span>
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+    <span class="c1"># pylint: disable=too-many-locals, too-many-branches, too-many-statements</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="n">search_res</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+
 
+    <span class="c1"># search_res.get(&#39;Entity&#39;) possible values (not exhaustive) :</span>
 
+    <span class="c1"># * continent / country / department / location / waterfall</span>
 
+    <span class="c1"># * actor / musician / artist</span>
 
+    <span class="c1"># * book / performing art / film / television  / media franchise / concert tour / playwright</span>
 
+    <span class="c1"># * prepared food</span>
 
+    <span class="c1"># * website / software / os / programming language / file format / software engineer</span>
 
+    <span class="c1"># * company</span>
 
+
 
+    <span class="n">content</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+    <span class="n">heading</span> <span class="o">=</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Heading&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+    <span class="n">attributes</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">urls</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">infobox_id</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">relatedTopics</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="c1"># add answer if there is one</span>
 
+    <span class="n">answer</span> <span class="o">=</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Answer&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">answer</span><span class="p">:</span>
 
+        <span class="n">answer_type</span> <span class="o">=</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;AnswerType&#39;</span><span class="p">)</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;AnswerType=&quot;</span><span class="si">%s</span><span class="s1">&quot; Answer=&quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span><span class="p">,</span> <span class="n">answer_type</span><span class="p">,</span> <span class="n">answer</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">answer</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="n">answer_type</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;calc&#39;</span><span class="p">,</span> <span class="s1">&#39;ip&#39;</span><span class="p">]:</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span>
 
+                    <span class="n">answer</span><span class="o">=</span><span class="n">html_to_text</span><span class="p">(</span><span class="n">answer</span><span class="p">),</span>
 
+                    <span class="n">url</span><span class="o">=</span><span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;AbstractURL&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
 
+                <span class="p">)</span>
 
+            <span class="p">)</span>
 
+
 
+    <span class="c1"># add infobox</span>
 
+    <span class="k">if</span> <span class="s1">&#39;Definition&#39;</span> <span class="ow">in</span> <span class="n">search_res</span><span class="p">:</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">content</span> <span class="o">+</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Definition&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;Abstract&#39;</span> <span class="ow">in</span> <span class="n">search_res</span><span class="p">:</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">content</span> <span class="o">+</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Abstract&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+
 
+    <span class="c1"># image</span>
 
+    <span class="n">image</span> <span class="o">=</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Image&#39;</span><span class="p">)</span>
 
+    <span class="n">image</span> <span class="o">=</span> <span class="kc">None</span> <span class="k">if</span> <span class="n">image</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span> <span class="k">else</span> <span class="n">image</span>
 
+    <span class="k">if</span> <span class="n">image</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">image</span><span class="p">)</span><span class="o">.</span><span class="n">netloc</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
 
+        <span class="n">image</span> <span class="o">=</span> <span class="n">urljoin</span><span class="p">(</span><span class="s1">&#39;https://duckduckgo.com&#39;</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span>
 
+
 
+    <span class="c1"># urls</span>
 
+    <span class="c1"># Official website, Wikipedia page</span>
 
+    <span class="k">for</span> <span class="n">ddg_result</span> <span class="ow">in</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Results&#39;</span><span class="p">,</span> <span class="p">[]):</span>
 
+        <span class="n">firstURL</span> <span class="o">=</span> <span class="n">ddg_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;FirstURL&#39;</span><span class="p">)</span>
 
+        <span class="n">text</span> <span class="o">=</span> <span class="n">ddg_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Text&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">firstURL</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">text</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">urls</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">text</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">firstURL</span><span class="p">})</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">heading</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">firstURL</span><span class="p">})</span>
 
+
 
+    <span class="c1"># related topics</span>
 
+    <span class="k">for</span> <span class="n">ddg_result</span> <span class="ow">in</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;RelatedTopics&#39;</span><span class="p">,</span> <span class="p">[]):</span>
 
+        <span class="k">if</span> <span class="s1">&#39;FirstURL&#39;</span> <span class="ow">in</span> <span class="n">ddg_result</span><span class="p">:</span>
 
+            <span class="n">firstURL</span> <span class="o">=</span> <span class="n">ddg_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;FirstURL&#39;</span><span class="p">)</span>
 
+            <span class="n">text</span> <span class="o">=</span> <span class="n">ddg_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Text&#39;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">is_broken_text</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
 
+                <span class="n">suggestion</span> <span class="o">=</span> <span class="n">result_to_text</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">ddg_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Result&#39;</span><span class="p">))</span>
 
+                <span class="k">if</span> <span class="n">suggestion</span> <span class="o">!=</span> <span class="n">heading</span> <span class="ow">and</span> <span class="n">suggestion</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                    <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">suggestion</span><span class="p">})</span>
 
+        <span class="k">elif</span> <span class="s1">&#39;Topics&#39;</span> <span class="ow">in</span> <span class="n">ddg_result</span><span class="p">:</span>
 
+            <span class="n">suggestions</span> <span class="o">=</span> <span class="p">[]</span>
 
+            <span class="n">relatedTopics</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="n">ddg_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Name&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span> <span class="s1">&#39;suggestions&#39;</span><span class="p">:</span> <span class="n">suggestions</span><span class="p">})</span>
 
+            <span class="k">for</span> <span class="n">topic_result</span> <span class="ow">in</span> <span class="n">ddg_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Topics&#39;</span><span class="p">,</span> <span class="p">[]):</span>
 
+                <span class="n">suggestion</span> <span class="o">=</span> <span class="n">result_to_text</span><span class="p">(</span><span class="n">topic_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Text&#39;</span><span class="p">),</span> <span class="n">topic_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Result&#39;</span><span class="p">))</span>
 
+                <span class="k">if</span> <span class="n">suggestion</span> <span class="o">!=</span> <span class="n">heading</span> <span class="ow">and</span> <span class="n">suggestion</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                    <span class="n">suggestions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">suggestion</span><span class="p">)</span>
 
+
 
+    <span class="c1"># abstract</span>
 
+    <span class="n">abstractURL</span> <span class="o">=</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;AbstractURL&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">abstractURL</span> <span class="o">!=</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
 
+        <span class="c1"># add as result ? problem always in english</span>
 
+        <span class="n">infobox_id</span> <span class="o">=</span> <span class="n">abstractURL</span>
 
+        <span class="n">urls</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;AbstractSource&#39;</span><span class="p">),</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">abstractURL</span><span class="p">,</span> <span class="s1">&#39;official&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">})</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">abstractURL</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">heading</span><span class="p">})</span>
 
+
 
+    <span class="c1"># definition</span>
 
+    <span class="n">definitionURL</span> <span class="o">=</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;DefinitionURL&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">definitionURL</span> <span class="o">!=</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
 
+        <span class="c1"># add as result ? as answer ? problem always in english</span>
 
+        <span class="n">infobox_id</span> <span class="o">=</span> <span class="n">definitionURL</span>
 
+        <span class="n">urls</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;DefinitionSource&#39;</span><span class="p">),</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">definitionURL</span><span class="p">})</span>
 
+
 
+    <span class="c1"># to merge with wikidata&#39;s infobox</span>
 
+    <span class="k">if</span> <span class="n">infobox_id</span><span class="p">:</span>
 
+        <span class="n">infobox_id</span> <span class="o">=</span> <span class="n">replace_http_by_https</span><span class="p">(</span><span class="n">infobox_id</span><span class="p">)</span>
 
+
 
+    <span class="c1"># attributes</span>
 
+    <span class="c1"># some will be converted to urls</span>
 
+    <span class="k">if</span> <span class="s1">&#39;Infobox&#39;</span> <span class="ow">in</span> <span class="n">search_res</span><span class="p">:</span>
 
+        <span class="n">infobox</span> <span class="o">=</span> <span class="n">search_res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Infobox&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="s1">&#39;content&#39;</span> <span class="ow">in</span> <span class="n">infobox</span><span class="p">:</span>
 
+            <span class="n">osm_zoom</span> <span class="o">=</span> <span class="mi">17</span>
 
+            <span class="n">coordinates</span> <span class="o">=</span> <span class="kc">None</span>
 
+            <span class="k">for</span> <span class="n">info</span> <span class="ow">in</span> <span class="n">infobox</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;content&#39;</span><span class="p">):</span>
 
+                <span class="n">data_type</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;data_type&#39;</span><span class="p">)</span>
 
+                <span class="n">data_label</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;label&#39;</span><span class="p">)</span>
 
+                <span class="n">data_value</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;value&#39;</span><span class="p">)</span>
 
+
 
+                <span class="c1"># Workaround: ddg may return a double quote</span>
 
+                <span class="k">if</span> <span class="n">data_value</span> <span class="o">==</span> <span class="s1">&#39;&quot;&quot;&#39;</span><span class="p">:</span>
 
+                    <span class="k">continue</span>
 
+
 
+                <span class="c1"># Is it an external URL ?</span>
 
+                <span class="c1"># * imdb_id / facebook_profile / youtube_channel / youtube_video / twitter_profile</span>
 
+                <span class="c1"># * instagram_profile / rotten_tomatoes / spotify_artist_id / itunes_artist_id / soundcloud_id</span>
 
+                <span class="c1"># * netflix_id</span>
 
+                <span class="n">external_url</span> <span class="o">=</span> <span class="n">get_external_url</span><span class="p">(</span><span class="n">data_type</span><span class="p">,</span> <span class="n">data_value</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="n">external_url</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                    <span class="n">urls</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">data_label</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">external_url</span><span class="p">})</span>
 
+                <span class="k">elif</span> <span class="n">data_type</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;instance&#39;</span><span class="p">,</span> <span class="s1">&#39;wiki_maps_trigger&#39;</span><span class="p">,</span> <span class="s1">&#39;google_play_artist_id&#39;</span><span class="p">]:</span>
 
+                    <span class="c1"># ignore instance: Wikidata value from &quot;Instance Of&quot; (Qxxxx)</span>
 
+                    <span class="c1"># ignore wiki_maps_trigger: reference to a javascript</span>
 
+                    <span class="c1"># ignore google_play_artist_id: service shutdown</span>
 
+                    <span class="k">pass</span>
 
+                <span class="k">elif</span> <span class="n">data_type</span> <span class="o">==</span> <span class="s1">&#39;string&#39;</span> <span class="ow">and</span> <span class="n">data_label</span> <span class="o">==</span> <span class="s1">&#39;Website&#39;</span><span class="p">:</span>
 
+                    <span class="c1"># There is already an URL for the website</span>
 
+                    <span class="k">pass</span>
 
+                <span class="k">elif</span> <span class="n">data_type</span> <span class="o">==</span> <span class="s1">&#39;area&#39;</span><span class="p">:</span>
 
+                    <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;label&#39;</span><span class="p">:</span> <span class="n">data_label</span><span class="p">,</span> <span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="n">area_to_str</span><span class="p">(</span><span class="n">data_value</span><span class="p">),</span> <span class="s1">&#39;entity&#39;</span><span class="p">:</span> <span class="s1">&#39;P2046&#39;</span><span class="p">})</span>
 
+                    <span class="n">osm_zoom</span> <span class="o">=</span> <span class="n">area_to_osm_zoom</span><span class="p">(</span><span class="n">data_value</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;amount&#39;</span><span class="p">))</span>
 
+                <span class="k">elif</span> <span class="n">data_type</span> <span class="o">==</span> <span class="s1">&#39;coordinates&#39;</span><span class="p">:</span>
 
+                    <span class="k">if</span> <span class="n">data_value</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;globe&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="s1">&#39;http://www.wikidata.org/entity/Q2&#39;</span><span class="p">:</span>
 
+                        <span class="c1"># coordinate on Earth</span>
 
+                        <span class="c1"># get the zoom information from the area</span>
 
+                        <span class="n">coordinates</span> <span class="o">=</span> <span class="n">info</span>
 
+                    <span class="k">else</span><span class="p">:</span>
 
+                        <span class="c1"># coordinate NOT on Earth</span>
 
+                        <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;label&#39;</span><span class="p">:</span> <span class="n">data_label</span><span class="p">,</span> <span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="n">data_value</span><span class="p">,</span> <span class="s1">&#39;entity&#39;</span><span class="p">:</span> <span class="s1">&#39;P625&#39;</span><span class="p">})</span>
 
+                <span class="k">elif</span> <span class="n">data_type</span> <span class="o">==</span> <span class="s1">&#39;string&#39;</span><span class="p">:</span>
 
+                    <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;label&#39;</span><span class="p">:</span> <span class="n">data_label</span><span class="p">,</span> <span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="n">data_value</span><span class="p">})</span>
 
+
 
+            <span class="k">if</span> <span class="n">coordinates</span><span class="p">:</span>
 
+                <span class="n">data_label</span> <span class="o">=</span> <span class="n">coordinates</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;label&#39;</span><span class="p">)</span>
 
+                <span class="n">data_value</span> <span class="o">=</span> <span class="n">coordinates</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;value&#39;</span><span class="p">)</span>
 
+                <span class="n">latitude</span> <span class="o">=</span> <span class="n">data_value</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;latitude&#39;</span><span class="p">)</span>
 
+                <span class="n">longitude</span> <span class="o">=</span> <span class="n">data_value</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;longitude&#39;</span><span class="p">)</span>
 
+                <span class="n">url</span> <span class="o">=</span> <span class="n">get_earth_coordinates_url</span><span class="p">(</span><span class="n">latitude</span><span class="p">,</span> <span class="n">longitude</span><span class="p">,</span> <span class="n">osm_zoom</span><span class="p">)</span>
 
+                <span class="n">urls</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="s1">&#39;OpenStreetMap&#39;</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;entity&#39;</span><span class="p">:</span> <span class="s1">&#39;P625&#39;</span><span class="p">})</span>
 
+
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">heading</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 
+        <span class="c1"># TODO get infobox.meta.value where .label=&#39;article_title&#39;    # pylint: disable=fixme</span>
 
+        <span class="k">if</span> <span class="n">image</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">attributes</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">urls</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">relatedTopics</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">content</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">urls</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s1">&#39;url&#39;</span><span class="p">],</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">heading</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">})</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                <span class="p">{</span>
 
+                    <span class="s1">&#39;infobox&#39;</span><span class="p">:</span> <span class="n">heading</span><span class="p">,</span>
 
+                    <span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="n">infobox_id</span><span class="p">,</span>
 
+                    <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                    <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">image</span><span class="p">,</span>
 
+                    <span class="s1">&#39;attributes&#39;</span><span class="p">:</span> <span class="n">attributes</span><span class="p">,</span>
 
+                    <span class="s1">&#39;urls&#39;</span><span class="p">:</span> <span class="n">urls</span><span class="p">,</span>
 
+                    <span class="s1">&#39;relatedTopics&#39;</span><span class="p">:</span> <span class="n">relatedTopics</span><span class="p">,</span>
 
+                <span class="p">}</span>
 
+            <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">unit_to_str</span><span class="p">(</span><span class="n">unit</span><span class="p">):</span>
 
+    <span class="k">for</span> <span class="n">prefix</span> <span class="ow">in</span> <span class="n">WIKIDATA_PREFIX</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">unit</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">prefix</span><span class="p">):</span>
 
+            <span class="n">wikidata_entity</span> <span class="o">=</span> <span class="n">unit</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span> <span class="p">:]</span>
 
+            <span class="n">real_unit</span> <span class="o">=</span> <span class="n">WIKIDATA_UNITS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">wikidata_entity</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">real_unit</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="k">return</span> <span class="n">unit</span>
 
+            <span class="k">return</span> <span class="n">real_unit</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">]</span>
 
+    <span class="k">return</span> <span class="n">unit</span>
 
+
 
+
 
+<div class="viewcode-block" id="area_to_str">
 
+<a class="viewcode-back" href="../../../dev/engines/online/duckduckgo.html#searx.engines.duckduckgo_definitions.area_to_str">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">area_to_str</span><span class="p">(</span><span class="n">area</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;parse ``{&#39;unit&#39;: &#39;https://www.wikidata.org/entity/Q712226&#39;, &#39;amount&#39;: &#39;+20.99&#39;}``&quot;&quot;&quot;</span>
 
+    <span class="n">unit</span> <span class="o">=</span> <span class="n">unit_to_str</span><span class="p">(</span><span class="n">area</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;unit&#39;</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</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">area</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;amount&#39;</span><span class="p">))</span>
 
+            <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">amount</span><span class="p">,</span> <span class="n">unit</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
 
+            <span class="k">pass</span>
 
+    <span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">area</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;amount&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span> <span class="n">area</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;unit&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 657 - 0
_modules/searx/engines/google.html
View File 

@@ -0,0 +1,657 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.google &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.google</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.google</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This is the implementation of the Google WEB engine.  Some of this</span>
 
+<span class="sd">implementations (manly the :py:obj:`get_google_info`) are shared by other</span>
 
+<span class="sd">engines:</span>
 
+
 
+<span class="sd">- :ref:`google images engine`</span>
 
+<span class="sd">- :ref:`google news engine`</span>
 
+<span class="sd">- :ref:`google videos engine`</span>
 
+<span class="sd">- :ref:`google scholar engine`</span>
 
+<span class="sd">- :ref:`google autocomplete`</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</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">random</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">string</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.core</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.languages</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">extract_text</span><span class="p">,</span> <span class="n">eval_xpath</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">,</span> <span class="n">eval_xpath_getindex</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">language_tag</span><span class="p">,</span> <span class="n">region_tag</span><span class="p">,</span> <span class="n">get_official_locales</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</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</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">SearxEngineCaptchaException</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</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">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.google.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q9366&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://developers.google.com/custom-search/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">50</span>
 
+<span class="sd">&quot;&quot;&quot;`Google max 50 pages`_</span>
 
+
 
+<span class="sd">.. _Google max 50 pages: https://github.com/searxng/searxng/issues/2982</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+<span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="s1">&#39;d&#39;</span><span class="p">,</span> <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="s1">&#39;w&#39;</span><span class="p">,</span> <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="s1">&#39;m&#39;</span><span class="p">,</span> <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="s1">&#39;y&#39;</span><span class="p">}</span>
 
+
 
+<span class="c1"># Filter results. 0: None, 1: Moderate, 2: Strict</span>
 
+<span class="n">filter_mapping</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;off&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;medium&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;high&#39;</span><span class="p">}</span>
 
+
 
+<span class="c1"># specific xpath variables</span>
 
+<span class="c1"># ------------------------</span>
 
+
 
+<span class="c1"># Suggestions are links placed in a *card-section*, we extract only the text</span>
 
+<span class="c1"># from the links not the links itself.</span>
 
+<span class="n">suggestion_xpath</span> <span class="o">=</span> <span class="s1">&#39;//div[contains(@class, &quot;EIaa9b&quot;)]//a&#39;</span>
 
+
 
+
 
+<span class="n">_arcid_range</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_letters</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span> <span class="o">+</span> <span class="s2">&quot;_-&quot;</span>
 
+<span class="n">_arcid_random</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">int</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+
 
+<div class="viewcode-block" id="ui_async">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google.ui_async">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">ui_async</span><span class="p">(</span><span class="n">start</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Format of the response from UI&#39;s async request.</span>
 
+
 
+<span class="sd">    - ``arc_id:&lt;...&gt;,use_ac:true,_fmt:prog``</span>
 
+
 
+<span class="sd">    The arc_id is random generated every hour.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">global</span> <span class="n">_arcid_random</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+
 
+    <span class="n">use_ac</span> <span class="o">=</span> <span class="s2">&quot;use_ac:true&quot;</span>
 
+    <span class="c1"># _fmt:html returns a HTTP 500 when user search for celebrities like</span>
 
+    <span class="c1"># &#39;!google natasha allegri&#39; or &#39;!google chris evans&#39;</span>
 
+    <span class="n">_fmt</span> <span class="o">=</span> <span class="s2">&quot;_fmt:prog&quot;</span>
 
+
 
+    <span class="c1"># create a new random arc_id every hour</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">_arcid_random</span> <span class="ow">or</span> <span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">-</span> <span class="n">_arcid_random</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">&gt;</span> <span class="mi">3600</span><span class="p">:</span>
 
+        <span class="n">_arcid_random</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">choices</span><span class="p">(</span><span class="n">_arcid_range</span><span class="p">,</span> <span class="n">k</span><span class="o">=</span><span class="mi">23</span><span class="p">)),</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()))</span>
 
+    <span class="n">arc_id</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;arc_id:srp_</span><span class="si">{</span><span class="n">_arcid_random</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2">_1</span><span class="si">{</span><span class="n">start</span><span class="si">:</span><span class="s2">02</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+    <span class="k">return</span> <span class="s2">&quot;,&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">arc_id</span><span class="p">,</span> <span class="n">use_ac</span><span class="p">,</span> <span class="n">_fmt</span><span class="p">])</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_google_info">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google.get_google_info">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_google_info</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">eng_traits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Composing various (language) properties for the google engines (:ref:`google</span>
 
+<span class="sd">    API`).</span>
 
+
 
+<span class="sd">    This function is called by the various google engines (:ref:`google web</span>
 
+<span class="sd">    engine`, :ref:`google images engine`, :ref:`google news engine` and</span>
 
+<span class="sd">    :ref:`google videos engine`).</span>
 
+
 
+<span class="sd">    :param dict param: Request parameters of the engine.  At least</span>
 
+<span class="sd">        a ``searxng_locale`` key should be in the dictionary.</span>
 
+
 
+<span class="sd">    :param eng_traits: Engine&#39;s traits fetched from google preferences</span>
 
+<span class="sd">        (:py:obj:`searx.enginelib.traits.EngineTraits`)</span>
 
+
 
+<span class="sd">    :rtype: dict</span>
 
+<span class="sd">    :returns:</span>
 
+<span class="sd">        Py-Dictionary with the key/value pairs:</span>
 
+
 
+<span class="sd">        language:</span>
 
+<span class="sd">            The language code that is used by google (e.g. ``lang_en`` or</span>
 
+<span class="sd">            ``lang_zh-TW``)</span>
 
+
 
+<span class="sd">        country:</span>
 
+<span class="sd">            The country code that is used by google (e.g. ``US`` or ``TW``)</span>
 
+
 
+<span class="sd">        locale:</span>
 
+<span class="sd">            A instance of :py:obj:`babel.core.Locale` build from the</span>
 
+<span class="sd">            ``searxng_locale`` value.</span>
 
+
 
+<span class="sd">        subdomain:</span>
 
+<span class="sd">            Google subdomain :py:obj:`google_domains` that fits to the country</span>
 
+<span class="sd">            code.</span>
 
+
 
+<span class="sd">        params:</span>
 
+<span class="sd">            Py-Dictionary with additional request arguments (can be passed to</span>
 
+<span class="sd">            :py:func:`urllib.parse.urlencode`).</span>
 
+
 
+<span class="sd">            - ``hl`` parameter: specifies the interface language of user interface.</span>
 
+<span class="sd">            - ``lr`` parameter: restricts search results to documents written in</span>
 
+<span class="sd">              a particular language.</span>
 
+<span class="sd">            - ``cr`` parameter: restricts search results to documents</span>
 
+<span class="sd">              originating in a particular country.</span>
 
+<span class="sd">            - ``ie`` parameter: sets the character encoding scheme that should</span>
 
+<span class="sd">              be used to interpret the query string (&#39;utf8&#39;).</span>
 
+<span class="sd">            - ``oe`` parameter: sets the character encoding scheme that should</span>
 
+<span class="sd">              be used to decode the XML result (&#39;utf8&#39;).</span>
 
+
 
+<span class="sd">        headers:</span>
 
+<span class="sd">            Py-Dictionary with additional HTTP headers (can be passed to</span>
 
+<span class="sd">            request&#39;s headers)</span>
 
+
 
+<span class="sd">            - ``Accept: &#39;*/*``</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">ret_val</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;language&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+        <span class="s1">&#39;country&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+        <span class="s1">&#39;subdomain&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+        <span class="s1">&#39;params&#39;</span><span class="p">:</span> <span class="p">{},</span>
 
+        <span class="s1">&#39;headers&#39;</span><span class="p">:</span> <span class="p">{},</span>
 
+        <span class="s1">&#39;cookies&#39;</span><span class="p">:</span> <span class="p">{},</span>
 
+        <span class="s1">&#39;locale&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">sxng_locale</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="s1">&#39;searxng_locale&#39;</span><span class="p">,</span> <span class="s1">&#39;all&#39;</span><span class="p">)</span>
 
+    <span class="k">try</span><span class="p">:</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="n">sxng_locale</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</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="n">locale</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+    <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="s1">&#39;lang_en&#39;</span><span class="p">)</span>
 
+    <span class="n">lang_code</span> <span class="o">=</span> <span class="n">eng_lang</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>  <span class="c1"># lang_zh-TW --&gt; zh-TW / lang_en --&gt; en</span>
 
+    <span class="n">country</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>
 
+
 
+    <span class="c1"># Test zh_hans &amp; zh_hant --&gt; in the topmost links in the result list of list</span>
 
+    <span class="c1"># TW and HK you should a find wiktionary.org zh_hant link.  In the result</span>
 
+    <span class="c1"># list of zh-CN should not be no hant link instead you should find</span>
 
+    <span class="c1"># zh.m.wikipedia.org/zh somewhere in the top.</span>
 
+
 
+    <span class="c1"># &#39;!go 日 :zh-TW&#39; --&gt; https://zh.m.wiktionary.org/zh-hant/%E6%97%A5</span>
 
+    <span class="c1"># &#39;!go 日 :zh-CN&#39; --&gt; https://zh.m.wikipedia.org/zh/%E6%97%A5</span>
 
+
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_lang</span>
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;country&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">country</span>
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;locale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">locale</span>
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;supported_domains&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">country</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="s1">&#39;www.google.com&#39;</span><span class="p">)</span>
 
+
 
+    <span class="c1"># hl parameter:</span>
 
+    <span class="c1">#   The hl parameter specifies the interface language (host language) of</span>
 
+    <span class="c1">#   your user interface. To improve the performance and the quality of your</span>
 
+    <span class="c1">#   search results, you are strongly encouraged to set this parameter</span>
 
+    <span class="c1">#   explicitly.</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results#hlsp</span>
 
+    <span class="c1"># The Interface Language:</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages</span>
 
+
 
+    <span class="c1"># https://github.com/searxng/searxng/issues/2515#issuecomment-1607150817</span>
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;hl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">lang_code</span><span class="si">}</span><span class="s1">-</span><span class="si">{</span><span class="n">country</span><span class="si">}</span><span class="s1">&#39;</span>
 
+
 
+    <span class="c1"># lr parameter:</span>
 
+    <span class="c1">#   The lr (language restrict) parameter restricts search results to</span>
 
+    <span class="c1">#   documents written in a particular language.</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results#lrsp</span>
 
+    <span class="c1">#   Language Collection Values:</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results_appendices#languageCollections</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># To select &#39;all&#39; languages an empty &#39;lr&#39; value is used.</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># Different to other google services, Google Scholar supports to select more</span>
 
+    <span class="c1"># than one language. The languages are separated by a pipe &#39;|&#39; (logical OR).</span>
 
+    <span class="c1"># By example: &amp;lr=lang_zh-TW%7Clang_de selects articles written in</span>
 
+    <span class="c1"># traditional chinese OR german language.</span>
 
+
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;lr&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_lang</span>
 
+    <span class="k">if</span> <span class="n">sxng_locale</span> <span class="o">==</span> <span class="s1">&#39;all&#39;</span><span class="p">:</span>
 
+        <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;lr&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+
 
+    <span class="c1"># cr parameter:</span>
 
+    <span class="c1">#   The cr parameter restricts search results to documents originating in a</span>
 
+    <span class="c1">#   particular country.</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results#crsp</span>
 
+
 
+    <span class="c1"># specify a region (country) only if a region is given in the selected</span>
 
+    <span class="c1"># locale --&gt; https://github.com/searxng/searxng/issues/2672</span>
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;cr&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sxng_locale</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">))</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;cr&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;country&#39;</span> <span class="o">+</span> <span class="n">country</span>
 
+
 
+    <span class="c1"># gl parameter: (mandatory by Google News)</span>
 
+    <span class="c1">#   The gl parameter value is a two-letter country code. For WebSearch</span>
 
+    <span class="c1">#   results, the gl parameter boosts search results whose country of origin</span>
 
+    <span class="c1">#   matches the parameter value. See the Country Codes section for a list of</span>
 
+    <span class="c1">#   valid values.</span>
 
+    <span class="c1">#   Specifying a gl parameter value in WebSearch requests should improve the</span>
 
+    <span class="c1">#   relevance of results. This is particularly true for international</span>
 
+    <span class="c1">#   customers and, even more specifically, for customers in English-speaking</span>
 
+    <span class="c1">#   countries other than the United States.</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results#glsp</span>
 
+
 
+    <span class="c1"># https://github.com/searxng/searxng/issues/2515#issuecomment-1606294635</span>
 
+    <span class="c1"># ret_val[&#39;params&#39;][&#39;gl&#39;] = country</span>
 
+
 
+    <span class="c1"># ie parameter:</span>
 
+    <span class="c1">#   The ie parameter sets the character encoding scheme that should be used</span>
 
+    <span class="c1">#   to interpret the query string. The default ie value is latin1.</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results#iesp</span>
 
+
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;ie&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;utf8&#39;</span>
 
+
 
+    <span class="c1"># oe parameter:</span>
 
+    <span class="c1">#   The oe parameter sets the character encoding scheme that should be used</span>
 
+    <span class="c1">#   to decode the XML result. The default oe value is latin1.</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results#oesp</span>
 
+
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;oe&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;utf8&#39;</span>
 
+
 
+    <span class="c1"># num parameter:</span>
 
+    <span class="c1">#   The num parameter identifies the number of search results to return.</span>
 
+    <span class="c1">#   The default num value is 10, and the maximum value is 20. If you request</span>
 
+    <span class="c1">#   more than 20 results, only 20 results will be returned.</span>
 
+    <span class="c1">#   https://developers.google.com/custom-search/docs/xml_results#numsp</span>
 
+
 
+    <span class="c1"># HINT: seems to have no effect (tested in google WEB &amp; Images)</span>
 
+    <span class="c1"># ret_val[&#39;params&#39;][&#39;num&#39;] = 20</span>
 
+
 
+    <span class="c1"># HTTP headers</span>
 
+
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Accept&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;*/*&#39;</span>
 
+
 
+    <span class="c1"># Cookies</span>
 
+
 
+    <span class="c1"># - https://github.com/searxng/searxng/pull/1679#issuecomment-1235432746</span>
 
+    <span class="c1"># - https://github.com/searxng/searxng/issues/1555</span>
 
+    <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;CONSENT&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;YES+&quot;</span>
 
+
 
+    <span class="k">return</span> <span class="n">ret_val</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">detect_google_sorry</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">url</span><span class="o">.</span><span class="n">host</span> <span class="o">==</span> <span class="s1">&#39;sorry.google.com&#39;</span> <span class="ow">or</span> <span class="n">resp</span><span class="o">.</span><span class="n">url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/sorry&#39;</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">()</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Google search request&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=line-too-long</span>
 
+    <span class="n">start</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span>
 
+    <span class="n">str_async</span> <span class="o">=</span> <span class="n">ui_async</span><span class="p">(</span><span class="n">start</span><span class="p">)</span>
 
+    <span class="n">google_info</span> <span class="o">=</span> <span class="n">get_google_info</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">traits</span><span class="p">)</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;ARC_ID: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">str_async</span><span class="p">)</span>
 
+
 
+    <span class="c1"># https://www.google.de/search?q=corona&amp;hl=de&amp;lr=lang_de&amp;start=0&amp;tbs=qdr%3Ad&amp;safe=medium</span>
 
+    <span class="n">query_url</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s1">&#39;https://&#39;</span>
 
+        <span class="o">+</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span>
 
+        <span class="o">+</span> <span class="s1">&#39;/search&#39;</span>
 
+        <span class="o">+</span> <span class="s2">&quot;?&quot;</span>
 
+        <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+                <span class="o">**</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;filter&#39;</span><span class="p">:</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;start&#39;</span><span class="p">:</span> <span class="n">start</span><span class="p">,</span>
 
+                <span class="c1"># &#39;vet&#39;: &#39;12ahUKEwik3ZbIzfn7AhXMX_EDHbUDBh0QxK8CegQIARAC..i&#39;,</span>
 
+                <span class="c1"># &#39;ved&#39;: &#39;2ahUKEwik3ZbIzfn7AhXMX_EDHbUDBh0Q_skCegQIARAG&#39;,</span>
 
+                <span class="c1"># &#39;cs&#39; : 1,</span>
 
+                <span class="c1"># &#39;sa&#39;: &#39;N&#39;,</span>
 
+                <span class="c1"># &#39;yv&#39;: 3,</span>
 
+                <span class="c1"># &#39;prmd&#39;: &#39;vin&#39;,</span>
 
+                <span class="c1"># &#39;ei&#39;: &#39;GASaY6TxOcy_xc8PtYeY6AE&#39;,</span>
 
+                <span class="c1"># &#39;sa&#39;: &#39;N&#39;,</span>
 
+                <span class="c1"># &#39;sstk&#39;: &#39;AcOHfVkD7sWCSAheZi-0tx_09XDO55gTWY0JNq3_V26cNN-c8lfD45aZYPI8s_Bqp8s57AHz5pxchDtAGCA_cikAWSjy9kw3kgg&#39;</span>
 
+                <span class="c1"># formally known as use_mobile_ui</span>
 
+                <span class="s1">&#39;asearch&#39;</span><span class="p">:</span> <span class="s1">&#39;arc&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;async&#39;</span><span class="p">:</span> <span class="n">str_async</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
 
+        <span class="n">query_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;tbs&#39;</span><span class="p">:</span> <span class="s1">&#39;qdr:&#39;</span> <span class="o">+</span> <span class="n">time_range_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]})</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]:</span>
 
+        <span class="n">query_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;safe&#39;</span><span class="p">:</span> <span class="n">filter_mapping</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]]})</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query_url</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<span class="c1"># =26;[3,&quot;dimg_ZNMiZPCqE4apxc8P3a2tuAQ_137&quot;]a87;data:image/jpeg;base64,/9j/4AAQSkZJRgABA</span>
 
+<span class="c1"># ...6T+9Nl4cnD+gr9OK8I56/tX3l86nWYw//2Q==26;</span>
 
+<span class="n">RE_DATA_IMAGE</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="s1">&#39;&quot;(dimg_[^&quot;]*)&quot;[^;]*;(data:image[^;]*;[^;]*);&#39;</span><span class="p">)</span>
 
+<span class="n">RE_DATA_IMAGE_end</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="s1">&#39;&quot;(dimg_[^&quot;]*)&quot;[^;]*;(data:image[^;]*;[^;]*)$&#39;</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">parse_data_images</span><span class="p">(</span><span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
 
+    <span class="n">data_image_map</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="k">for</span> <span class="n">img_id</span><span class="p">,</span> <span class="n">data_image</span> <span class="ow">in</span> <span class="n">RE_DATA_IMAGE</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
 
+        <span class="n">end_pos</span> <span class="o">=</span> <span class="n">data_image</span><span class="o">.</span><span class="n">rfind</span><span class="p">(</span><span class="s1">&#39;=&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">end_pos</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 
+            <span class="n">data_image</span> <span class="o">=</span> <span class="n">data_image</span><span class="p">[:</span> <span class="n">end_pos</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span>
 
+        <span class="n">data_image_map</span><span class="p">[</span><span class="n">img_id</span><span class="p">]</span> <span class="o">=</span> <span class="n">data_image</span>
 
+    <span class="n">last</span> <span class="o">=</span> <span class="n">RE_DATA_IMAGE_end</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">last</span><span class="p">:</span>
 
+        <span class="n">data_image_map</span><span class="p">[</span><span class="n">last</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)]</span> <span class="o">=</span> <span class="n">last</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;data:image objects --&gt; </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="nb">list</span><span class="p">(</span><span class="n">data_image_map</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
 
+    <span class="k">return</span> <span class="n">data_image_map</span>
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get response from google&#39;s search request&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=too-many-branches, too-many-statements</span>
 
+    <span class="n">detect_google_sorry</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+    <span class="n">data_image_map</span> <span class="o">=</span> <span class="n">parse_data_images</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="c1"># convert the text to dom</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="c1"># results --&gt; answer</span>
 
+    <span class="n">answer_list</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[contains(@class, &quot;LGOjhe&quot;)]&#39;</span><span class="p">)</span>
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">answer_list</span><span class="p">:</span>
 
+        <span class="k">for</span> <span class="n">bubble</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//div[@class=&quot;nnFGuf&quot;]&#39;</span><span class="p">):</span>
 
+            <span class="n">bubble</span><span class="o">.</span><span class="n">drop_tree</span><span class="p">()</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span>
 
+                <span class="n">answer</span><span class="o">=</span><span class="n">extract_text</span><span class="p">(</span><span class="n">item</span><span class="p">),</span>
 
+                <span class="n">url</span><span class="o">=</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;../..//a/@href&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="p">[</span><span class="kc">None</span><span class="p">])[</span><span class="mi">0</span><span class="p">],</span>
 
+            <span class="p">)</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="c1"># parse results</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@jscontroller, &quot;SC7lYd&quot;)]&#39;</span><span class="p">):</span>
 
+        <span class="c1"># pylint: disable=too-many-nested-blocks</span>
 
+
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">title_tag</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//a/h3[1]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">title_tag</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="c1"># this not one of the common google results *section*</span>
 
+                <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;ignoring item from the result_xpath list: missing title&#39;</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+            <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">title_tag</span><span class="p">)</span>
 
+
 
+            <span class="n">url</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//a[h3]/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">url</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;ignoring item from the result_xpath list: missing url of title &quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span><span class="p">,</span> <span class="n">title</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="n">content_nodes</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@data-sncf, &quot;1&quot;)]&#39;</span><span class="p">)</span>
 
+            <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">content_nodes</span><span class="p">:</span>
 
+                <span class="k">for</span> <span class="n">script</span> <span class="ow">in</span> <span class="n">item</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s2">&quot;.//script&quot;</span><span class="p">):</span>
 
+                    <span class="n">script</span><span class="o">.</span><span class="n">getparent</span><span class="p">()</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">script</span><span class="p">)</span>
 
+
 
+            <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">content_nodes</span><span class="p">)</span>
 
+
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">content</span><span class="p">:</span>
 
+                <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;ignoring item from the result_xpath list: missing content of title &quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span><span class="p">,</span> <span class="n">title</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">content_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//img/@src&#39;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">thumbnail</span><span class="p">:</span>
 
+                <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">thumbnail</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+                <span class="k">if</span> <span class="n">thumbnail</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;data:image&#39;</span><span class="p">):</span>
 
+                    <span class="n">img_id</span> <span class="o">=</span> <span class="n">content_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;.//img/@id&#39;</span><span class="p">)</span>
 
+                    <span class="k">if</span> <span class="n">img_id</span><span class="p">:</span>
 
+                        <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">data_image_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">img_id</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">thumbnail</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span> <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</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="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+
 
+    <span class="c1"># parse suggestion</span>
 
+    <span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">suggestion_xpath</span><span class="p">):</span>
 
+        <span class="c1"># append suggestion</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">suggestion</span><span class="p">)})</span>
 
+
 
+    <span class="c1"># return results</span>
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+
 
+<span class="c1"># get supported languages from their site</span>
 
+
 
+
 
+<span class="n">skip_countries</span> <span class="o">=</span> <span class="p">[</span>
 
+    <span class="c1"># official language of google-country not in google-languages</span>
 
+    <span class="s1">&#39;AL&#39;</span><span class="p">,</span>  <span class="c1"># Albanien (sq)</span>
 
+    <span class="s1">&#39;AZ&#39;</span><span class="p">,</span>  <span class="c1"># Aserbaidschan  (az)</span>
 
+    <span class="s1">&#39;BD&#39;</span><span class="p">,</span>  <span class="c1"># Bangladesch (bn)</span>
 
+    <span class="s1">&#39;BN&#39;</span><span class="p">,</span>  <span class="c1"># Brunei Darussalam (ms)</span>
 
+    <span class="s1">&#39;BT&#39;</span><span class="p">,</span>  <span class="c1"># Bhutan (dz)</span>
 
+    <span class="s1">&#39;ET&#39;</span><span class="p">,</span>  <span class="c1"># Äthiopien (am)</span>
 
+    <span class="s1">&#39;GE&#39;</span><span class="p">,</span>  <span class="c1"># Georgien (ka, os)</span>
 
+    <span class="s1">&#39;GL&#39;</span><span class="p">,</span>  <span class="c1"># Grönland (kl)</span>
 
+    <span class="s1">&#39;KH&#39;</span><span class="p">,</span>  <span class="c1"># Kambodscha (km)</span>
 
+    <span class="s1">&#39;LA&#39;</span><span class="p">,</span>  <span class="c1"># Laos (lo)</span>
 
+    <span class="s1">&#39;LK&#39;</span><span class="p">,</span>  <span class="c1"># Sri Lanka (si, ta)</span>
 
+    <span class="s1">&#39;ME&#39;</span><span class="p">,</span>  <span class="c1"># Montenegro (sr)</span>
 
+    <span class="s1">&#39;MK&#39;</span><span class="p">,</span>  <span class="c1"># Nordmazedonien (mk, sq)</span>
 
+    <span class="s1">&#39;MM&#39;</span><span class="p">,</span>  <span class="c1"># Myanmar (my)</span>
 
+    <span class="s1">&#39;MN&#39;</span><span class="p">,</span>  <span class="c1"># Mongolei (mn)</span>
 
+    <span class="s1">&#39;MV&#39;</span><span class="p">,</span>  <span class="c1"># Malediven (dv) // dv_MV is unknown by babel</span>
 
+    <span class="s1">&#39;MY&#39;</span><span class="p">,</span>  <span class="c1"># Malaysia (ms)</span>
 
+    <span class="s1">&#39;NP&#39;</span><span class="p">,</span>  <span class="c1"># Nepal (ne)</span>
 
+    <span class="s1">&#39;TJ&#39;</span><span class="p">,</span>  <span class="c1"># Tadschikistan (tg)</span>
 
+    <span class="s1">&#39;TM&#39;</span><span class="p">,</span>  <span class="c1"># Turkmenistan (tk)</span>
 
+    <span class="s1">&#39;UZ&#39;</span><span class="p">,</span>  <span class="c1"># Usbekistan (uz)</span>
 
+<span class="p">]</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">,</span> <span class="n">add_domains</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages from Google.&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=import-outside-toplevel, too-many-branches</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;supported_domains&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://www.google.com/preferences&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Response from Google&#39;s preferences is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
 
+
 
+    <span class="c1"># supported language codes</span>
 
+
 
+    <span class="n">lang_map</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;no&#39;</span><span class="p">:</span> <span class="s1">&#39;nb&#39;</span><span class="p">}</span>
 
+    <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//select[@name=&#39;hl&#39;]/option&quot;</span><span class="p">):</span>
 
+        <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span>
 
+        <span class="k">try</span><span class="p">:</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="n">lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_lang</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;INFO:  google UI language </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">) is unknown by babel&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">eng_lang</span><span class="p">,</span> <span class="n">x</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;(&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">sxng_lang</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_lang</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_lang</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_lang</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_lang</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;lang_&#39;</span> <span class="o">+</span> <span class="n">eng_lang</span>
 
+
 
+    <span class="c1"># alias languages</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="s1">&#39;zh&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;lang_zh-CN&#39;</span>
 
+
 
+    <span class="c1"># supported region codes</span>
 
+
 
+    <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//select[@name=&#39;gl&#39;]/option&quot;</span><span class="p">):</span>
 
+        <span class="n">eng_country</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="n">eng_country</span> <span class="ow">in</span> <span class="n">skip_countries</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">if</span> <span class="n">eng_country</span> <span class="o">==</span> <span class="s1">&#39;ZZ&#39;</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="s1">&#39;ZZ&#39;</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">sxng_locales</span> <span class="o">=</span> <span class="n">get_official_locales</span><span class="p">(</span><span class="n">eng_country</span><span class="p">,</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">keys</span><span class="p">(),</span> <span class="n">regional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">sxng_locales</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: can&#39;t map from google country </span><span class="si">%s</span><span class="s2"> (</span><span class="si">%s</span><span class="s2">) to a babel region.&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;data-name&#39;</span><span class="p">),</span> <span class="n">eng_country</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="k">for</span> <span class="n">sxng_locale</span> <span class="ow">in</span> <span class="n">sxng_locales</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">region_tag</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">eng_country</span>
 
+
 
+    <span class="c1"># alias regions</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="s1">&#39;zh-CN&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;HK&#39;</span>
 
+
 
+    <span class="c1"># supported domains</span>
 
+
 
+    <span class="k">if</span> <span class="n">add_domains</span><span class="p">:</span>
 
+        <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://www.google.com/supported_domains&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Response from https://www.google.com/supported_domains is not OK.&quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">for</span> <span class="n">domain</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">split</span><span class="p">():</span>  <span class="c1"># type: ignore</span>
 
+            <span class="n">domain</span> <span class="o">=</span> <span class="n">domain</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">domain</span> <span class="ow">or</span> <span class="n">domain</span> <span class="ow">in</span> <span class="p">[</span>
 
+                <span class="s1">&#39;.google.com&#39;</span><span class="p">,</span>
 
+            <span class="p">]:</span>
 
+                <span class="k">continue</span>
 
+            <span class="n">region</span> <span class="o">=</span> <span class="n">domain</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;supported_domains&#39;</span><span class="p">][</span><span class="n">region</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;www&#39;</span> <span class="o">+</span> <span class="n">domain</span>  <span class="c1"># type: ignore</span>
 
+            <span class="k">if</span> <span class="n">region</span> <span class="o">==</span> <span class="s1">&#39;HK&#39;</span><span class="p">:</span>
 
+                <span class="c1"># There is no google.cn, we use .com.hk for zh-CN</span>
 
+                <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;supported_domains&#39;</span><span class="p">][</span><span class="s1">&#39;CN&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;www&#39;</span> <span class="o">+</span> <span class="n">domain</span>  <span class="c1"># type: ignore</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 246 - 0
_modules/searx/engines/google_images.html
View File 

@@ -0,0 +1,246 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.google_images &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.google_images</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.google_images</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This is the implementation of the Google Images engine using the internal</span>
 
+<span class="sd">Google API used by the Google Go Android app.</span>
 
+
 
+<span class="sd">This internal API offer results in</span>
 
+
 
+<span class="sd">- JSON (``_fmt:json``)</span>
 
+<span class="sd">- Protobuf_ (``_fmt:pb``)</span>
 
+<span class="sd">- Protobuf_ compressed? (``_fmt:pc``)</span>
 
+<span class="sd">- HTML (``_fmt:html``)</span>
 
+<span class="sd">- Protobuf_ encoded in JSON (``_fmt:jspb``).</span>
 
+
 
+<span class="sd">.. _Protobuf: https://en.wikipedia.org/wiki/Protocol_Buffers</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="kn">import</span> <span class="n">loads</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.google</span><span class="w"> </span><span class="kn">import</span> <span class="n">fetch_traits</span>  <span class="c1"># pylint: disable=unused-import</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.google</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">get_google_info</span><span class="p">,</span>
 
+    <span class="n">time_range_dict</span><span class="p">,</span>
 
+    <span class="n">detect_google_sorry</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://images.google.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q521550&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://developers.google.com/custom-search&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;images&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">50</span>
 
+<span class="sd">&quot;&quot;&quot;`Google max 50 pages`_</span>
 
+
 
+<span class="sd">.. _Google max 50 pages: https://github.com/searxng/searxng/issues/2982</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+<span class="n">filter_mapping</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;images&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;active&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;active&#39;</span><span class="p">}</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_images.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Google-Image search request&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">google_info</span> <span class="o">=</span> <span class="n">get_google_info</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">traits</span><span class="p">)</span>
 
+
 
+    <span class="n">query_url</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s1">&#39;https://&#39;</span>
 
+        <span class="o">+</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span>
 
+        <span class="o">+</span> <span class="s1">&#39;/search&#39;</span>
 
+        <span class="o">+</span> <span class="s1">&#39;?&#39;</span>
 
+        <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span> <span class="s1">&#39;tbm&#39;</span><span class="p">:</span> <span class="s2">&quot;isch&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">],</span> <span class="s1">&#39;asearch&#39;</span><span class="p">:</span> <span class="s1">&#39;isch&#39;</span><span class="p">})</span>
 
+        <span class="c1"># don&#39;t urlencode this because wildly different AND bad results</span>
 
+        <span class="c1"># pagination uses Zero-based numbering</span>
 
+        <span class="o">+</span> <span class="sa">f</span><span class="s1">&#39;&amp;async=_fmt:json,p:1,ijn:</span><span class="si">{</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">]</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="mi">1</span><span class="si">}</span><span class="s1">&#39;</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
 
+        <span class="n">query_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;tbs&#39;</span><span class="p">:</span> <span class="s1">&#39;qdr:&#39;</span> <span class="o">+</span> <span class="n">time_range_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]})</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]:</span>
 
+        <span class="n">query_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;safe&#39;</span><span class="p">:</span> <span class="n">filter_mapping</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]]})</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query_url</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">])</span>
 
+    <span class="c1"># this ua will allow getting ~50 results instead of 10. #1641</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;User-Agent&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s1">&#39;NSTN/3.60.474802233.release Dalvik/2.1.0 (Linux; U; Android 12;&#39;</span> <span class="sa">f</span><span class="s1">&#39; </span><span class="si">{</span><span class="n">google_info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;country&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;US&quot;</span><span class="p">)</span><span class="si">}</span><span class="s1">) gzip&#39;</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_images.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get response from google&#39;s search request&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="n">detect_google_sorry</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+    <span class="n">json_start</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;{&quot;ischj&quot;:&#39;</span><span class="p">)</span>
 
+    <span class="n">json_data</span> <span class="o">=</span> <span class="n">loads</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">[</span><span class="n">json_start</span><span class="p">:])</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">json_data</span><span class="p">[</span><span class="s2">&quot;ischj&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;metadata&quot;</span><span class="p">,</span> <span class="p">[]):</span>
 
+        <span class="n">result_item</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;result&quot;</span><span class="p">][</span><span class="s2">&quot;referrer_url&quot;</span><span class="p">],</span>
 
+            <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;result&quot;</span><span class="p">][</span><span class="s2">&quot;page_title&quot;</span><span class="p">],</span>
 
+            <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;text_in_grid&quot;</span><span class="p">][</span><span class="s2">&quot;snippet&quot;</span><span class="p">],</span>
 
+            <span class="s1">&#39;source&#39;</span><span class="p">:</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;result&quot;</span><span class="p">][</span><span class="s2">&quot;site_title&quot;</span><span class="p">],</span>
 
+            <span class="s1">&#39;resolution&#39;</span><span class="p">:</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">item</span><span class="p">[</span><span class="s2">&quot;original_image&quot;</span><span class="p">][</span><span class="s2">&quot;width&quot;</span><span class="p">]</span><span class="si">}</span><span class="s1"> x </span><span class="si">{</span><span class="n">item</span><span class="p">[</span><span class="s2">&quot;original_image&quot;</span><span class="p">][</span><span class="s2">&quot;height&quot;</span><span class="p">]</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;original_image&quot;</span><span class="p">][</span><span class="s2">&quot;url&quot;</span><span class="p">],</span>
 
+            <span class="s1">&#39;thumbnail_src&#39;</span><span class="p">:</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;thumbnail&quot;</span><span class="p">][</span><span class="s2">&quot;url&quot;</span><span class="p">],</span>
 
+            <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;images.html&#39;</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+
 
+        <span class="n">author</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;result&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;iptc&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;creator&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">author</span><span class="p">:</span>
 
+            <span class="n">result_item</span><span class="p">[</span><span class="s1">&#39;author&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">author</span><span class="p">)</span>
 
+
 
+        <span class="n">copyright_notice</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;result&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;iptc&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;copyright_notice&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">copyright_notice</span><span class="p">:</span>
 
+            <span class="n">result_item</span><span class="p">[</span><span class="s1">&#39;source&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39; | &#39;</span> <span class="o">+</span> <span class="n">copyright_notice</span>
 
+
 
+        <span class="n">freshness_date</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;result&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;freshness_date&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">freshness_date</span><span class="p">:</span>
 
+            <span class="n">result_item</span><span class="p">[</span><span class="s1">&#39;source&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39; | &#39;</span> <span class="o">+</span> <span class="n">freshness_date</span>
 
+
 
+        <span class="n">file_size</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;gsa&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;file_size&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">file_size</span><span class="p">:</span>
 
+            <span class="n">result_item</span><span class="p">[</span><span class="s1">&#39;source&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39; (</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="n">file_size</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">result_item</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 418 - 0
_modules/searx/engines/google_news.html
View File 

@@ -0,0 +1,418 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.google_news &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.google_news</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.google_news</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This is the implementation of the Google News engine.</span>
 
+
 
+<span class="sd">Google News has a different region handling compared to Google WEB.</span>
 
+
 
+<span class="sd">- the ``ceid`` argument has to be set (:py:obj:`ceid_list`)</span>
 
+<span class="sd">- the hl_ argument has to be set correctly (and different to Google WEB)</span>
 
+<span class="sd">- the gl_ argument is mandatory</span>
 
+
 
+<span class="sd">If one of this argument is not set correctly, the request is redirected to</span>
 
+<span class="sd">CONSENT dialog::</span>
 
+
 
+<span class="sd">  https://consent.google.com/m?continue=</span>
 
+
 
+<span class="sd">The google news API ignores some parameters from the common :ref:`google API`:</span>
 
+
 
+<span class="sd">- num_ : the number of search results is ignored / there is no paging all</span>
 
+<span class="sd">  results for a query term are in the first response.</span>
 
+<span class="sd">- save_ : is ignored / Google-News results are always *SafeSearch*</span>
 
+
 
+<span class="sd">.. _hl: https://developers.google.com/custom-search/docs/xml_results#hlsp</span>
 
+<span class="sd">.. _gl: https://developers.google.com/custom-search/docs/xml_results#glsp</span>
 
+<span class="sd">.. _num: https://developers.google.com/custom-search/docs/xml_results#numsp</span>
 
+<span class="sd">.. _save: https://developers.google.com/custom-search/docs/xml_results#safesp</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">base64</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">locales</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="p">(</span>
 
+    <span class="n">eval_xpath</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_list</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_getindex</span><span class="p">,</span>
 
+    <span class="n">extract_text</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.google</span><span class="w"> </span><span class="kn">import</span> <span class="n">fetch_traits</span> <span class="k">as</span> <span class="n">_fetch_traits</span>  <span class="c1"># pylint: disable=unused-import</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.google</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">get_google_info</span><span class="p">,</span>
 
+    <span class="n">detect_google_sorry</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://news.google.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q12020&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://developers.google.com/custom-search&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;news&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">False</span>
 
+
 
+<span class="c1"># Google-News results are always *SafeSearch*. Option &#39;safesearch&#39; is set to</span>
 
+<span class="c1"># False here, otherwise checker will report safesearch-errors::</span>
 
+<span class="c1">#</span>
 
+<span class="c1">#  safesearch : results are identical for safesearch=0 and safesearch=2</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="c1"># send_accept_language_header = True</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_news.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Google-News search request&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">sxng_locale</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="s1">&#39;searxng_locale&#39;</span><span class="p">,</span> <span class="s1">&#39;en-US&#39;</span><span class="p">)</span>
 
+    <span class="n">ceid</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">get_engine_locale</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;ceid&#39;</span><span class="p">],</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;US:en&#39;</span><span class="p">)</span>
 
+    <span class="n">google_info</span> <span class="o">=</span> <span class="n">get_google_info</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">traits</span><span class="p">)</span>
 
+    <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;news.google.com&#39;</span>  <span class="c1"># google news has only one domain</span>
 
+
 
+    <span class="n">ceid_region</span><span class="p">,</span> <span class="n">ceid_lang</span> <span class="o">=</span> <span class="n">ceid</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;:&#39;</span><span class="p">)</span>
 
+    <span class="n">ceid_lang</span><span class="p">,</span> <span class="n">ceid_suffix</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="n">ceid_lang</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="p">[</span>
 
+            <span class="kc">None</span><span class="p">,</span>
 
+        <span class="p">]</span>
 
+    <span class="p">)[:</span><span class="mi">2</span><span class="p">]</span>
 
+
 
+    <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;hl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ceid_lang</span>
 
+
 
+    <span class="k">if</span> <span class="n">ceid_suffix</span> <span class="ow">and</span> <span class="n">ceid_suffix</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;Hans&#39;</span><span class="p">,</span> <span class="s1">&#39;Hant&#39;</span><span class="p">]:</span>
 
+
 
+        <span class="k">if</span> <span class="n">ceid_region</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">ceid_lang</span><span class="p">:</span>
 
+            <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;hl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ceid_lang</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">ceid_region</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;hl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ceid_lang</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">ceid_suffix</span>
 
+
 
+    <span class="k">elif</span> <span class="n">ceid_region</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">!=</span> <span class="n">ceid_lang</span><span class="p">:</span>
 
+
 
+        <span class="k">if</span> <span class="n">ceid_region</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;AT&#39;</span><span class="p">,</span> <span class="s1">&#39;BE&#39;</span><span class="p">,</span> <span class="s1">&#39;CH&#39;</span><span class="p">,</span> <span class="s1">&#39;IL&#39;</span><span class="p">,</span> <span class="s1">&#39;SA&#39;</span><span class="p">,</span> <span class="s1">&#39;IN&#39;</span><span class="p">,</span> <span class="s1">&#39;BD&#39;</span><span class="p">,</span> <span class="s1">&#39;PT&#39;</span><span class="p">]:</span>
 
+            <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;hl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ceid_lang</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;hl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ceid_lang</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">ceid_region</span>
 
+
 
+    <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;lr&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;lang_&#39;</span> <span class="o">+</span> <span class="n">ceid_lang</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+    <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">][</span><span class="s1">&#39;gl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ceid_region</span>
 
+
 
+    <span class="n">query_url</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s1">&#39;https://&#39;</span>
 
+        <span class="o">+</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span>
 
+        <span class="o">+</span> <span class="s2">&quot;/search?&quot;</span>
 
+        <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+                <span class="o">**</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">],</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+        <span class="c1"># ceid includes a &#39;:&#39; character which must not be urlencoded</span>
 
+        <span class="o">+</span> <span class="p">(</span><span class="s1">&#39;&amp;ceid=</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">ceid</span><span class="p">)</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query_url</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_news.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get response from google&#39;s search request&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">detect_google_sorry</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+    <span class="c1"># convert the text to dom</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[@class=&quot;xrnccd&quot;]&#39;</span><span class="p">):</span>
 
+
 
+        <span class="c1"># The first &lt;a&gt; tag in the &lt;article&gt; contains the link to the article</span>
 
+        <span class="c1"># The href attribute of the &lt;a&gt; tag is a google internal link, we have</span>
 
+        <span class="c1"># to decode</span>
 
+
 
+        <span class="n">href</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;./article/a/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
 
+        <span class="n">href</span> <span class="o">=</span> <span class="n">href</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;?&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">href</span> <span class="o">=</span> <span class="n">href</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+        <span class="n">href</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">urlsafe_b64decode</span><span class="p">(</span><span class="n">href</span> <span class="o">+</span> <span class="s1">&#39;====&#39;</span><span class="p">)</span>
 
+        <span class="n">href</span> <span class="o">=</span> <span class="n">href</span><span class="p">[</span><span class="n">href</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;http&#39;</span><span class="p">)</span> <span class="p">:]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\xd2</span><span class="s1">&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">href</span> <span class="o">=</span> <span class="n">href</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
 
+
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;./article/h3[1]&#39;</span><span class="p">))</span>
 
+
 
+        <span class="c1"># The pub_date is mostly a string like &#39;yesterday&#39;, not a real</span>
 
+        <span class="c1"># timezone date or time.  Therefore we can&#39;t use publishedDate.</span>
 
+        <span class="n">pub_date</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;./article//time&#39;</span><span class="p">))</span>
 
+        <span class="n">pub_origin</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;./article//a[@data-n-tid]&#39;</span><span class="p">))</span>
 
+
 
+        <span class="n">content</span> <span class="o">=</span> <span class="s1">&#39; / &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">[</span><span class="n">pub_origin</span><span class="p">,</span> <span class="n">pub_date</span><span class="p">]</span> <span class="k">if</span> <span class="n">x</span><span class="p">])</span>
 
+
 
+        <span class="c1"># The image URL is located in a preceding sibling &lt;img&gt; tag, e.g.:</span>
 
+        <span class="c1"># &quot;https://lh3.googleusercontent.com/DjhQh7DMszk.....z=-p-h100-w100&quot;</span>
 
+        <span class="c1"># These URL are long but not personalized (double checked via tor).</span>
 
+
 
+        <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;preceding-sibling::a/figure/img/@src&#39;</span><span class="p">))</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">href</span><span class="p">,</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="c1"># return results</span>
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+
 
+<span class="n">ceid_list</span> <span class="o">=</span> <span class="p">[</span>
 
+    <span class="s1">&#39;AE:ar&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;AR:es-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;AT:de&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;AU:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;BD:bn&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;BE:fr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;BE:nl&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;BG:bg&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;BR:pt-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;BW:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CA:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CA:fr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CH:de&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CH:fr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CL:es-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CN:zh-Hans&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CO:es-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CU:es-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;CZ:cs&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;DE:de&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;EG:ar&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ES:es&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ET:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;FR:fr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;GB:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;GH:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;GR:el&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;HK:zh-Hant&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;HU:hu&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ID:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ID:id&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IE:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IL:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IL:he&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IN:bn&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IN:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IN:hi&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IN:ml&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IN:mr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IN:ta&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IN:te&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;IT:it&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;JP:ja&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;KE:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;KR:ko&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;LB:ar&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;LT:lt&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;LV:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;LV:lv&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;MA:fr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;MX:es-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;MY:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;NA:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;NG:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;NL:nl&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;NO:no&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;NZ:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;PE:es-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;PH:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;PK:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;PL:pl&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;PT:pt-150&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;RO:ro&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;RS:sr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;RU:ru&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;SA:ar&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;SE:sv&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;SG:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;SI:sl&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;SK:sk&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;SN:fr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;TH:th&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;TR:tr&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;TW:zh-Hant&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;TZ:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;UA:ru&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;UA:uk&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;UG:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;US:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;US:es-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;VE:es-419&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;VN:vi&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ZA:en&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ZW:en&#39;</span><span class="p">,</span>
 
+<span class="p">]</span>
 
+<span class="sd">&quot;&quot;&quot;List of region/language combinations supported by Google News.  Values of the</span>
 
+<span class="sd">``ceid`` argument of the Google News REST API.&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="n">_skip_values</span> <span class="o">=</span> <span class="p">[</span>
 
+    <span class="s1">&#39;ET:en&#39;</span><span class="p">,</span>  <span class="c1"># english (ethiopia)</span>
 
+    <span class="s1">&#39;ID:en&#39;</span><span class="p">,</span>  <span class="c1"># english (indonesia)</span>
 
+    <span class="s1">&#39;LV:en&#39;</span><span class="p">,</span>  <span class="c1"># english (latvia)</span>
 
+<span class="p">]</span>
 
+
 
+<span class="n">_ceid_locale_map</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;NO:no&#39;</span><span class="p">:</span> <span class="s1">&#39;nb-NO&#39;</span><span class="p">}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+    <span class="n">_fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">,</span> <span class="n">add_domains</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;ceid&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="k">for</span> <span class="n">ceid</span> <span class="ow">in</span> <span class="n">ceid_list</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">ceid</span> <span class="ow">in</span> <span class="n">_skip_values</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">region</span><span class="p">,</span> <span class="n">lang</span> <span class="o">=</span> <span class="n">ceid</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;:&#39;</span><span class="p">)</span>
 
+        <span class="n">x</span> <span class="o">=</span> <span class="n">lang</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;Hant&#39;</span><span class="p">,</span> <span class="s1">&#39;Hans&#39;</span><span class="p">]:</span>
 
+                <span class="n">lang</span> <span class="o">=</span> <span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+
 
+        <span class="n">sxng_locale</span> <span class="o">=</span> <span class="n">_ceid_locale_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">ceid</span><span class="p">,</span> <span class="n">lang</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">region</span><span class="p">)</span>
 
+        <span class="k">try</span><span class="p">:</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="n">sxng_locale</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: </span><span class="si">%s</span><span class="s2"> -&gt; </span><span class="si">%s</span><span class="s2"> is unknown by babel&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ceid</span><span class="p">,</span> <span class="n">sxng_locale</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;ceid&#39;</span><span class="p">][</span><span class="n">locales</span><span class="o">.</span><span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">ceid</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 344 - 0
_modules/searx/engines/google_scholar.html
View File 

@@ -0,0 +1,344 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.google_scholar &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.google_scholar</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.google_scholar</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This is the implementation of the Google Scholar engine.</span>
 
+
 
+<span class="sd">Compared to other Google services the Scholar engine has a simple GET REST-API</span>
 
+<span class="sd">and there does not exists `async` API.  Even though the API slightly vintage we</span>
 
+<span class="sd">can make use of the :ref:`google API` to assemble the arguments of the GET</span>
 
+<span class="sd">request.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Optional</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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="p">(</span>
 
+    <span class="n">eval_xpath</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_getindex</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_list</span><span class="p">,</span>
 
+    <span class="n">extract_text</span><span class="p">,</span>
 
+<span class="p">)</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">SearxEngineCaptchaException</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.google</span><span class="w"> </span><span class="kn">import</span> <span class="n">fetch_traits</span>  <span class="c1"># pylint: disable=unused-import</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.google</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">get_google_info</span><span class="p">,</span>
 
+    <span class="n">time_range_dict</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://scholar.google.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q494817&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://developers.google.com/custom-search&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;science&#39;</span><span class="p">,</span> <span class="s1">&#39;scientific publications&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">50</span>
 
+<span class="sd">&quot;&quot;&quot;`Google max 50 pages`_</span>
 
+
 
+<span class="sd">.. _Google max 50 pages: https://github.com/searxng/searxng/issues/2982</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="n">language_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+
 
+<div class="viewcode-block" id="time_range_args">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_scholar.time_range_args">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">time_range_args</span><span class="p">(</span><span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a dictionary with a time range arguments based on</span>
 
+<span class="sd">    ``params[&#39;time_range&#39;]``.</span>
 
+
 
+<span class="sd">    Google Scholar supports a detailed search by year.  Searching by *last</span>
 
+<span class="sd">    month* or *last week* (as offered by SearXNG) is uncommon for scientific</span>
 
+<span class="sd">    publications and is not supported by Google Scholar.</span>
 
+
 
+<span class="sd">    To limit the result list when the users selects a range, all the SearXNG</span>
 
+<span class="sd">    ranges (*day*, *week*, *month*, *year*) are mapped to *year*.  If no range</span>
 
+<span class="sd">    is set an empty dictionary of arguments is returned.  Example;  when</span>
 
+<span class="sd">    user selects a time range (current year minus one in 2022):</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">        { &#39;as_ylo&#39; : 2021 }</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">ret_val</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
 
+        <span class="n">ret_val</span><span class="p">[</span><span class="s1">&#39;as_ylo&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">year</span> <span class="o">-</span> <span class="mi">1</span>
 
+    <span class="k">return</span> <span class="n">ret_val</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="detect_google_captcha">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_scholar.detect_google_captcha">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">detect_google_captcha</span><span class="p">(</span><span class="n">dom</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;In case of CAPTCHA Google Scholar open its own *not a Robot* dialog and is</span>
 
+<span class="sd">    not redirected to ``sorry.google.com``.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//form[@id=&#39;gs_captcha_f&#39;]&quot;</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">()</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_scholar.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Google-Scholar search request&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">google_info</span> <span class="o">=</span> <span class="n">get_google_info</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">traits</span><span class="p">)</span>
 
+    <span class="c1"># subdomain is: scholar.google.xy</span>
 
+    <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;www.&quot;</span><span class="p">,</span> <span class="s2">&quot;scholar.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="o">**</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">],</span>
 
+        <span class="s1">&#39;start&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span><span class="p">,</span>
 
+        <span class="s1">&#39;as_sdt&#39;</span><span class="p">:</span> <span class="s1">&#39;2007&#39;</span><span class="p">,</span>  <span class="c1"># include patents / to disable set &#39;0,5&#39;</span>
 
+        <span class="s1">&#39;as_vis&#39;</span><span class="p">:</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span>  <span class="c1"># include citations / to disable set &#39;1&#39;</span>
 
+    <span class="p">}</span>
 
+    <span class="n">args</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">time_range_args</span><span class="p">(</span><span class="n">params</span><span class="p">))</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https://&#39;</span> <span class="o">+</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span> <span class="o">+</span> <span class="s1">&#39;/scholar?&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="parse_gs_a">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_scholar.parse_gs_a">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">parse_gs_a</span><span class="p">(</span><span class="n">text</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse the text written in green.</span>
 
+
 
+<span class="sd">    Possible formats:</span>
 
+<span class="sd">    * &quot;{authors} - {journal}, {year} - {publisher}&quot;</span>
 
+<span class="sd">    * &quot;{authors} - {year} - {publisher}&quot;</span>
 
+<span class="sd">    * &quot;{authors} - {publisher}&quot;</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="n">text</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">text</span> <span class="o">==</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span>
 
+
 
+    <span class="n">s_text</span> <span class="o">=</span> <span class="n">text</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39; - &#39;</span><span class="p">)</span>
 
+    <span class="n">authors</span> <span class="o">=</span> <span class="n">s_text</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;, &#39;</span><span class="p">)</span>
 
+    <span class="n">publisher</span> <span class="o">=</span> <span class="n">s_text</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">s_text</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">3</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">authors</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">publisher</span><span class="p">,</span> <span class="kc">None</span>
 
+
 
+    <span class="c1"># the format is &quot;{authors} - {journal}, {year} - {publisher}&quot; or &quot;{authors} - {year} - {publisher}&quot;</span>
 
+    <span class="c1"># get journal and year</span>
 
+    <span class="n">journal_year</span> <span class="o">=</span> <span class="n">s_text</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;, &#39;</span><span class="p">)</span>
 
+    <span class="c1"># journal is optional and may contains some coma</span>
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">journal_year</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="n">journal</span> <span class="o">=</span> <span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">journal_year</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
 
+        <span class="k">if</span> <span class="n">journal</span> <span class="o">==</span> <span class="s1">&#39;…&#39;</span><span class="p">:</span>
 
+            <span class="n">journal</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">journal</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="c1"># year</span>
 
+    <span class="n">year</span> <span class="o">=</span> <span class="n">journal_year</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">publishedDate</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">year</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span> <span class="s1">&#39;%Y&#39;</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
 
+        <span class="n">publishedDate</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="k">return</span> <span class="n">authors</span><span class="p">,</span> <span class="n">journal</span><span class="p">,</span> <span class="n">publisher</span><span class="p">,</span> <span class="n">publishedDate</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_scholar.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>  <span class="c1"># pylint: disable=too-many-locals</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse response from Google Scholar&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="c1"># convert the text to dom</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+    <span class="n">detect_google_captcha</span><span class="p">(</span><span class="n">dom</span><span class="p">)</span>
 
+
 
+    <span class="c1"># parse results</span>
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[@data-rp]&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//h3[1]//a&#39;</span><span class="p">))</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">title</span><span class="p">:</span>
 
+            <span class="c1"># this is a [ZITATION] block</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">pub_type</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//span[@class=&quot;gs_ctg2&quot;]&#39;</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="n">pub_type</span><span class="p">:</span>
 
+            <span class="n">pub_type</span> <span class="o">=</span> <span class="n">pub_type</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
 
+
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//h3[1]//a/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[@class=&quot;gs_rs&quot;]&#39;</span><span class="p">))</span>
 
+        <span class="n">authors</span><span class="p">,</span> <span class="n">journal</span><span class="p">,</span> <span class="n">publisher</span><span class="p">,</span> <span class="n">publishedDate</span> <span class="o">=</span> <span class="n">parse_gs_a</span><span class="p">(</span>
 
+            <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[@class=&quot;gs_a&quot;]&#39;</span><span class="p">))</span>
 
+        <span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">publisher</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
 
+            <span class="n">publisher</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+        <span class="c1"># cited by</span>
 
+        <span class="n">comments</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[@class=&quot;gs_fl&quot;]/a[starts-with(@href,&quot;/scholar?cites=&quot;)]&#39;</span><span class="p">))</span>
 
+
 
+        <span class="c1"># link to the html or pdf document</span>
 
+        <span class="n">html_url</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="n">pdf_url</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="n">doc_url</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[@class=&quot;gs_or_ggsm&quot;]/a/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
+        <span class="n">doc_type</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//span[@class=&quot;gs_ctg2&quot;]&#39;</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="n">doc_type</span> <span class="o">==</span> <span class="s2">&quot;[PDF]&quot;</span><span class="p">:</span>
 
+            <span class="n">pdf_url</span> <span class="o">=</span> <span class="n">doc_url</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">html_url</span> <span class="o">=</span> <span class="n">doc_url</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;paper.html&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;type&#39;</span><span class="p">:</span> <span class="n">pub_type</span><span class="p">,</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                <span class="s1">&#39;authors&#39;</span><span class="p">:</span> <span class="n">authors</span><span class="p">,</span>
 
+                <span class="s1">&#39;publisher&#39;</span><span class="p">:</span> <span class="n">publisher</span><span class="p">,</span>
 
+                <span class="s1">&#39;journal&#39;</span><span class="p">:</span> <span class="n">journal</span><span class="p">,</span>
 
+                <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">publishedDate</span><span class="p">,</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                <span class="s1">&#39;comments&#39;</span><span class="p">:</span> <span class="n">comments</span><span class="p">,</span>
 
+                <span class="s1">&#39;html_url&#39;</span><span class="p">:</span> <span class="n">html_url</span><span class="p">,</span>
 
+                <span class="s1">&#39;pdf_url&#39;</span><span class="p">:</span> <span class="n">pdf_url</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="c1"># parse suggestion</span>
 
+    <span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[contains(@class, &quot;gs_qsuggest_wrap&quot;)]//li//a&#39;</span><span class="p">):</span>
 
+        <span class="c1"># append suggestion</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">suggestion</span><span class="p">)})</span>
 
+
 
+    <span class="k">for</span> <span class="n">correction</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[@class=&quot;gs_r gs_pda&quot;]/a&#39;</span><span class="p">):</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;correction&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">correction</span><span class="p">)})</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 267 - 0
_modules/searx/engines/google_videos.html
View File 

@@ -0,0 +1,267 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.google_videos &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.google_videos</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.google_videos</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This is the implementation of the Google Videos engine.</span>
 
+
 
+<span class="sd">.. admonition:: Content-Security-Policy (CSP)</span>
 
+
 
+<span class="sd">   This engine needs to allow images from the `data URLs`_ (prefixed with the</span>
 
+<span class="sd">   ``data:`` scheme)::</span>
 
+
 
+<span class="sd">     Header set Content-Security-Policy &quot;img-src &#39;self&#39; data: ;&quot;</span>
 
+
 
+<span class="sd">.. _data URLs:</span>
 
+<span class="sd">   https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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="p">(</span>
 
+    <span class="n">eval_xpath</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_list</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_getindex</span><span class="p">,</span>
 
+    <span class="n">extract_text</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.google</span><span class="w"> </span><span class="kn">import</span> <span class="n">fetch_traits</span>  <span class="c1"># pylint: disable=unused-import</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.google</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">get_google_info</span><span class="p">,</span>
 
+    <span class="n">time_range_dict</span><span class="p">,</span>
 
+    <span class="n">filter_mapping</span><span class="p">,</span>
 
+    <span class="n">suggestion_xpath</span><span class="p">,</span>
 
+    <span class="n">detect_google_sorry</span><span class="p">,</span>
 
+    <span class="n">ui_async</span><span class="p">,</span>
 
+    <span class="n">parse_data_images</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</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_embeded_stream_url</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.google.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q219885&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://developers.google.com/custom-search&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;videos&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">50</span>
 
+<span class="sd">&quot;&quot;&quot;`Google: max 50 pages`</span>
 
+
 
+<span class="sd">.. _Google: max 50 pages: https://github.com/searxng/searxng/issues/2982</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="n">language_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_videos.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Google-Video search request&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">google_info</span> <span class="o">=</span> <span class="n">get_google_info</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="n">traits</span><span class="p">)</span>
 
+    <span class="n">start</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span>
 
+
 
+    <span class="n">query_url</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s1">&#39;https://&#39;</span>
 
+        <span class="o">+</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;subdomain&#39;</span><span class="p">]</span>
 
+        <span class="o">+</span> <span class="s1">&#39;/search&#39;</span>
 
+        <span class="o">+</span> <span class="s2">&quot;?&quot;</span>
 
+        <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+                <span class="s1">&#39;tbm&#39;</span><span class="p">:</span> <span class="s2">&quot;vid&quot;</span><span class="p">,</span>
 
+                <span class="s1">&#39;start&#39;</span><span class="p">:</span> <span class="mi">10</span> <span class="o">*</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">],</span>
 
+                <span class="o">**</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;params&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;asearch&#39;</span><span class="p">:</span> <span class="s1">&#39;arc&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;async&#39;</span><span class="p">:</span> <span class="n">ui_async</span><span class="p">(</span><span class="n">start</span><span class="p">),</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
 
+        <span class="n">query_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;tbs&#39;</span><span class="p">:</span> <span class="s1">&#39;qdr:&#39;</span> <span class="o">+</span> <span class="n">time_range_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]})</span>
 
+    <span class="k">if</span> <span class="s1">&#39;safesearch&#39;</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
 
+        <span class="n">query_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;safe&#39;</span><span class="p">:</span> <span class="n">filter_mapping</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]]})</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query_url</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">google_info</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/google.html#searx.engines.google_videos.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get response from google&#39;s search request&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="n">detect_google_sorry</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+    <span class="n">data_image_map</span> <span class="o">=</span> <span class="n">parse_data_images</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="c1"># convert the text to dom</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="c1"># parse results</span>
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[contains(@class, &quot;g &quot;)]&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//img/@src&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">thumbnail</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">thumbnail</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;data:image&#39;</span><span class="p">):</span>
 
+                <span class="n">img_id</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//img/@id&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="n">img_id</span><span class="p">:</span>
 
+                    <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">data_image_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">img_id</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">thumbnail</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//a/h3[1]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//a/h3[1]/../@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
 
+
 
+        <span class="n">c_node</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;ITZIwc&quot;)]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">c_node</span><span class="p">)</span>
 
+        <span class="n">pub_info</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;gqF9jc&quot;)]&#39;</span><span class="p">))</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                <span class="s1">&#39;author&#39;</span><span class="p">:</span> <span class="n">pub_info</span><span class="p">,</span>
 
+                <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+                <span class="s1">&#39;iframe_src&#39;</span><span class="p">:</span> <span class="n">get_embeded_stream_url</span><span class="p">(</span><span class="n">url</span><span class="p">),</span>
 
+                <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;videos.html&#39;</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="c1"># parse suggestion</span>
 
+    <span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">suggestion_xpath</span><span class="p">):</span>
 
+        <span class="c1"># append suggestion</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">suggestion</span><span class="p">)})</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 537 - 0
_modules/searx/engines/json_engine.html
View File 

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

+ 181 - 0
_modules/searx/engines/mrs.html
View File 

@@ -0,0 +1,181 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.mrs &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.mrs</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.mrs</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Matrix Rooms Search - a fully-featured, standalone, matrix rooms search service.</span>
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">The engine has the following mandatory settings:</span>
 
+
 
+<span class="sd">- :py:obj:`base_url`</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: MRS</span>
 
+<span class="sd">    engine: mrs</span>
 
+<span class="sd">    base_url: https://mrs-host</span>
 
+<span class="sd">    ...</span>
 
+
 
+<span class="sd">Implementation</span>
 
+<span class="sd">==============</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">quote_plus</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://matrixrooms.info&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://gitlab.com/etke.cc/mrs/api/-/blob/main/openapi.yml?ref_type=heads&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;social media&#39;</span><span class="p">]</span>
 
+
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="n">matrix_url</span> <span class="o">=</span> <span class="s2">&quot;https://matrix.to&quot;</span>
 
+<span class="n">page_size</span> <span class="o">=</span> <span class="mi">20</span>
 
+
 
+
 
+<div class="viewcode-block" id="init">
 
+<a class="viewcode-back" href="../../../dev/engines/online/mrs.html#searx.engines.mrs.init">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">):</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The ``base_url`` must be set in the configuration, if ``base_url`` is not</span>
 
+<span class="sd">    set, a :py:obj:`ValueError` is raised during initialization.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">base_url</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;engine MRS, base_url is unset&#39;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s2">/search/</span><span class="si">{</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">page_size</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span><span class="o">*</span><span class="n">page_size</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">():</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">matrix_url</span> <span class="o">+</span> <span class="s1">&#39;/#/&#39;</span> <span class="o">+</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;alias&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;topic&#39;</span><span class="p">]</span>
 
+                <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot; // </span><span class="si">{</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;members&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2"> members&quot;</span>
 
+                <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot; // </span><span class="si">{</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;alias&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span>
 
+                <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot; // </span><span class="si">{</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;server&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
 
+                <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;avatar_url&#39;</span><span class="p">],</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 390 - 0
_modules/searx/engines/mullvad_leta.html
View File 

@@ -0,0 +1,390 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.mullvad_leta &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.mullvad_leta</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.mullvad_leta</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Mullvad Leta is a search engine proxy. Currently Leta only offers text</span>
 
+<span class="sd">search results not image, news or any other types of search result.  Leta acts</span>
 
+<span class="sd">as a proxy to Google and Brave search results. You can select which backend</span>
 
+<span class="sd">search engine you wish to use, see  (:py:obj:`leta_engine`).</span>
 
+
 
+<span class="sd">.. hint::</span>
 
+
 
+<span class="sd">   Leta caches each search for up to 30 days.  For example, if you use search</span>
 
+<span class="sd">   terms like ``news``, contrary to your intention you&#39;ll get very old results!</span>
 
+
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">The engine has the following additional settings:</span>
 
+
 
+<span class="sd">- :py:obj:`leta_engine` (:py:obj:`LetaEnginesType`)</span>
 
+
 
+<span class="sd">You can configure one Leta engine for Google and one for Brave:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: mullvadleta</span>
 
+<span class="sd">    engine: mullvad_leta</span>
 
+<span class="sd">    leta_engine: google</span>
 
+<span class="sd">    shortcut: ml</span>
 
+
 
+<span class="sd">  - name: mullvadleta brave</span>
 
+<span class="sd">    engine: mullvad_leta</span>
 
+<span class="sd">    network: mullvadleta  # use network from engine &quot;mullvadleta&quot; configured above</span>
 
+<span class="sd">    leta_engine: brave</span>
 
+<span class="sd">    shortcut: mlb</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">httpx</span><span class="w"> </span><span class="kn">import</span> <span class="n">Response</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_official_locales</span><span class="p">,</span> <span class="n">language_tag</span><span class="p">,</span> <span class="n">region_tag</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">eval_xpath_list</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="p">,</span> <span class="n">MainResult</span>
 
+
 
+<span class="k">if</span> <span class="n">typing</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">logging</span>
 
+
 
+    <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">search_url</span> <span class="o">=</span> <span class="s2">&quot;https://leta.mullvad.net&quot;</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="n">search_url</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q47008412&#39;</span><span class="p">,</span>  <span class="c1"># the Mullvad id - not leta, but related</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://leta.mullvad.net/faq&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;general&quot;</span><span class="p">,</span> <span class="s2">&quot;web&quot;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">10</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;day&quot;</span><span class="p">:</span> <span class="s2">&quot;d&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;week&quot;</span><span class="p">:</span> <span class="s2">&quot;w&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;month&quot;</span><span class="p">:</span> <span class="s2">&quot;m&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;year&quot;</span><span class="p">:</span> <span class="s2">&quot;y&quot;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">LetaEnginesType</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;google&quot;</span><span class="p">,</span> <span class="s2">&quot;brave&quot;</span><span class="p">]</span>
 
+<span class="sd">&quot;&quot;&quot;Engine types supported by mullvadleta.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">leta_engine</span><span class="p">:</span> <span class="n">LetaEnginesType</span> <span class="o">=</span> <span class="s2">&quot;google&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;Select Leta&#39;s engine type from :py:obj:`LetaEnginesType`.&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">_</span><span class="p">):</span>
 
+    <span class="n">l</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">get_args</span><span class="p">(</span><span class="n">LetaEnginesType</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">leta_engine</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">l</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;leta_engine &#39;</span><span class="si">{</span><span class="n">leta_engine</span><span class="si">}</span><span class="s2">&#39; is invalid, use one of </span><span class="si">{</span><span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">l</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="DataNodeQueryMetaDataIndices">
 
+<a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.DataNodeQueryMetaDataIndices">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">DataNodeQueryMetaDataIndices</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Indices into query metadata.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">success</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">q</span><span class="p">:</span> <span class="nb">int</span>  <span class="c1"># pylint: disable=invalid-name</span>
 
+    <span class="n">country</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">language</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">lastUpdated</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">engine</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">items</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">infobox</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">news</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">timestamp</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">altered</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">page</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="nb">next</span><span class="p">:</span> <span class="nb">int</span>  <span class="c1"># if -1, there no more results are available</span>
 
+    <span class="n">previous</span><span class="p">:</span> <span class="nb">int</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="DataNodeResultIndices">
 
+<a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.DataNodeResultIndices">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">DataNodeResultIndices</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Indices into query resultsdata.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">link</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">snippet</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">title</span><span class="p">:</span> <span class="nb">int</span>
 
+    <span class="n">favicon</span><span class="p">:</span> <span class="nb">int</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s2">&quot;method&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;GET&quot;</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;q&quot;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s2">&quot;engine&quot;</span><span class="p">:</span> <span class="n">leta_engine</span><span class="p">,</span>
 
+        <span class="s2">&quot;x-sveltekit-invalidated&quot;</span><span class="p">:</span> <span class="s2">&quot;001&quot;</span><span class="p">,</span>  <span class="c1"># hardcoded from all requests seen</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">country</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;searxng_locale&quot;</span><span class="p">),</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="k">if</span> <span class="n">country</span><span class="p">:</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s2">&quot;country&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">country</span>
 
+
 
+    <span class="n">language</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;searxng_locale&quot;</span><span class="p">),</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="k">if</span> <span class="n">language</span><span class="p">:</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s2">&quot;language&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">language</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;time_range&quot;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s2">&quot;lastUpdated&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_range_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;time_range&quot;</span><span class="p">]]</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">]</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s2">&quot;page&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">]</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">search_url</span><span class="si">}</span><span class="s2">/search/__data.json?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">:</span> <span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+    <span class="n">json_response</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+
 
+    <span class="n">nodes</span> <span class="o">=</span> <span class="n">json_response</span><span class="p">[</span><span class="s2">&quot;nodes&quot;</span><span class="p">]</span>
 
+    <span class="c1"># 0: is None</span>
 
+    <span class="c1"># 1: has &quot;connected=True&quot;, not useful</span>
 
+    <span class="c1"># 2: query results within &quot;data&quot;</span>
 
+
 
+    <span class="n">data_nodes</span> <span class="o">=</span> <span class="n">nodes</span><span class="p">[</span><span class="mi">2</span><span class="p">][</span><span class="s2">&quot;data&quot;</span><span class="p">]</span>
 
+    <span class="c1"># Instead of nested object structure, all objects are flattened into a</span>
 
+    <span class="c1"># list. Rather, the first object in data_node provides indices into the</span>
 
+    <span class="c1"># &quot;data_nodes&quot; to access each searchresult (which is an object of more</span>
 
+    <span class="c1"># indices)</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># Read the relative TypedDict definitions for details</span>
 
+
 
+    <span class="n">query_meta_data</span><span class="p">:</span> <span class="n">DataNodeQueryMetaDataIndices</span> <span class="o">=</span> <span class="n">data_nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+
 
+    <span class="n">query_items_indices</span> <span class="o">=</span> <span class="n">query_meta_data</span><span class="p">[</span><span class="s2">&quot;items&quot;</span><span class="p">]</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+    <span class="k">for</span> <span class="n">idx</span> <span class="ow">in</span> <span class="n">data_nodes</span><span class="p">[</span><span class="n">query_items_indices</span><span class="p">]:</span>
 
+        <span class="n">query_item_indices</span><span class="p">:</span> <span class="n">DataNodeResultIndices</span> <span class="o">=</span> <span class="n">data_nodes</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
 
+            <span class="n">MainResult</span><span class="p">(</span>
 
+                <span class="n">url</span><span class="o">=</span><span class="n">data_nodes</span><span class="p">[</span><span class="n">query_item_indices</span><span class="p">[</span><span class="s2">&quot;link&quot;</span><span class="p">]],</span>
 
+                <span class="n">title</span><span class="o">=</span><span class="n">data_nodes</span><span class="p">[</span><span class="n">query_item_indices</span><span class="p">[</span><span class="s2">&quot;title&quot;</span><span class="p">]],</span>
 
+                <span class="n">content</span><span class="o">=</span><span class="n">data_nodes</span><span class="p">[</span><span class="n">query_item_indices</span><span class="p">[</span><span class="s2">&quot;snippet&quot;</span><span class="p">]],</span>
 
+            <span class="p">)</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/mullvad_leta.html#searx.engines.mullvad_leta.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages and regions from Mullvad-Leta&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">extract_table_data</span><span class="p">(</span><span class="n">table</span><span class="p">):</span>
 
+        <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">table</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s2">&quot;.//tr&quot;</span><span class="p">)[</span><span class="mi">2</span><span class="p">:]:</span>
 
+            <span class="n">cells</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s2">&quot;.//td | .//th&quot;</span><span class="p">)</span>  <span class="c1"># includes headers and data</span>
 
+            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cells</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>  <span class="c1"># ensure the column exists</span>
 
+                <span class="n">cell0</span> <span class="o">=</span> <span class="n">cells</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">text_content</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+                <span class="n">cell1</span> <span class="o">=</span> <span class="n">cells</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">text_content</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+                <span class="k">yield</span> <span class="p">[</span><span class="n">cell0</span><span class="p">,</span> <span class="n">cell1</span><span class="p">]</span>
 
+
 
+    <span class="c1"># pylint: disable=import-outside-toplevel</span>
 
+    <span class="c1"># see https://github.com/searxng/searxng/issues/762</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</span> <span class="k">as</span> <span class="n">http_get</span>
 
+
 
+    <span class="c1"># pylint: enable=import-outside-toplevel</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">http_get</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">search_url</span><span class="si">}</span><span class="s2">/documentation&quot;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">resp</span><span class="p">,</span> <span class="n">Response</span><span class="p">):</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: failed to get response from mullvad-leta. Are you connected to the VPN?&quot;</span><span class="p">)</span>
 
+        <span class="k">return</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from mullvad-leta is not OK. Are you connected to the VPN?&quot;</span><span class="p">)</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="c1"># There are 4 HTML tables on the documentation page for extracting information:</span>
 
+    <span class="c1"># 0. Keyboard Shortcuts</span>
 
+    <span class="c1"># 1. Query Parameters (shoutout to Mullvad for accessible docs for integration)</span>
 
+    <span class="c1"># 2. Country Codes [Country, Code]</span>
 
+    <span class="c1"># 3. Language Codes [Language, Code]</span>
 
+    <span class="n">tables</span> <span class="o">=</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="o">.</span><span class="n">body</span><span class="p">,</span> <span class="s2">&quot;//table&quot;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">tables</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">tables</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: could not find any tables. Was the page updated?&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">language_table</span> <span class="o">=</span> <span class="n">tables</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
 
+    <span class="n">lang_map</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;zh-hant&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_Hans&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;zh-hans&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_Hant&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;jp&quot;</span><span class="p">:</span> <span class="s2">&quot;ja&quot;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="k">for</span> <span class="n">language</span><span class="p">,</span> <span class="n">code</span> <span class="ow">in</span> <span class="n">extract_table_data</span><span class="p">(</span><span class="n">language_table</span><span class="p">):</span>
 
+
 
+        <span class="n">locale_tag</span> <span class="o">=</span> <span class="n">lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">code</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">try</span><span class="p">:</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="n">locale_tag</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;ERROR: Mullvad-Leta language </span><span class="si">{</span><span class="n">language</span><span class="si">}</span><span class="s2"> (</span><span class="si">{</span><span class="n">code</span><span class="si">}</span><span class="s2">) is unknown by babel&quot;</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">code</span>
 
+
 
+    <span class="n">country_table</span> <span class="o">=</span> <span class="n">tables</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
 
+    <span class="n">country_map</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;cn&quot;</span><span class="p">:</span> <span class="s2">&quot;zh-CN&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;hk&quot;</span><span class="p">:</span> <span class="s2">&quot;zh-HK&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;jp&quot;</span><span class="p">:</span> <span class="s2">&quot;ja-JP&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;my&quot;</span><span class="p">:</span> <span class="s2">&quot;ms-MY&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;tw&quot;</span><span class="p">:</span> <span class="s2">&quot;zh-TW&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;uk&quot;</span><span class="p">:</span> <span class="s2">&quot;en-GB&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;us&quot;</span><span class="p">:</span> <span class="s2">&quot;en-US&quot;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="k">for</span> <span class="n">country</span><span class="p">,</span> <span class="n">code</span> <span class="ow">in</span> <span class="n">extract_table_data</span><span class="p">(</span><span class="n">country_table</span><span class="p">):</span>
 
+
 
+        <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">country_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">code</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">sxng_tag</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">code</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="k">try</span><span class="p">:</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="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">code</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">code</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="n">locale</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+        <span class="k">if</span> <span class="n">locale</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">code</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">official_locales</span> <span class="o">=</span> <span class="n">get_official_locales</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">keys</span><span class="p">(),</span> <span class="n">regional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">official_locales</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;ERROR: Mullvad-Leta country &#39;</span><span class="si">{</span><span class="n">code</span><span class="si">}</span><span class="s2">&#39; (</span><span class="si">{</span><span class="n">country</span><span class="si">}</span><span class="s2">) could not be mapped as expected.&quot;</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="k">for</span> <span class="n">locale</span> <span class="ow">in</span> <span class="n">official_locales</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">code</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 255 - 0
_modules/searx/engines/odysee.html
View File 

@@ -0,0 +1,255 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.odysee &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.odysee</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.odysee</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Odysee_ is a decentralized video hosting platform.</span>
 
+
 
+<span class="sd">.. _Odysee: https://github.com/OdyseeTeam/odysee-frontend</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</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.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">get</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">language_tag</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># Engine metadata</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s2">&quot;https://odysee.com/&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s2">&quot;Q102046570&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s2">&quot;JSON&quot;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># Engine configuration</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">results_per_page</span> <span class="o">=</span> <span class="mi">20</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;videos&#39;</span><span class="p">]</span>
 
+
 
+<span class="c1"># Search URL (Note: lighthouse.lbry.com/search works too, and may be faster at times)</span>
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s2">&quot;https://lighthouse.odysee.tv/search&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+    <span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;day&quot;</span><span class="p">:</span> <span class="s2">&quot;today&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;week&quot;</span><span class="p">:</span> <span class="s2">&quot;thisweek&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;month&quot;</span><span class="p">:</span> <span class="s2">&quot;thismonth&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;year&quot;</span><span class="p">:</span> <span class="s2">&quot;thisyear&quot;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">start_index</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">results_per_page</span>
 
+    <span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;s&quot;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s2">&quot;size&quot;</span><span class="p">:</span> <span class="n">results_per_page</span><span class="p">,</span>
 
+        <span class="s2">&quot;from&quot;</span><span class="p">:</span> <span class="n">start_index</span><span class="p">,</span>
 
+        <span class="s2">&quot;include&quot;</span><span class="p">:</span> <span class="s2">&quot;channel,thumbnail_url,title,description,duration,release_time&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;mediaType&quot;</span><span class="p">:</span> <span class="s2">&quot;video&quot;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">lang</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="kc">None</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">lang</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">lang</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_dict</span><span class="p">:</span>
 
+        <span class="n">query_params</span><span class="p">[</span><span class="s1">&#39;time_filter&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_range_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s2">?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">(</span><span class="n">query_params</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="c1"># Format the video duration</span>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">format_duration</span><span class="p">(</span><span class="n">duration</span><span class="p">):</span>
 
+    <span class="n">seconds</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">duration</span><span class="p">)</span>
 
+    <span class="n">length</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">gmtime</span><span class="p">(</span><span class="n">seconds</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">length</span><span class="o">.</span><span class="n">tm_hour</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">time</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%H:%M:%S&quot;</span><span class="p">,</span> <span class="n">length</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">time</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%M:%S&quot;</span><span class="p">,</span> <span class="n">length</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="n">data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
 
+        <span class="n">name</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;name&quot;</span><span class="p">]</span>
 
+        <span class="n">claim_id</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;claimId&quot;</span><span class="p">]</span>
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;title&quot;</span><span class="p">]</span>
 
+        <span class="n">thumbnail_url</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;thumbnail_url&quot;</span><span class="p">]</span>
 
+        <span class="n">description</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;description&quot;</span><span class="p">]</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span>
 
+        <span class="n">channel</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;channel&quot;</span><span class="p">]</span>
 
+        <span class="n">release_time</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;release_time&quot;</span><span class="p">]</span>
 
+        <span class="n">duration</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;duration&quot;</span><span class="p">]</span>
 
+
 
+        <span class="n">release_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">release_time</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;T&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">&quot;%Y-%m-</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)</span>
 
+        <span class="n">formatted_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">release_date</span><span class="o">.</span><span class="n">timestamp</span><span class="p">())</span>
 
+
 
+        <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://odysee.com/</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">claim_id</span><span class="si">}</span><span class="s2">&quot;</span>
 
+        <span class="n">iframe_url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://odysee.com/$/embed/</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">claim_id</span><span class="si">}</span><span class="s2">&quot;</span>
 
+        <span class="n">odysee_thumbnail</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://thumbnails.odycdn.com/optimize/s:390:0/quality:85/plain/</span><span class="si">{</span><span class="n">thumbnail_url</span><span class="si">}</span><span class="s2">&quot;</span>
 
+        <span class="n">formatted_duration</span> <span class="o">=</span> <span class="n">format_duration</span><span class="p">(</span><span class="n">duration</span><span class="p">)</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s2">&quot;title&quot;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+                <span class="s2">&quot;content&quot;</span><span class="p">:</span> <span class="n">description</span><span class="p">,</span>
 
+                <span class="s2">&quot;author&quot;</span><span class="p">:</span> <span class="n">channel</span><span class="p">,</span>
 
+                <span class="s2">&quot;publishedDate&quot;</span><span class="p">:</span> <span class="n">formatted_date</span><span class="p">,</span>
 
+                <span class="s2">&quot;length&quot;</span><span class="p">:</span> <span class="n">formatted_duration</span><span class="p">,</span>
 
+                <span class="s2">&quot;thumbnail&quot;</span><span class="p">:</span> <span class="n">odysee_thumbnail</span><span class="p">,</span>
 
+                <span class="s2">&quot;iframe_src&quot;</span><span class="p">:</span> <span class="n">iframe_url</span><span class="p">,</span>
 
+                <span class="s2">&quot;template&quot;</span><span class="p">:</span> <span class="s2">&quot;videos.html&quot;</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/odysee.html#searx.engines.odysee.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">    Fetch languages from Odysee&#39;s source code.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span>
 
+        <span class="s1">&#39;https://raw.githubusercontent.com/OdyseeTeam/odysee-frontend/master/ui/constants/supported_browser_languages.js&#39;</span><span class="p">,</span>  <span class="c1"># pylint: disable=line-too-long</span>
 
+        <span class="n">timeout</span><span class="o">=</span><span class="mi">60</span><span class="p">,</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: can&#39;t determine languages from Odysee&quot;</span><span class="p">)</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">4</span><span class="p">]:</span>
 
+        <span class="n">lang_tag</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;: &quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;&#39;&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</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="n">lang_tag</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s2">&quot;-&quot;</span><span class="p">))</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: </span><span class="si">%s</span><span class="s2"> is unknown by babel&quot;</span> <span class="o">%</span> <span class="n">lang_tag</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">lang_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">lang_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">lang_tag</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 301 - 0
_modules/searx/engines/peertube.html
View File 

@@ -0,0 +1,301 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.peertube &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.peertube</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.peertube</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Peertube and :py:obj:`SepiaSearch &lt;searx.engines.sepiasearch&gt;` do share</span>
 
+<span class="sd">(more or less) the same REST API and the schema of the JSON result is identical.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</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">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">dateutil.parser</span><span class="w"> </span><span class="kn">import</span> <span class="n">parse</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">dateutil.relativedelta</span><span class="w"> </span><span class="kn">import</span> <span class="n">relativedelta</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.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">get</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">language_tag</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">html_to_text</span><span class="p">,</span> <span class="n">humanize_number</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="c1"># pylint: disable=line-too-long</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://joinpeertube.org&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q50938515&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://docs.joinpeertube.org/api-rest-reference.html#tag/Search/operation/searchVideos&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;videos&quot;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s2">&quot;https://peer.tube&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;Base URL of the Peertube instance.  A list of instances is available at:</span>
 
+
 
+<span class="sd">- https://instances.joinpeertube.org/instances</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_table</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="n">relativedelta</span><span class="p">(),</span>
 
+    <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="n">relativedelta</span><span class="p">(</span><span class="n">weeks</span><span class="o">=-</span><span class="mi">1</span><span class="p">),</span>
 
+    <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="n">relativedelta</span><span class="p">(</span><span class="n">months</span><span class="o">=-</span><span class="mi">1</span><span class="p">),</span>
 
+    <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="n">relativedelta</span><span class="p">(</span><span class="n">years</span><span class="o">=-</span><span class="mi">1</span><span class="p">),</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch_table</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;both&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;false&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;false&#39;</span><span class="p">}</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/peertube.html#searx.engines.peertube.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Assemble request for the Peertube API&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">query</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">False</span>
 
+
 
+    <span class="c1"># eng_region = traits.get_region(params[&#39;searxng_locale&#39;], &#39;en_US&#39;)</span>
 
+    <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="n">base_url</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot;/api/v1/search/videos?&quot;</span>
 
+        <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;search&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+                <span class="s1">&#39;searchTarget&#39;</span><span class="p">:</span> <span class="s1">&#39;search-index&#39;</span><span class="p">,</span>  <span class="c1"># Vidiversum</span>
 
+                <span class="s1">&#39;resultType&#39;</span><span class="p">:</span> <span class="s1">&#39;videos&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;start&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span><span class="p">,</span>
 
+                <span class="s1">&#39;count&#39;</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
 
+                <span class="c1"># -createdAt: sort by date ascending / createdAt: date descending</span>
 
+                <span class="s1">&#39;sort&#39;</span><span class="p">:</span> <span class="s1">&#39;-match&#39;</span><span class="p">,</span>  <span class="c1"># sort by *match descending*</span>
 
+                <span class="s1">&#39;nsfw&#39;</span><span class="p">:</span> <span class="n">safesearch_table</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]],</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">eng_lang</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39;&amp;languageOneOf[]=&#39;</span> <span class="o">+</span> <span class="n">eng_lang</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39;&amp;boostLanguages[]=&#39;</span> <span class="o">+</span> <span class="n">eng_lang</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_table</span><span class="p">:</span>
 
+        <span class="n">time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">date</span><span class="p">()</span> <span class="o">+</span> <span class="n">time_range_table</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39;&amp;startDate=&#39;</span> <span class="o">+</span> <span class="n">time</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="k">return</span> <span class="n">video_response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="video_response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/peertube.html#searx.engines.peertube.video_response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">video_response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse video response from SepiaSearch and Peertube instances.&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="n">json_data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;data&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">json_data</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="p">[]</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">json_data</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]:</span>
 
+        <span class="n">metadata</span> <span class="o">=</span> <span class="p">[</span>
 
+            <span class="n">x</span>
 
+            <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">[</span>
 
+                <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;channel&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;displayName&#39;</span><span class="p">),</span>
 
+                <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;channel&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39;@&#39;</span> <span class="o">+</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;channel&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;host&#39;</span><span class="p">),</span>
 
+                <span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;tags&#39;</span><span class="p">,</span> <span class="p">[])),</span>
 
+            <span class="p">]</span>
 
+            <span class="k">if</span> <span class="n">x</span>
 
+        <span class="p">]</span>
 
+
 
+        <span class="n">duration</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;duration&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">duration</span><span class="p">:</span>
 
+            <span class="n">duration</span> <span class="o">=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">seconds</span><span class="o">=</span><span class="n">duration</span><span class="p">)</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">html_to_text</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;description&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
 
+                <span class="s1">&#39;author&#39;</span><span class="p">:</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;account&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;displayName&#39;</span><span class="p">),</span>
 
+                <span class="s1">&#39;length&#39;</span><span class="p">:</span> <span class="n">duration</span><span class="p">,</span>
 
+                <span class="s1">&#39;views&#39;</span><span class="p">:</span> <span class="n">humanize_number</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;views&#39;</span><span class="p">]),</span>
 
+                <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;videos.html&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">parse</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;publishedAt&#39;</span><span class="p">]),</span>
 
+                <span class="s1">&#39;iframe_src&#39;</span><span class="p">:</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;embedUrl&#39;</span><span class="p">),</span>
 
+                <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;thumbnailUrl&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;previewUrl&#39;</span><span class="p">),</span>
 
+                <span class="s1">&#39;metadata&#39;</span><span class="p">:</span> <span class="s1">&#39; | &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">metadata</span><span class="p">),</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/peertube.html#searx.engines.peertube.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages from peertube&#39;s search-index source code.</span>
 
+
 
+<span class="sd">    See videoLanguages_ in commit `8ed5c729 - Refactor and redesign client`_</span>
 
+
 
+<span class="sd">    .. _8ed5c729 - Refactor and redesign client:</span>
 
+<span class="sd">       https://framagit.org/framasoft/peertube/search-index/-/commit/8ed5c729</span>
 
+<span class="sd">    .. _videoLanguages:</span>
 
+<span class="sd">       https://framagit.org/framasoft/peertube/search-index/-/commit/8ed5c729#3d8747f9a60695c367c70bb64efba8f403721fad_0_291</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span>
 
+        <span class="s1">&#39;https://framagit.org/framasoft/peertube/search-index/-/raw/master/client/src/components/Filters.vue&#39;</span><span class="p">,</span>
 
+        <span class="c1"># the response from search-index repository is very slow</span>
 
+        <span class="n">timeout</span><span class="o">=</span><span class="mi">60</span><span class="p">,</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from peertube is not OK.&quot;</span><span class="p">)</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="n">js_lang</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;videoLanguages \(\)[^\n]+(.*?)\]&quot;</span><span class="p">,</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">DOTALL</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">js_lang</span><span class="p">:</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: can&#39;t determine languages from peertube&quot;</span><span class="p">)</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="k">for</span> <span class="n">lang</span> <span class="ow">in</span> <span class="n">re</span><span class="o">.</span><span class="n">finditer</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\{ id: &#39;([a-z]+)&#39;, label:&quot;</span><span class="p">,</span> <span class="n">js_lang</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)):</span>
 
+        <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">lang</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">eng_tag</span> <span class="o">==</span> <span class="s1">&#39;oc&#39;</span><span class="p">:</span>
 
+            <span class="c1"># Occitanis not known by babel, its closest relative is Catalan</span>
 
+            <span class="c1"># but &#39;ca&#39; is already in the list of engine_traits.languages --&gt;</span>
 
+            <span class="c1"># &#39;oc&#39; will be ignored.</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</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="n">eng_tag</span><span class="p">))</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: </span><span class="si">%s</span><span class="s2"> is unknown by babel&quot;</span> <span class="o">%</span> <span class="n">eng_tag</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="s1">&#39;zh_Hans&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;zh&#39;</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="s1">&#39;zh_Hant&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;zh&#39;</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 474 - 0
_modules/searx/engines/qwant.html
View File 

@@ -0,0 +1,474 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.qwant &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.qwant</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.qwant</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This engine uses the Qwant API (https://api.qwant.com/v3) to implement Qwant</span>
 
+<span class="sd">-Web, -News, -Images and -Videos.  The API is undocumented but can be reverse</span>
 
+<span class="sd">engineered by reading the network log of https://www.qwant.com/ queries.</span>
 
+
 
+<span class="sd">For Qwant&#39;s *web-search* two alternatives are implemented:</span>
 
+
 
+<span class="sd">- ``web``: uses the :py:obj:`api_url` which returns a JSON structure</span>
 
+<span class="sd">- ``web-lite``: uses the :py:obj:`web_lite_url` which returns a HTML page</span>
 
+
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">The engine has the following additional settings:</span>
 
+
 
+<span class="sd">- :py:obj:`qwant_categ`</span>
 
+
 
+<span class="sd">This implementation is used by different qwant engines in the :ref:`settings.yml</span>
 
+<span class="sd">&lt;settings engines&gt;`:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: qwant</span>
 
+<span class="sd">    qwant_categ: web-lite  # alternatively use &#39;web&#39;</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">  - name: qwant news</span>
 
+<span class="sd">    qwant_categ: news</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">  - name: qwant images</span>
 
+<span class="sd">    qwant_categ: images</span>
 
+<span class="sd">    ...</span>
 
+<span class="sd">  - name: qwant videos</span>
 
+<span class="sd">    qwant_categ: videos</span>
 
+<span class="sd">    ...</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">datetime</span><span class="p">,</span>
 
+    <span class="n">timedelta</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="kn">import</span> <span class="n">loads</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">lxml</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">SearxEngineAPIException</span><span class="p">,</span>
 
+    <span class="n">SearxEngineTooManyRequestsException</span><span class="p">,</span>
 
+    <span class="n">SearxEngineCaptchaException</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">raise_for_httperror</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</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="p">(</span>
 
+    <span class="n">eval_xpath</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_list</span><span class="p">,</span>
 
+    <span class="n">extract_text</span><span class="p">,</span>
 
+    <span class="n">get_embeded_stream_url</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.qwant.com/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q14657870&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">5</span>
 
+<span class="sd">&quot;&quot;&quot;5 pages maximum (``&amp;p=5``): Trying to do more just results in an improper</span>
 
+<span class="sd">redirect&quot;&quot;&quot;</span>
 
+
 
+<span class="n">qwant_categ</span> <span class="o">=</span> <span class="kc">None</span>
 
+<span class="sd">&quot;&quot;&quot;One of ``web-lite`` (or ``web``), ``news``, ``images`` or ``videos``&quot;&quot;&quot;</span>
 
+
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="c1"># safe_search_map = {0: &#39;&amp;safesearch=0&#39;, 1: &#39;&amp;safesearch=1&#39;, 2: &#39;&amp;safesearch=2&#39;}</span>
 
+
 
+<span class="c1"># fmt: off</span>
 
+<span class="n">qwant_news_locales</span> <span class="o">=</span> <span class="p">[</span>
 
+    <span class="s1">&#39;ca_ad&#39;</span><span class="p">,</span> <span class="s1">&#39;ca_es&#39;</span><span class="p">,</span> <span class="s1">&#39;ca_fr&#39;</span><span class="p">,</span> <span class="s1">&#39;co_fr&#39;</span><span class="p">,</span> <span class="s1">&#39;de_at&#39;</span><span class="p">,</span> <span class="s1">&#39;de_ch&#39;</span><span class="p">,</span> <span class="s1">&#39;de_de&#39;</span><span class="p">,</span> <span class="s1">&#39;en_au&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;en_ca&#39;</span><span class="p">,</span> <span class="s1">&#39;en_gb&#39;</span><span class="p">,</span> <span class="s1">&#39;en_ie&#39;</span><span class="p">,</span> <span class="s1">&#39;en_my&#39;</span><span class="p">,</span> <span class="s1">&#39;en_nz&#39;</span><span class="p">,</span> <span class="s1">&#39;en_us&#39;</span><span class="p">,</span> <span class="s1">&#39;es_ad&#39;</span><span class="p">,</span> <span class="s1">&#39;es_ar&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;es_cl&#39;</span><span class="p">,</span> <span class="s1">&#39;es_co&#39;</span><span class="p">,</span> <span class="s1">&#39;es_es&#39;</span><span class="p">,</span> <span class="s1">&#39;es_mx&#39;</span><span class="p">,</span> <span class="s1">&#39;es_pe&#39;</span><span class="p">,</span> <span class="s1">&#39;eu_es&#39;</span><span class="p">,</span> <span class="s1">&#39;eu_fr&#39;</span><span class="p">,</span> <span class="s1">&#39;fc_ca&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;fr_ad&#39;</span><span class="p">,</span> <span class="s1">&#39;fr_be&#39;</span><span class="p">,</span> <span class="s1">&#39;fr_ca&#39;</span><span class="p">,</span> <span class="s1">&#39;fr_ch&#39;</span><span class="p">,</span> <span class="s1">&#39;fr_fr&#39;</span><span class="p">,</span> <span class="s1">&#39;it_ch&#39;</span><span class="p">,</span> <span class="s1">&#39;it_it&#39;</span><span class="p">,</span> <span class="s1">&#39;nl_be&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;nl_nl&#39;</span><span class="p">,</span> <span class="s1">&#39;pt_ad&#39;</span><span class="p">,</span> <span class="s1">&#39;pt_pt&#39;</span><span class="p">,</span>
 
+<span class="p">]</span>
 
+<span class="c1"># fmt: on</span>
 
+
 
+<span class="c1"># search-url</span>
 
+
 
+<span class="n">api_url</span> <span class="o">=</span> <span class="s1">&#39;https://api.qwant.com/v3/search/&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;URL of Qwant&#39;s API (JSON)&quot;&quot;&quot;</span>
 
+
 
+<span class="n">web_lite_url</span> <span class="o">=</span> <span class="s1">&#39;https://lite.qwant.com/&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;URL of Qwant-Lite (HTML)&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/qwant.html#searx.engines.qwant.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Qwant search request&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">query</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="n">q_locale</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;searxng_locale&quot;</span><span class="p">],</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;en_US&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">url</span> <span class="o">=</span> <span class="n">api_url</span> <span class="o">+</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">qwant_categ</span><span class="si">}</span><span class="s1">?&#39;</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;q&#39;</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="s1">&#39;raise_for_httperror&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
 
+
 
+    <span class="k">if</span> <span class="n">qwant_categ</span> <span class="o">==</span> <span class="s1">&#39;web-lite&#39;</span><span class="p">:</span>
 
+
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">web_lite_url</span> <span class="o">+</span> <span class="s1">&#39;?&#39;</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;locale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">q_locale</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;l&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">q_locale</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;s&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;p&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span>
 
+
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;raise_for_httperror&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+    <span class="k">elif</span> <span class="n">qwant_categ</span> <span class="o">==</span> <span class="s1">&#39;images&#39;</span><span class="p">:</span>
 
+
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;locale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">q_locale</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;count&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">50</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;tgp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">3</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;offset&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">args</span><span class="p">[</span><span class="s1">&#39;count&#39;</span><span class="p">]</span>
 
+
 
+    <span class="k">else</span><span class="p">:</span>  <span class="c1"># web, news, videos</span>
 
+
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;locale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">q_locale</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;count&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">10</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;llm&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;false&#39;</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;tgp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">3</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;offset&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">args</span><span class="p">[</span><span class="s1">&#39;count&#39;</span><span class="p">]</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+
 
+    <span class="k">if</span> <span class="n">qwant_categ</span> <span class="o">==</span> <span class="s1">&#39;web-lite&#39;</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">parse_web_lite</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">parse_web_api</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="parse_web_lite">
 
+<a class="viewcode-back" href="../../../dev/engines/online/qwant.html#searx.engines.qwant.parse_web_lite">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">parse_web_lite</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse results from Qwant-Lite&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//section/article&#39;</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">&quot;./span[contains(@class, &#39;tooltip&#39;)]&quot;</span><span class="p">):</span>
 
+            <span class="c1"># ignore randomly interspersed advertising adds</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s2">&quot;./span[contains(@class, &#39;url partner&#39;)]&quot;</span><span class="p">)),</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;./h2/a&#39;</span><span class="p">)),</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;./p&#39;</span><span class="p">)),</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="parse_web_api">
 
+<a class="viewcode-back" href="../../../dev/engines/online/qwant.html#searx.engines.qwant.parse_web_api">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">parse_web_api</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse results from Qwant&#39;s API&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=too-many-locals, too-many-branches, too-many-statements</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="c1"># load JSON result</span>
 
+    <span class="n">search_results</span> <span class="o">=</span> <span class="n">loads</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+    <span class="n">data</span> <span class="o">=</span> <span class="n">search_results</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;data&#39;</span><span class="p">,</span> <span class="p">{})</span>
 
+
 
+    <span class="c1"># check for an API error</span>
 
+    <span class="k">if</span> <span class="n">search_results</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;status&#39;</span><span class="p">)</span> <span class="o">!=</span> <span class="s1">&#39;success&#39;</span><span class="p">:</span>
 
+        <span class="n">error_code</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;error_code&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">error_code</span> <span class="o">==</span> <span class="mi">24</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="n">SearxEngineTooManyRequestsException</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">search_results</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;data&quot;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;error_data&quot;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;captchaUrl&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">()</span>
 
+        <span class="n">msg</span> <span class="o">=</span> <span class="s2">&quot;,&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;message&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;unknown&#39;</span><span class="p">]))</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineAPIException</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">msg</span><span class="si">}</span><span class="s2"> (</span><span class="si">{</span><span class="n">error_code</span><span class="si">}</span><span class="s2">)&quot;</span><span class="p">)</span>
 
+
 
+    <span class="c1"># raise for other errors</span>
 
+    <span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">qwant_categ</span> <span class="o">==</span> <span class="s1">&#39;web&#39;</span><span class="p">:</span>
 
+        <span class="c1"># The WEB query contains a list named &#39;mainline&#39;.  This list can contain</span>
 
+        <span class="c1"># different result types (e.g. mainline[0][&#39;type&#39;] returns type of the</span>
 
+        <span class="c1"># result items in mainline[0][&#39;items&#39;]</span>
 
+        <span class="n">mainline</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;result&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;items&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;mainline&#39;</span><span class="p">,</span> <span class="p">{})</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="c1"># Queries on News, Images and Videos do not have a list named &#39;mainline&#39;</span>
 
+        <span class="c1"># in the response.  The result items are directly in the list</span>
 
+        <span class="c1"># result[&#39;items&#39;].</span>
 
+        <span class="n">mainline</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;result&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;items&#39;</span><span class="p">,</span> <span class="p">[])</span>
 
+        <span class="n">mainline</span> <span class="o">=</span> <span class="p">[</span>
 
+            <span class="p">{</span><span class="s1">&#39;type&#39;</span><span class="p">:</span> <span class="n">qwant_categ</span><span class="p">,</span> <span class="s1">&#39;items&#39;</span><span class="p">:</span> <span class="n">mainline</span><span class="p">},</span>
 
+        <span class="p">]</span>
 
+
 
+    <span class="c1"># return empty array if there are no results</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">mainline</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="p">[]</span>
 
+
 
+    <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">mainline</span><span class="p">:</span>
 
+        <span class="n">mainline_type</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;type&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">mainline_type</span> <span class="o">!=</span> <span class="n">qwant_categ</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="k">if</span> <span class="n">mainline_type</span> <span class="o">==</span> <span class="s1">&#39;ads&#39;</span><span class="p">:</span>
 
+            <span class="c1"># ignore adds</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">mainline_items</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;items&#39;</span><span class="p">,</span> <span class="p">[])</span>
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">mainline_items</span><span class="p">:</span>
 
+
 
+            <span class="n">title</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;title&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+            <span class="n">res_url</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;url&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+            <span class="k">if</span> <span class="n">mainline_type</span> <span class="o">==</span> <span class="s1">&#39;web&#39;</span><span class="p">:</span>
 
+                <span class="n">content</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;desc&#39;</span><span class="p">]</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                    <span class="p">{</span>
 
+                        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">res_url</span><span class="p">,</span>
 
+                        <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                    <span class="p">}</span>
 
+                <span class="p">)</span>
 
+
 
+            <span class="k">elif</span> <span class="n">mainline_type</span> <span class="o">==</span> <span class="s1">&#39;news&#39;</span><span class="p">:</span>
 
+
 
+                <span class="n">pub_date</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;date&#39;</span><span class="p">]</span>
 
+                <span class="k">if</span> <span class="n">pub_date</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                    <span class="n">pub_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">pub_date</span><span class="p">)</span>
 
+                <span class="n">news_media</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;media&#39;</span><span class="p">,</span> <span class="p">[])</span>
 
+                <span class="n">thumbnail</span> <span class="o">=</span> <span class="kc">None</span>
 
+                <span class="k">if</span> <span class="n">news_media</span><span class="p">:</span>
 
+                    <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">news_media</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;pict&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;url&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                    <span class="p">{</span>
 
+                        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">res_url</span><span class="p">,</span>
 
+                        <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">pub_date</span><span class="p">,</span>
 
+                        <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+                    <span class="p">}</span>
 
+                <span class="p">)</span>
 
+
 
+            <span class="k">elif</span> <span class="n">mainline_type</span> <span class="o">==</span> <span class="s1">&#39;images&#39;</span><span class="p">:</span>
 
+                <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span>
 
+                <span class="n">img_src</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;media&#39;</span><span class="p">]</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                    <span class="p">{</span>
 
+                        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">res_url</span><span class="p">,</span>
 
+                        <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;images.html&#39;</span><span class="p">,</span>
 
+                        <span class="s1">&#39;thumbnail_src&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+                        <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">img_src</span><span class="p">,</span>
 
+                        <span class="s1">&#39;resolution&#39;</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;width&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2"> x </span><span class="si">{</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;height&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
 
+                        <span class="s1">&#39;img_format&#39;</span><span class="p">:</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;thumb_type&#39;</span><span class="p">),</span>
 
+                    <span class="p">}</span>
 
+                <span class="p">)</span>
 
+
 
+            <span class="k">elif</span> <span class="n">mainline_type</span> <span class="o">==</span> <span class="s1">&#39;videos&#39;</span><span class="p">:</span>
 
+                <span class="c1"># some videos do not have a description: while qwant-video</span>
 
+                <span class="c1"># returns an empty string, such video from a qwant-web query</span>
 
+                <span class="c1"># miss the &#39;desc&#39; key.</span>
 
+                <span class="n">d</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">c</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;desc&#39;</span><span class="p">),</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;source&#39;</span><span class="p">),</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;channel&#39;</span><span class="p">)</span>
 
+                <span class="n">content_parts</span> <span class="o">=</span> <span class="p">[]</span>
 
+                <span class="k">if</span> <span class="n">d</span><span class="p">:</span>
 
+                    <span class="n">content_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="n">s</span><span class="p">:</span>
 
+                    <span class="n">content_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2"> &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Source&quot;</span><span class="p">),</span> <span class="n">s</span><span class="p">))</span>
 
+                <span class="k">if</span> <span class="n">c</span><span class="p">:</span>
 
+                    <span class="n">content_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2"> &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Channel&quot;</span><span class="p">),</span> <span class="n">c</span><span class="p">))</span>
 
+                <span class="n">content</span> <span class="o">=</span> <span class="s1">&#39; // &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">content_parts</span><span class="p">)</span>
 
+                <span class="n">length</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;duration&#39;</span><span class="p">]</span>
 
+                <span class="k">if</span> <span class="n">length</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                    <span class="n">length</span> <span class="o">=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">milliseconds</span><span class="o">=</span><span class="n">length</span><span class="p">)</span>
 
+                <span class="n">pub_date</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;date&#39;</span><span class="p">]</span>
 
+                <span class="k">if</span> <span class="n">pub_date</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                    <span class="n">pub_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">pub_date</span><span class="p">)</span>
 
+                <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span>
 
+                <span class="c1"># from some locations (DE and others?) the s2 link do</span>
 
+                <span class="c1"># response a &#39;Please wait ..&#39; but does not deliver the thumbnail</span>
 
+                <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">thumbnail</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;https://s2.qwant.com&#39;</span><span class="p">,</span> <span class="s1">&#39;https://s1.qwant.com&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                    <span class="p">{</span>
 
+                        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">res_url</span><span class="p">,</span>
 
+                        <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                        <span class="s1">&#39;iframe_src&#39;</span><span class="p">:</span> <span class="n">get_embeded_stream_url</span><span class="p">(</span><span class="n">res_url</span><span class="p">),</span>
 
+                        <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">pub_date</span><span class="p">,</span>
 
+                        <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnail</span><span class="p">,</span>
 
+                        <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;videos.html&#39;</span><span class="p">,</span>
 
+                        <span class="s1">&#39;length&#39;</span><span class="p">:</span> <span class="n">length</span><span class="p">,</span>
 
+                    <span class="p">}</span>
 
+                <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+
 
+    <span class="c1"># pylint: disable=import-outside-toplevel</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">network</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">region_tag</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">extr</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">about</span><span class="p">[</span><span class="s1">&#39;website&#39;</span><span class="p">])</span>
 
+    <span class="n">json_string</span> <span class="o">=</span> <span class="n">extr</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="s1">&#39;INITIAL_PROPS = &#39;</span><span class="p">,</span> <span class="s1">&#39;&lt;/script&gt;&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">q_initial_props</span> <span class="o">=</span> <span class="n">loads</span><span class="p">(</span><span class="n">json_string</span><span class="p">)</span>
 
+    <span class="n">q_locales</span> <span class="o">=</span> <span class="n">q_initial_props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;locales&#39;</span><span class="p">)</span>
 
+    <span class="n">eng_tag_list</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+
 
+    <span class="k">for</span> <span class="n">country</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">q_locales</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">for</span> <span class="n">lang</span> <span class="ow">in</span> <span class="n">v</span><span class="p">[</span><span class="s1">&#39;langs&#39;</span><span class="p">]:</span>
 
+            <span class="n">_locale</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{lang}</span><span class="s2">_</span><span class="si">{country}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">lang</span><span class="o">=</span><span class="n">lang</span><span class="p">,</span> <span class="n">country</span><span class="o">=</span><span class="n">country</span><span class="p">)</span>
 
+
 
+            <span class="k">if</span> <span class="n">qwant_categ</span> <span class="o">==</span> <span class="s1">&#39;news&#39;</span> <span class="ow">and</span> <span class="n">_locale</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">qwant_news_locales</span><span class="p">:</span>
 
+                <span class="c1"># qwant-news does not support all locales from qwant-web:</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="n">eng_tag_list</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">_locale</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">eng_tag</span> <span class="ow">in</span> <span class="n">eng_tag_list</span><span class="p">:</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</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="n">eng_tag</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;_&#39;</span><span class="p">))</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: can&#39;t determine babel locale of quant&#39;s locale </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">eng_tag</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 303 - 0
_modules/searx/engines/radio_browser.html
View File 

@@ -0,0 +1,303 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.radio_browser &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.radio_browser</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.radio_browser</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Search radio stations from RadioBrowser by `Advanced station search API`_.</span>
 
+
 
+<span class="sd">.. _Advanced station search API:</span>
 
+<span class="sd">   https://de1.api.radio-browser.info/#Advanced_station_search</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">random</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">socket</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</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</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">language_tag</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.radio-browser.info/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q111664849&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://de1.api.radio-browser.info/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;music&#39;</span><span class="p">,</span> <span class="s1">&#39;radio&#39;</span><span class="p">]</span>
 
+
 
+<span class="n">number_of_results</span> <span class="o">=</span> <span class="mi">10</span>
 
+
 
+<span class="n">station_filters</span> <span class="o">=</span> <span class="p">[]</span>  <span class="c1"># [&#39;countrycode&#39;, &#39;language&#39;]</span>
 
+<span class="sd">&quot;&quot;&quot;A list of filters to be applied to the search of radio stations.  By default</span>
 
+<span class="sd">none filters are applied. Valid filters are:</span>
 
+
 
+<span class="sd">``language``</span>
 
+<span class="sd">  Filter stations by selected language.  For instance the ``de`` from ``:de-AU``</span>
 
+<span class="sd">  will be translated to `german` and used in the argument ``language=``.</span>
 
+
 
+<span class="sd">``countrycode``</span>
 
+<span class="sd">  Filter stations by selected country.  The 2-digit countrycode of the station</span>
 
+<span class="sd">  comes from the region the user selected.  For instance ``:de-AU`` will filter</span>
 
+<span class="sd">  out all stations not in ``AU``.</span>
 
+
 
+<span class="sd">.. note::</span>
 
+
 
+<span class="sd">   RadioBrowser has registered a lot of languages and countrycodes unknown to</span>
 
+<span class="sd">   :py:obj:`babel` and note that when searching for radio stations, users are</span>
 
+<span class="sd">   more likely to search by name than by region or language.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">servers</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">_</span><span class="p">):</span>
 
+    <span class="c1"># see https://api.radio-browser.info</span>
 
+    <span class="n">ips</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">getaddrinfo</span><span class="p">(</span><span class="s2">&quot;all.api.radio-browser.info&quot;</span><span class="p">,</span> <span class="mi">80</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">IPPROTO_TCP</span><span class="p">)</span>
 
+    <span class="k">for</span> <span class="n">ip_tuple</span> <span class="ow">in</span> <span class="n">ips</span><span class="p">:</span>
 
+        <span class="n">_ip</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">ip_tuple</span><span class="p">[</span><span class="mi">4</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostbyaddr</span><span class="p">(</span><span class="n">_ip</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">srv</span> <span class="o">=</span> <span class="s2">&quot;https://&quot;</span> <span class="o">+</span> <span class="n">url</span>
 
+        <span class="k">if</span> <span class="n">srv</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">servers</span><span class="p">:</span>
 
+            <span class="n">servers</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">srv</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;order&#39;</span><span class="p">:</span> <span class="s1">&#39;votes&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;offset&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">number_of_results</span><span class="p">,</span>
 
+        <span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">number_of_results</span><span class="p">,</span>
 
+        <span class="s1">&#39;hidebroken&#39;</span><span class="p">:</span> <span class="s1">&#39;true&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;reverse&#39;</span><span class="p">:</span> <span class="s1">&#39;true&#39;</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;language&#39;</span> <span class="ow">in</span> <span class="n">station_filters</span><span class="p">:</span>
 
+        <span class="n">lang</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">])</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">if</span> <span class="n">lang</span><span class="p">:</span>
 
+            <span class="n">args</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">lang</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;countrycode&#39;</span> <span class="ow">in</span> <span class="n">station_filters</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">))</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="n">countrycode</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
 
+            <span class="k">if</span> <span class="n">countrycode</span> <span class="ow">in</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;countrycodes&#39;</span><span class="p">]:</span>  <span class="c1"># type: ignore</span>
 
+                <span class="n">args</span><span class="p">[</span><span class="s1">&#39;countrycode&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">countrycode</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">servers</span><span class="p">)</span><span class="si">}</span><span class="s2">/json/stations/search?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="n">json_resp</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">json_resp</span><span class="p">:</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;homepage&#39;</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">url</span><span class="p">:</span>
 
+            <span class="n">url</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;url_resolved&#39;</span><span class="p">]</span>
 
+
 
+        <span class="n">content</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="n">tags</span> <span class="o">=</span> <span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;tags&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="n">tags</span><span class="p">:</span>
 
+            <span class="n">content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tags</span><span class="p">)</span>
 
+        <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;state&#39;</span><span class="p">,</span> <span class="s1">&#39;country&#39;</span><span class="p">]:</span>
 
+            <span class="n">v</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">v</span><span class="p">:</span>
 
+                <span class="n">v</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+                <span class="n">content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
 
+
 
+        <span class="n">metadata</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="n">codec</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;codec&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">codec</span> <span class="ow">and</span> <span class="n">codec</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">!=</span> <span class="s1">&#39;unknown&#39;</span><span class="p">:</span>
 
+            <span class="n">metadata</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">codec</span><span class="si">}</span><span class="s1"> &#39;</span> <span class="o">+</span> <span class="n">gettext</span><span class="p">(</span><span class="s1">&#39;radio&#39;</span><span class="p">))</span>
 
+        <span class="k">for</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="ow">in</span> <span class="p">[</span>
 
+            <span class="p">(</span><span class="n">gettext</span><span class="p">(</span><span class="s1">&#39;bitrate&#39;</span><span class="p">),</span> <span class="s1">&#39;bitrate&#39;</span><span class="p">),</span>
 
+            <span class="p">(</span><span class="n">gettext</span><span class="p">(</span><span class="s1">&#39;votes&#39;</span><span class="p">),</span> <span class="s1">&#39;votes&#39;</span><span class="p">),</span>
 
+            <span class="p">(</span><span class="n">gettext</span><span class="p">(</span><span class="s1">&#39;clicks&#39;</span><span class="p">),</span> <span class="s1">&#39;clickcount&#39;</span><span class="p">),</span>
 
+        <span class="p">]:</span>
 
+            <span class="n">v</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">v</span><span class="p">:</span>
 
+                <span class="n">v</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+                <span class="n">metadata</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">x</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">v</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;favicon&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;http://&quot;</span><span class="p">,</span> <span class="s2">&quot;https://&quot;</span><span class="p">),</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="s1">&#39; | &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">content</span><span class="p">),</span>
 
+                <span class="s1">&#39;metadata&#39;</span><span class="p">:</span> <span class="s1">&#39; | &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">metadata</span><span class="p">),</span>
 
+                <span class="s1">&#39;iframe_src&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;url_resolved&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;http://&quot;</span><span class="p">,</span> <span class="s2">&quot;https://&quot;</span><span class="p">),</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/radio_browser.html#searx.engines.radio_browser.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages and countrycodes from RadioBrowser</span>
 
+
 
+<span class="sd">    - ``traits.languages``: `list of languages API`_</span>
 
+<span class="sd">    - ``traits.custom[&#39;countrycodes&#39;]``: `list of countries API`_</span>
 
+
 
+<span class="sd">    .. _list of countries API: https://de1.api.radio-browser.info/#List_of_countries</span>
 
+<span class="sd">    .. _list of languages API: https://de1.api.radio-browser.info/#List_of_languages</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=import-outside-toplevel</span>
 
+
 
+    <span class="n">init</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">babel.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_global</span>
 
+
 
+    <span class="n">babel_reg_list</span> <span class="o">=</span> <span class="n">get_global</span><span class="p">(</span><span class="s2">&quot;territory_languages&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
 
+
 
+    <span class="n">language_list</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">servers</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s1">/json/languages&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">country_list</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">servers</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s1">/json/countries&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="k">for</span> <span class="n">lang</span> <span class="ow">in</span> <span class="n">language_list</span><span class="p">:</span>
 
+
 
+        <span class="n">babel_lang</span> <span class="o">=</span> <span class="n">lang</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;iso_639&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">babel_lang</span><span class="p">:</span>
 
+            <span class="c1"># the language doesn&#39;t have any iso code, and hence can&#39;t be parsed</span>
 
+            <span class="c1"># print(f&quot;ERROR: lang - no iso code in {lang}&quot;)</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</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="n">babel_lang</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s2">&quot;-&quot;</span><span class="p">))</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="c1"># print(f&quot;ERROR: language tag {babel_lang} is unknown by babel&quot;)</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">lang</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span>
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+
 
+    <span class="n">countrycodes</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+    <span class="k">for</span> <span class="n">region</span> <span class="ow">in</span> <span class="n">country_list</span><span class="p">:</span>
 
+        <span class="c1"># country_list contains duplicates that differ only in upper/lower case</span>
 
+        <span class="n">_reg</span> <span class="o">=</span> <span class="n">region</span><span class="p">[</span><span class="s1">&#39;iso_3166_1&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">_reg</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">babel_reg_list</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;ERROR: region tag </span><span class="si">{</span><span class="n">region</span><span class="p">[</span><span class="s1">&#39;iso_3166_1&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2"> is unknown by babel&quot;</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">countrycodes</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">_reg</span><span class="p">)</span>
 
+
 
+    <span class="n">countrycodes</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">countrycodes</span><span class="p">)</span>
 
+    <span class="n">countrycodes</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;countrycodes&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">countrycodes</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 196 - 0
_modules/searx/engines/sepiasearch.html
View File 

@@ -0,0 +1,196 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.sepiasearch &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.sepiasearch</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.sepiasearch</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;SepiaSearch uses the same languages as :py:obj:`Peertube</span>
 
+<span class="sd">&lt;searx.engines.peertube&gt;` and the response is identical to the response from the</span>
 
+<span class="sd">peertube engines.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.peertube</span><span class="w"> </span><span class="kn">import</span> <span class="n">fetch_traits</span>  <span class="c1"># pylint: disable=unused-import</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.peertube</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="c1"># pylint: disable=unused-import</span>
 
+    <span class="n">video_response</span><span class="p">,</span>
 
+    <span class="n">safesearch_table</span><span class="p">,</span>
 
+    <span class="n">time_range_table</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="c1"># pylint: disable=line-too-long</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://sepiasearch.org&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://docs.joinpeertube.org/api-rest-reference.html#tag/Search/operation/searchVideos&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;videos&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://sepiasearch.org&#39;</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/peertube.html#searx.engines.sepiasearch.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Assemble request for the SepiaSearch API&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">query</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">False</span>
 
+
 
+    <span class="c1"># eng_region = traits.get_region(params[&#39;searxng_locale&#39;], &#39;en_US&#39;)</span>
 
+    <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="n">base_url</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>
 
+        <span class="o">+</span> <span class="s2">&quot;/api/v1/search/videos?&quot;</span>
 
+        <span class="o">+</span> <span class="n">urlencode</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;search&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+                <span class="s1">&#39;start&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">10</span><span class="p">,</span>
 
+                <span class="s1">&#39;count&#39;</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
 
+                <span class="c1"># -createdAt: sort by date ascending / createdAt: date descending</span>
 
+                <span class="s1">&#39;sort&#39;</span><span class="p">:</span> <span class="s1">&#39;-match&#39;</span><span class="p">,</span>  <span class="c1"># sort by *match descending*</span>
 
+                <span class="s1">&#39;nsfw&#39;</span><span class="p">:</span> <span class="n">safesearch_table</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]],</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">eng_lang</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39;&amp;languageOneOf[]=&#39;</span> <span class="o">+</span> <span class="n">eng_lang</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39;&amp;boostLanguages[]=&#39;</span> <span class="o">+</span> <span class="n">eng_lang</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="ow">in</span> <span class="n">time_range_table</span><span class="p">:</span>
 
+        <span class="n">time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">date</span><span class="p">()</span> <span class="o">+</span> <span class="n">time_range_table</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]]</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="s1">&#39;&amp;startDate=&#39;</span> <span class="o">+</span> <span class="n">time</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="k">return</span> <span class="n">video_response</span><span class="p">(</span><span class="n">resp</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 230 - 0
_modules/searx/engines/sqlite.html
View File 

@@ -0,0 +1,230 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.sqlite &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.sqlite</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.sqlite</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;SQLite is a small, fast and reliable SQL database engine.  It does not require</span>
 
+<span class="sd">any extra dependency.</span>
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">The engine has the following (additional) settings:</span>
 
+
 
+<span class="sd">- :py:obj:`result_type`</span>
 
+
 
+
 
+<span class="sd">Example</span>
 
+<span class="sd">=======</span>
 
+
 
+<span class="sd">.. _MediathekView: https://mediathekview.de/</span>
 
+
 
+<span class="sd">To demonstrate the power of database engines, here is a more complex example</span>
 
+<span class="sd">which reads from a MediathekView_ (DE) movie database.  For this example of the</span>
 
+<span class="sd">SQLite engine download the database:</span>
 
+
 
+<span class="sd">- https://liste.mediathekview.de/filmliste-v2.db.bz2</span>
 
+
 
+<span class="sd">and unpack into ``searx/data/filmliste-v2.db``.  To search the database use e.g</span>
 
+<span class="sd">Query to test: ``!mediathekview concert``</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name: mediathekview</span>
 
+<span class="sd">    engine: sqlite</span>
 
+<span class="sd">    shortcut: mediathekview</span>
 
+<span class="sd">    categories: [general, videos]</span>
 
+<span class="sd">    result_type: MainResult</span>
 
+<span class="sd">    database: searx/data/filmliste-v2.db</span>
 
+<span class="sd">    query_str: &gt;-</span>
 
+<span class="sd">      SELECT title || &#39; (&#39; || time(duration, &#39;unixepoch&#39;) || &#39;)&#39; AS title,</span>
 
+<span class="sd">             COALESCE( NULLIF(url_video_hd,&#39;&#39;), NULLIF(url_video_sd,&#39;&#39;), url_video) AS url,</span>
 
+<span class="sd">             description AS content</span>
 
+<span class="sd">        FROM film</span>
 
+<span class="sd">       WHERE title LIKE :wildcard OR description LIKE :wildcard</span>
 
+<span class="sd">       ORDER BY duration DESC</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</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">sqlite3</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">contextlib</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="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">MainResult</span><span class="p">,</span> <span class="n">KeyValue</span>
 
+
 
+<span class="n">engine_type</span> <span class="o">=</span> <span class="s2">&quot;offline&quot;</span>
 
+
 
+<span class="n">database</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;Filename of the SQLite DB.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">query_str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;SQL query that returns the result items.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">result_type</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">&quot;MainResult&quot;</span><span class="p">,</span> <span class="s2">&quot;KeyValue&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;KeyValue&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;The result type can be :py:obj:`MainResult` or :py:obj:`KeyValue`.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">limit</span> <span class="o">=</span> <span class="mi">10</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="s1">&#39;query_str&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine_settings</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;query_str cannot be empty&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">engine_settings</span><span class="p">[</span><span class="s1">&#39;query_str&#39;</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">startswith</span><span class="p">(</span><span class="s1">&#39;select &#39;</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;only SELECT query is supported&#39;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="sqlite_cursor">
 
+<a class="viewcode-back" href="../../../dev/engines/offline/sql-engines.html#searx.engines.sqlite.sqlite_cursor">[docs]</a>
 
+<span class="nd">@contextlib</span><span class="o">.</span><span class="n">contextmanager</span>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">sqlite_cursor</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Implements a :py:obj:`Context Manager &lt;contextlib.contextmanager&gt;` for a</span>
 
+<span class="sd">    :py:obj:`sqlite3.Cursor`.</span>
 
+
 
+<span class="sd">    Open database in read only mode: if the database doesn&#39;t exist.  The default</span>
 
+<span class="sd">    mode creates an empty file on the file system.  See:</span>
 
+
 
+<span class="sd">    * https://docs.python.org/3/library/sqlite3.html#sqlite3.connect</span>
 
+<span class="sd">    * https://www.sqlite.org/uri.html</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">uri</span> <span class="o">=</span> <span class="s1">&#39;file:&#39;</span> <span class="o">+</span> <span class="n">database</span> <span class="o">+</span> <span class="s1">&#39;?mode=ro&#39;</span>
 
+    <span class="k">with</span> <span class="n">contextlib</span><span class="o">.</span><span class="n">closing</span><span class="p">(</span><span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">uri</span><span class="p">,</span> <span class="n">uri</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span> <span class="k">as</span> <span class="n">connect</span><span class="p">:</span>
 
+        <span class="n">connect</span><span class="o">.</span><span class="n">row_factory</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Row</span>
 
+        <span class="k">with</span> <span class="n">contextlib</span><span class="o">.</span><span class="n">closing</span><span class="p">(</span><span class="n">connect</span><span class="o">.</span><span class="n">cursor</span><span class="p">())</span> <span class="k">as</span> <span class="n">cursor</span><span class="p">:</span>
 
+            <span class="k">yield</span> <span class="n">cursor</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">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="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+    <span class="n">res</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+    <span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;wildcard&#39;</span><span class="p">:</span> <span class="sa">r</span><span class="s1">&#39;%&#39;</span> <span class="o">+</span> <span class="n">query</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39; &#39;</span><span class="p">,</span> <span class="sa">r</span><span class="s1">&#39;%&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="sa">r</span><span class="s1">&#39;%&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span>
 
+        <span class="s1">&#39;offset&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">limit</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+    <span class="n">query_to_run</span> <span class="o">=</span> <span class="n">query_str</span> <span class="o">+</span> <span class="s1">&#39; LIMIT :limit OFFSET :offset&#39;</span>
 
+
 
+    <span class="k">with</span> <span class="n">sqlite_cursor</span><span class="p">()</span> <span class="k">as</span> <span class="n">cur</span><span class="p">:</span>
 
+
 
+        <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">query_to_run</span><span class="p">,</span> <span class="n">query_params</span><span class="p">)</span>
 
+        <span class="n">col_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">cn</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">cn</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">description</span><span class="p">]</span>
 
+
 
+        <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchall</span><span class="p">():</span>
 
+            <span class="n">kvmap</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">col_names</span><span class="p">,</span> <span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">row</span><span class="p">)))</span>
 
+            <span class="k">if</span> <span class="n">result_type</span> <span class="o">==</span> <span class="s2">&quot;MainResult&quot;</span><span class="p">:</span>
 
+                <span class="n">item</span> <span class="o">=</span> <span class="n">MainResult</span><span class="p">(</span><span class="o">**</span><span class="n">kvmap</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">item</span> <span class="o">=</span> <span class="n">KeyValue</span><span class="p">(</span><span class="n">kvmap</span><span class="o">=</span><span class="n">kvmap</span><span class="p">)</span>
 
+            <span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">res</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 647 - 0
_modules/searx/engines/startpage.html
View File 

@@ -0,0 +1,647 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.startpage &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.startpage</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.startpage</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Startpage&#39;s language &amp; region selectors are a mess ..</span>
 
+
 
+<span class="sd">.. _startpage regions:</span>
 
+
 
+<span class="sd">Startpage regions</span>
 
+<span class="sd">=================</span>
 
+
 
+<span class="sd">In the list of regions there are tags we need to map to common region tags::</span>
 
+
 
+<span class="sd">  pt-BR_BR --&gt; pt_BR</span>
 
+<span class="sd">  zh-CN_CN --&gt; zh_Hans_CN</span>
 
+<span class="sd">  zh-TW_TW --&gt; zh_Hant_TW</span>
 
+<span class="sd">  zh-TW_HK --&gt; zh_Hant_HK</span>
 
+<span class="sd">  en-GB_GB --&gt; en_GB</span>
 
+
 
+<span class="sd">and there is at least one tag with a three letter language tag (ISO 639-2)::</span>
 
+
 
+<span class="sd">  fil_PH --&gt; fil_PH</span>
 
+
 
+<span class="sd">The locale code ``no_NO`` from Startpage does not exists and is mapped to</span>
 
+<span class="sd">``nb-NO``::</span>
 
+
 
+<span class="sd">    babel.core.UnknownLocaleError: unknown locale &#39;no_NO&#39;</span>
 
+
 
+<span class="sd">For reference see languages-subtag at iana; ``no`` is the macrolanguage [1]_ and</span>
 
+<span class="sd">W3C recommends subtag over macrolanguage [2]_.</span>
 
+
 
+<span class="sd">.. [1] `iana: language-subtag-registry</span>
 
+<span class="sd">   &lt;https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry&gt;`_ ::</span>
 
+
 
+<span class="sd">      type: language</span>
 
+<span class="sd">      Subtag: nb</span>
 
+<span class="sd">      Description: Norwegian Bokmål</span>
 
+<span class="sd">      Added: 2005-10-16</span>
 
+<span class="sd">      Suppress-Script: Latn</span>
 
+<span class="sd">      Macrolanguage: no</span>
 
+
 
+<span class="sd">.. [2]</span>
 
+<span class="sd">   Use macrolanguages with care.  Some language subtags have a Scope field set to</span>
 
+<span class="sd">   macrolanguage, i.e. this primary language subtag encompasses a number of more</span>
 
+<span class="sd">   specific primary language subtags in the registry.  ...  As we recommended for</span>
 
+<span class="sd">   the collection subtags mentioned above, in most cases you should try to use</span>
 
+<span class="sd">   the more specific subtags ... `W3: The primary language subtag</span>
 
+<span class="sd">   &lt;https://www.w3.org/International/questions/qa-choosing-language-tags#langsubtag&gt;`_</span>
 
+
 
+<span class="sd">.. _startpage languages:</span>
 
+
 
+<span class="sd">Startpage languages</span>
 
+<span class="sd">===================</span>
 
+
 
+<span class="sd">:py:obj:`send_accept_language_header`:</span>
 
+<span class="sd">  The displayed name in Startpage&#39;s settings page depend on the location of the</span>
 
+<span class="sd">  IP when ``Accept-Language`` HTTP header is unset.  In :py:obj:`fetch_traits`</span>
 
+<span class="sd">  we use::</span>
 
+
 
+<span class="sd">    &#39;Accept-Language&#39;: &quot;en-US,en;q=0.5&quot;,</span>
 
+<span class="sd">    ..</span>
 
+
 
+<span class="sd">  to get uniform names independent from the IP).</span>
 
+
 
+<span class="sd">.. _startpage categories:</span>
 
+
 
+<span class="sd">Startpage categories</span>
 
+<span class="sd">====================</span>
 
+
 
+<span class="sd">Startpage&#39;s category (for Web-search, News, Videos, ..) is set by</span>
 
+<span class="sd">:py:obj:`startpage_categ` in  settings.yml::</span>
 
+
 
+<span class="sd">  - name: startpage</span>
 
+<span class="sd">    engine: startpage</span>
 
+<span class="sd">    startpage_categ: web</span>
 
+<span class="sd">    ...</span>
 
+
 
+<span class="sd">.. hint::</span>
 
+
 
+<span class="sd">  Supported categories are ``web``, ``news`` and ``images``.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=too-many-statements</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">Any</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">collections</span><span class="w"> </span><span class="kn">import</span> <span class="n">OrderedDict</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">unicodedata</span><span class="w"> </span><span class="kn">import</span> <span class="n">normalize</span><span class="p">,</span> <span class="n">combining</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">time</span><span class="w"> </span><span class="kn">import</span> <span class="n">time</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="kn">import</span> <span class="n">loads</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">dateutil.parser</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">lxml.html</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.localedata</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">extr</span><span class="p">,</span> <span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath</span><span class="p">,</span> <span class="n">gen_useragent</span><span class="p">,</span> <span class="n">html_to_text</span><span class="p">,</span> <span class="n">humanize_bytes</span><span class="p">,</span> <span class="n">remove_pua_from_str</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</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</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">SearxEngineCaptchaException</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">region_tag</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://startpage.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q2333295&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">startpage_categ</span> <span class="o">=</span> <span class="s1">&#39;web&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Startpage&#39;s category, visit :ref:`startpage categories`.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="sd">&quot;&quot;&quot;Startpage tries to guess user&#39;s language and territory from the HTTP</span>
 
+<span class="sd">``Accept-Language``.  Optional the user can select a search-language (can be</span>
 
+<span class="sd">different to the UI language) and a region filter.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">max_page</span> <span class="o">=</span> <span class="mi">18</span>
 
+<span class="sd">&quot;&quot;&quot;Tested 18 pages maximum (argument ``page``), to be save max is set to 20.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+<span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="s1">&#39;d&#39;</span><span class="p">,</span> <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="s1">&#39;w&#39;</span><span class="p">,</span> <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="s1">&#39;m&#39;</span><span class="p">,</span> <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="s1">&#39;y&#39;</span><span class="p">}</span>
 
+<span class="n">safesearch_dict</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;1&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;1&#39;</span><span class="p">}</span>
 
+
 
+<span class="c1"># search-url</span>
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://www.startpage.com&#39;</span>
 
+<span class="n">search_url</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;/sp/search&#39;</span>
 
+
 
+<span class="c1"># specific xpath variables</span>
 
+<span class="c1"># ads xpath //div[@id=&quot;results&quot;]/div[@id=&quot;sponsored&quot;]//div[@class=&quot;result&quot;]</span>
 
+<span class="c1"># not ads: div[@class=&quot;result&quot;] are the direct children of div[@id=&quot;results&quot;]</span>
 
+<span class="n">search_form_xpath</span> <span class="o">=</span> <span class="s1">&#39;//form[@id=&quot;search&quot;]&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;XPath of Startpage&#39;s origin search form</span>
 
+
 
+<span class="sd">.. code: html</span>
 
+
 
+<span class="sd">    &lt;form action=&quot;/sp/search&quot; method=&quot;post&quot;&gt;</span>
 
+<span class="sd">      &lt;input type=&quot;text&quot; name=&quot;query&quot;  value=&quot;&quot; ..&gt;</span>
 
+<span class="sd">      &lt;input type=&quot;hidden&quot; name=&quot;t&quot; value=&quot;device&quot;&gt;</span>
 
+<span class="sd">      &lt;input type=&quot;hidden&quot; name=&quot;lui&quot; value=&quot;english&quot;&gt;</span>
 
+<span class="sd">      &lt;input type=&quot;hidden&quot; name=&quot;sc&quot; value=&quot;Q7Mt5TRqowKB00&quot;&gt;</span>
 
+<span class="sd">      &lt;input type=&quot;hidden&quot; name=&quot;cat&quot; value=&quot;web&quot;&gt;</span>
 
+<span class="sd">      &lt;input type=&quot;hidden&quot; class=&quot;abp&quot; id=&quot;abp-input&quot; name=&quot;abp&quot; value=&quot;1&quot;&gt;</span>
 
+<span class="sd">    &lt;/form&gt;</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="c1"># timestamp of the last fetch of &#39;sc&#39; code</span>
 
+<span class="n">sc_code_ts</span> <span class="o">=</span> <span class="mi">0</span>
 
+<span class="n">sc_code</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="n">sc_code_cache_sec</span> <span class="o">=</span> <span class="mi">30</span>
 
+<span class="sd">&quot;&quot;&quot;Time in seconds the sc-code is cached in memory :py:obj:`get_sc_code`.&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_sc_code">
 
+<a class="viewcode-back" href="../../../dev/engines/online/startpage.html#searx.engines.startpage.get_sc_code">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_sc_code</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get an actual ``sc`` argument from Startpage&#39;s search form (HTML page).</span>
 
+
 
+<span class="sd">    Startpage puts a ``sc`` argument on every HTML :py:obj:`search form</span>
 
+<span class="sd">    &lt;search_form_xpath&gt;`.  Without this argument Startpage considers the request</span>
 
+<span class="sd">    is from a bot.  We do not know what is encoded in the value of the ``sc``</span>
 
+<span class="sd">    argument, but it seems to be a kind of a *time-stamp*.</span>
 
+
 
+<span class="sd">    Startpage&#39;s search form generates a new sc-code on each request.  This</span>
 
+<span class="sd">    function scrap a new sc-code from Startpage&#39;s home page every</span>
 
+<span class="sd">    :py:obj:`sc_code_cache_sec` seconds.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="k">global</span> <span class="n">sc_code_ts</span><span class="p">,</span> <span class="n">sc_code</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+
 
+    <span class="k">if</span> <span class="n">sc_code</span> <span class="ow">and</span> <span class="p">(</span><span class="n">time</span><span class="p">()</span> <span class="o">&lt;</span> <span class="p">(</span><span class="n">sc_code_ts</span> <span class="o">+</span> <span class="n">sc_code_cache_sec</span><span class="p">)):</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;get_sc_code: reuse &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span><span class="p">,</span> <span class="n">sc_code</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">sc_code</span>
 
+
 
+    <span class="n">headers</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]}</span>
 
+    <span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Origin&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span>
 
+    <span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Referer&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span>
 
+    <span class="c1"># headers[&#39;Connection&#39;] = &#39;keep-alive&#39;</span>
 
+    <span class="c1"># headers[&#39;Accept-Encoding&#39;] = &#39;gzip, deflate, br&#39;</span>
 
+    <span class="c1"># headers[&#39;Accept&#39;] = &#39;text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8&#39;</span>
 
+    <span class="c1"># headers[&#39;User-Agent&#39;] = &#39;Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:105.0) Gecko/20100101 Firefox/105.0&#39;</span>
 
+
 
+    <span class="c1"># add Accept-Language header</span>
 
+    <span class="k">if</span> <span class="n">searxng_locale</span> <span class="o">==</span> <span class="s1">&#39;all&#39;</span><span class="p">:</span>
 
+        <span class="n">searxng_locale</span> <span class="o">=</span> <span class="s1">&#39;en-US&#39;</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="n">searxng_locale</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">send_accept_language_header</span><span class="p">:</span>
 
+        <span class="n">ac_lang</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">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">&quot;</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&quot;</span> <span class="o">%</span> <span class="p">(</span>
 
+                <span class="n">locale</span><span class="o">.</span><span class="n">language</span><span class="p">,</span>
 
+                <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">,</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="s1">&#39;Accept-Language&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ac_lang</span>
 
+
 
+    <span class="n">get_sc_url</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;/?sc=</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sc_code</span><span class="p">)</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;query new sc time-stamp ... </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">get_sc_url</span><span class="p">)</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;headers: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">headers</span><span class="p">)</span>
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">get_sc_url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
 
+
 
+    <span class="c1"># ?? x = network.get(&#39;https://www.startpage.com/sp/cdn/images/filter-chevron.svg&#39;, headers=headers)</span>
 
+    <span class="c1"># ?? https://www.startpage.com/sp/cdn/images/filter-chevron.svg</span>
 
+    <span class="c1"># ?? ping-back URL: https://www.startpage.com/sp/pb?sc=TLsB0oITjZ8F21</span>
 
+
 
+    <span class="k">if</span> <span class="nb">str</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">url</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;https://www.startpage.com/sp/captcha&#39;</span><span class="p">):</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">(</span>
 
+            <span class="n">message</span><span class="o">=</span><span class="s2">&quot;get_sc_code: got redirected to https://www.startpage.com/sp/captcha&quot;</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">sc_code</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">search_form_xpath</span> <span class="o">+</span> <span class="s1">&#39;//input[@name=&quot;sc&quot;]/@value&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+    <span class="k">except</span> <span class="ne">IndexError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;suspend startpage API --&gt; https://github.com/searxng/searxng/pull/695&quot;</span><span class="p">)</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineCaptchaException</span><span class="p">(</span>
 
+            <span class="n">message</span><span class="o">=</span><span class="s2">&quot;get_sc_code: [PR-695] query new sc time-stamp failed! (</span><span class="si">%s</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="n">resp</span><span class="o">.</span><span class="n">url</span><span class="p">,</span>  <span class="c1"># type: ignore</span>
 
+        <span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">exc</span>
 
+
 
+    <span class="n">sc_code_ts</span> <span class="o">=</span> <span class="n">time</span><span class="p">()</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;get_sc_code: new value is: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">sc_code</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">sc_code</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/startpage.html#searx.engines.startpage.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Assemble a Startpage request.</span>
 
+
 
+<span class="sd">    To avoid CAPTCHA we need to send a well formed HTTP POST request with a</span>
 
+<span class="sd">    cookie.  We need to form a request that is identical to the request build by</span>
 
+<span class="sd">    Startpage&#39;s search form:</span>
 
+
 
+<span class="sd">    - in the cookie the **region** is selected</span>
 
+<span class="sd">    - in the HTTP POST data the **language** is selected</span>
 
+
 
+<span class="sd">    Additionally the arguments form Startpage&#39;s search form needs to be set in</span>
 
+<span class="sd">    HTML POST data / compare ``&lt;input&gt;`` elements: :py:obj:`search_form_xpath`.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">engine_region</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;en-US&#39;</span><span class="p">)</span>
 
+    <span class="n">engine_language</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>
 
+
 
+    <span class="c1"># build arguments</span>
 
+    <span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+        <span class="s1">&#39;cat&#39;</span><span class="p">:</span> <span class="n">startpage_categ</span><span class="p">,</span>
 
+        <span class="s1">&#39;t&#39;</span><span class="p">:</span> <span class="s1">&#39;device&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;sc&#39;</span><span class="p">:</span> <span class="n">get_sc_code</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">params</span><span class="p">),</span>  <span class="c1"># hint: this func needs HTTP headers,</span>
 
+        <span class="s1">&#39;with_date&#39;</span><span class="p">:</span> <span class="n">time_range_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">],</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="k">if</span> <span class="n">engine_language</span><span class="p">:</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine_language</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;lui&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine_language</span>
 
+
 
+    <span class="n">args</span><span class="p">[</span><span class="s1">&#39;abp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;1&#39;</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="n">args</span><span class="p">[</span><span class="s1">&#39;page&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span>
 
+
 
+    <span class="c1"># build cookie</span>
 
+    <span class="n">lang_homepage</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
 
+    <span class="n">cookie</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">()</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;date_time&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;world&#39;</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;disable_family_filter&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">safesearch_dict</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]]</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;disable_open_in_new_window&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;0&#39;</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;enable_post_method&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;1&#39;</span>  <span class="c1"># hint: POST</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;enable_proxy_safety_suggest&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;1&#39;</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;enable_stay_control&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;1&#39;</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;instant_answers&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;1&#39;</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;lang_homepage&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;s/device/</span><span class="si">%s</span><span class="s1">/&#39;</span> <span class="o">%</span> <span class="n">lang_homepage</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;num_of_results&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;10&#39;</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;suggestions&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;1&#39;</span>
 
+    <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;wt_unit&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;celsius&#39;</span>
 
+
 
+    <span class="k">if</span> <span class="n">engine_language</span><span class="p">:</span>
 
+        <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine_language</span>
 
+        <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;language_ui&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine_language</span>
 
+
 
+    <span class="k">if</span> <span class="n">engine_region</span><span class="p">:</span>
 
+        <span class="n">cookie</span><span class="p">[</span><span class="s1">&#39;search_results_region&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine_region</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;preferences&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;N1N&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">EEE</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">cookie</span><span class="o">.</span><span class="n">items</span><span class="p">()])</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;cookie preferences: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">][</span><span class="s1">&#39;preferences&#39;</span><span class="p">])</span>
 
+
 
+    <span class="c1"># POST request</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;data: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">args</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;method&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;POST&#39;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Origin&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Referer&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span>
 
+    <span class="c1"># is the Accept header needed?</span>
 
+    <span class="c1"># params[&#39;headers&#39;][&#39;Accept&#39;] = &#39;text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8&#39;</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_parse_published_date</span><span class="p">(</span><span class="n">content</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]:</span>
 
+    <span class="n">published_date</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+    <span class="c1"># check if search result starts with something like: &quot;2 Sep 2014 ... &quot;</span>
 
+    <span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^([1-9]|[1-2][0-9]|3[0-1]) [A-Z][a-z]</span><span class="si">{2}</span><span class="s2"> [0-9]</span><span class="si">{4}</span><span class="s2"> \.\.\. &quot;</span><span class="p">,</span> <span class="n">content</span><span class="p">):</span>
 
+        <span class="n">date_pos</span> <span class="o">=</span> <span class="n">content</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;...&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="mi">4</span>
 
+        <span class="n">date_string</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="mi">0</span> <span class="p">:</span> <span class="n">date_pos</span> <span class="o">-</span> <span class="mi">5</span><span class="p">]</span>
 
+        <span class="c1"># fix content string</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="n">date_pos</span><span class="p">:]</span>
 
+
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">published_date</span> <span class="o">=</span> <span class="n">dateutil</span><span class="o">.</span><span class="n">parser</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">date_string</span><span class="p">,</span> <span class="n">dayfirst</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
 
+            <span class="k">pass</span>
 
+
 
+    <span class="c1"># check if search result starts with something like: &quot;5 days ago ... &quot;</span>
 
+    <span class="k">elif</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^[0-9]+ days? ago \.\.\. &quot;</span><span class="p">,</span> <span class="n">content</span><span class="p">):</span>
 
+        <span class="n">date_pos</span> <span class="o">=</span> <span class="n">content</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;...&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="mi">4</span>
 
+        <span class="n">date_string</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="mi">0</span> <span class="p">:</span> <span class="n">date_pos</span> <span class="o">-</span> <span class="mi">5</span><span class="p">]</span>
 
+
 
+        <span class="c1"># calculate datetime</span>
 
+        <span class="n">published_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">-</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s1">&#39;\d+&#39;</span><span class="p">,</span> <span class="n">date_string</span><span class="p">)</span><span class="o">.</span><span class="n">group</span><span class="p">()))</span>  <span class="c1"># type: ignore</span>
 
+
 
+        <span class="c1"># fix content string</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">content</span><span class="p">[</span><span class="n">date_pos</span><span class="p">:]</span>
 
+
 
+    <span class="k">return</span> <span class="n">content</span><span class="p">,</span> <span class="n">published_date</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_get_web_result</span><span class="p">(</span><span class="n">result</span><span class="p">):</span>
 
+    <span class="n">content</span> <span class="o">=</span> <span class="n">html_to_text</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;description&#39;</span><span class="p">))</span>
 
+    <span class="n">content</span><span class="p">,</span> <span class="n">publishedDate</span> <span class="o">=</span> <span class="n">_parse_published_date</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="p">{</span>
 
+        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;clickUrl&#39;</span><span class="p">],</span>
 
+        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">html_to_text</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]),</span>
 
+        <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+        <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">publishedDate</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_get_news_result</span><span class="p">(</span><span class="n">result</span><span class="p">):</span>
 
+
 
+    <span class="n">title</span> <span class="o">=</span> <span class="n">remove_pua_from_str</span><span class="p">(</span><span class="n">html_to_text</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]))</span>
 
+    <span class="n">content</span> <span class="o">=</span> <span class="n">remove_pua_from_str</span><span class="p">(</span><span class="n">html_to_text</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;description&#39;</span><span class="p">)))</span>
 
+
 
+    <span class="n">publishedDate</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;date&#39;</span><span class="p">):</span>
 
+        <span class="n">publishedDate</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;date&#39;</span><span class="p">]</span> <span class="o">/</span> <span class="mi">1000</span><span class="p">)</span>
 
+
 
+    <span class="n">thumbnailUrl</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;thumbnailUrl&#39;</span><span class="p">):</span>
 
+        <span class="n">thumbnailUrl</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;thumbnailUrl&#39;</span><span class="p">]</span>
 
+
 
+    <span class="k">return</span> <span class="p">{</span>
 
+        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;clickUrl&#39;</span><span class="p">],</span>
 
+        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+        <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+        <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">publishedDate</span><span class="p">,</span>
 
+        <span class="s1">&#39;thumbnail&#39;</span><span class="p">:</span> <span class="n">thumbnailUrl</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_get_image_result</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;altClickUrl&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">url</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="n">thumbnailUrl</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;thumbnailUrl&#39;</span><span class="p">):</span>
 
+        <span class="n">thumbnailUrl</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;thumbnailUrl&#39;</span><span class="p">]</span>
 
+
 
+    <span class="n">resolution</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;width&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;height&#39;</span><span class="p">):</span>
 
+        <span class="n">resolution</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;width&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">x</span><span class="si">{</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;height&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+    <span class="n">filesize</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;filesize&#39;</span><span class="p">):</span>
 
+        <span class="n">size_str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">isdigit</span><span class="p">,</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;filesize&#39;</span><span class="p">]))</span>
 
+        <span class="n">filesize</span> <span class="o">=</span> <span class="n">humanize_bytes</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">size_str</span><span class="p">))</span>
 
+
 
+    <span class="k">return</span> <span class="p">{</span>
 
+        <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;images.html&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">html_to_text</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]),</span>
 
+        <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;rawImageUrl&#39;</span><span class="p">),</span>
 
+        <span class="s1">&#39;thumbnail_src&#39;</span><span class="p">:</span> <span class="n">thumbnailUrl</span><span class="p">,</span>
 
+        <span class="s1">&#39;resolution&#39;</span><span class="p">:</span> <span class="n">resolution</span><span class="p">,</span>
 
+        <span class="s1">&#39;img_format&#39;</span><span class="p">:</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;format&#39;</span><span class="p">),</span>
 
+        <span class="s1">&#39;filesize&#39;</span><span class="p">:</span> <span class="n">filesize</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+    <span class="n">categ</span> <span class="o">=</span> <span class="n">startpage_categ</span><span class="o">.</span><span class="n">capitalize</span><span class="p">()</span>
 
+    <span class="n">results_raw</span> <span class="o">=</span> <span class="s1">&#39;{&#39;</span> <span class="o">+</span> <span class="n">extr</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;React.createElement(UIStartpage.AppSerp</span><span class="si">{</span><span class="n">categ</span><span class="si">}</span><span class="s2">, </span><span class="se">{{</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s1">&#39;}})&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39;}}&#39;</span>
 
+    <span class="n">results_json</span> <span class="o">=</span> <span class="n">loads</span><span class="p">(</span><span class="n">results_raw</span><span class="p">)</span>
 
+    <span class="n">results_obj</span> <span class="o">=</span> <span class="n">results_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;render&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;presenter&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;regions&#39;</span><span class="p">,</span> <span class="p">{})</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">results_categ</span> <span class="ow">in</span> <span class="n">results_obj</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;mainline&#39;</span><span class="p">,</span> <span class="p">[]):</span>
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">results_categ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;results&#39;</span><span class="p">,</span> <span class="p">[]):</span>
 
+            <span class="k">if</span> <span class="n">results_categ</span><span class="p">[</span><span class="s1">&#39;display_type&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;web-google&#39;</span><span class="p">:</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_get_web_result</span><span class="p">(</span><span class="n">item</span><span class="p">))</span>
 
+            <span class="k">elif</span> <span class="n">results_categ</span><span class="p">[</span><span class="s1">&#39;display_type&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;news-bing&#39;</span><span class="p">:</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_get_news_result</span><span class="p">(</span><span class="n">item</span><span class="p">))</span>
 
+            <span class="k">elif</span> <span class="s1">&#39;images&#39;</span> <span class="ow">in</span> <span class="n">results_categ</span><span class="p">[</span><span class="s1">&#39;display_type&#39;</span><span class="p">]:</span>
 
+                <span class="n">item</span> <span class="o">=</span> <span class="n">_get_image_result</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="n">item</span><span class="p">:</span>
 
+                    <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/startpage.html#searx.engines.startpage.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch :ref:`languages &lt;startpage languages&gt;` and :ref:`regions &lt;startpage</span>
 
+<span class="sd">    regions&gt;` from Startpage.&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=too-many-branches</span>
 
+
 
+    <span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;User-Agent&#39;</span><span class="p">:</span> <span class="n">gen_useragent</span><span class="p">(),</span>
 
+        <span class="s1">&#39;Accept-Language&#39;</span><span class="p">:</span> <span class="s2">&quot;en-US,en;q=0.5&quot;</span><span class="p">,</span>  <span class="c1"># bing needs to set the English language</span>
 
+    <span class="p">}</span>
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="s1">&#39;https://www.startpage.com/do/settings&#39;</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from Startpage is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">lxml</span><span class="o">.</span><span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="c1"># regions</span>
 
+
 
+    <span class="n">sp_region_names</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//form[@name=&quot;settings&quot;]//select[@name=&quot;search_results_region&quot;]/option&#39;</span><span class="p">):</span>
 
+        <span class="n">sp_region_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">option</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;value&#39;</span><span class="p">))</span>
 
+
 
+    <span class="k">for</span> <span class="n">eng_tag</span> <span class="ow">in</span> <span class="n">sp_region_names</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">eng_tag</span> <span class="o">==</span> <span class="s1">&#39;all&#39;</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">babel_region_tag</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;no_NO&#39;</span><span class="p">:</span> <span class="s1">&#39;nb_NO&#39;</span><span class="p">}</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">)</span>  <span class="c1"># norway</span>
 
+
 
+        <span class="k">if</span> <span class="s1">&#39;-&#39;</span> <span class="ow">in</span> <span class="n">babel_region_tag</span><span class="p">:</span>
 
+            <span class="n">l</span><span class="p">,</span> <span class="n">r</span> <span class="o">=</span> <span class="n">babel_region_tag</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+            <span class="n">r</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</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="n">l</span> <span class="o">+</span> <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">r</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;_&#39;</span><span class="p">))</span>
 
+
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</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="n">babel_region_tag</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;_&#39;</span><span class="p">))</span>
 
+
 
+            <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: can&#39;t determine babel locale of startpage&#39;s locale </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">eng_tag</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+
 
+    <span class="c1"># languages</span>
 
+
 
+    <span class="n">catalog_engine2code</span> <span class="o">=</span> <span class="p">{</span><span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span> <span class="n">lang_code</span> <span class="k">for</span> <span class="n">lang_code</span><span class="p">,</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">(</span><span class="s1">&#39;en&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
 
+
 
+    <span class="c1"># get the native name of every language known by babel</span>
 
+
 
+    <span class="k">for</span> <span class="n">lang_code</span> <span class="ow">in</span> <span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">lang_code</span><span class="p">:</span> <span class="n">lang_code</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="n">babel</span><span class="o">.</span><span class="n">localedata</span><span class="o">.</span><span class="n">locale_identifiers</span><span class="p">()):</span>
 
+        <span class="n">native_name</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">(</span><span class="n">lang_code</span><span class="p">)</span><span class="o">.</span><span class="n">get_language_name</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">native_name</span><span class="p">:</span>
 
+            <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;ERROR: language name of startpage&#39;s language </span><span class="si">{</span><span class="n">lang_code</span><span class="si">}</span><span class="s2"> is unknown by babel&quot;</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">native_name</span> <span class="o">=</span> <span class="n">native_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
 
+        <span class="c1"># add native name exactly as it is</span>
 
+        <span class="n">catalog_engine2code</span><span class="p">[</span><span class="n">native_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">lang_code</span>
 
+
 
+        <span class="c1"># add &quot;normalized&quot; language name (i.e. français becomes francais and español becomes espanol)</span>
 
+        <span class="n">unaccented_name</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="ow">not</span> <span class="n">combining</span><span class="p">(</span><span class="n">c</span><span class="p">),</span> <span class="n">normalize</span><span class="p">(</span><span class="s1">&#39;NFKD&#39;</span><span class="p">,</span> <span class="n">native_name</span><span class="p">)))</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">unaccented_name</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">unaccented_name</span><span class="o">.</span><span class="n">encode</span><span class="p">()):</span>
 
+            <span class="c1"># add only if result is ascii (otherwise &quot;normalization&quot; didn&#39;t work)</span>
 
+            <span class="n">catalog_engine2code</span><span class="p">[</span><span class="n">unaccented_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">lang_code</span>
 
+
 
+    <span class="c1"># values that can&#39;t be determined by babel&#39;s languages names</span>
 
+
 
+    <span class="n">catalog_engine2code</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
 
+        <span class="p">{</span>
 
+            <span class="c1"># traditional chinese used in ..</span>
 
+            <span class="s1">&#39;fantizhengwen&#39;</span><span class="p">:</span> <span class="s1">&#39;zh_Hant&#39;</span><span class="p">,</span>
 
+            <span class="c1"># Korean alphabet</span>
 
+            <span class="s1">&#39;hangul&#39;</span><span class="p">:</span> <span class="s1">&#39;ko&#39;</span><span class="p">,</span>
 
+            <span class="c1"># Malayalam is one of 22 scheduled languages of India.</span>
 
+            <span class="s1">&#39;malayam&#39;</span><span class="p">:</span> <span class="s1">&#39;ml&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;norsk&#39;</span><span class="p">:</span> <span class="s1">&#39;nb&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;sinhalese&#39;</span><span class="p">:</span> <span class="s1">&#39;si&#39;</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="n">skip_eng_tags</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;english_uk&#39;</span><span class="p">,</span>  <span class="c1"># SearXNG lang &#39;en&#39; already maps to &#39;english&#39;</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//form[@name=&quot;settings&quot;]//select[@name=&quot;language&quot;]/option&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">option</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;value&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">eng_tag</span> <span class="ow">in</span> <span class="n">skip_eng_tags</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">name</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">option</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
 
+
 
+        <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">catalog_engine2code</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">sxng_tag</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">catalog_engine2code</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 342 - 0
_modules/searx/engines/tineye.html
View File 

@@ -0,0 +1,342 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.tineye &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.tineye</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.tineye</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This engine implements *Tineye - reverse image search*</span>
 
+
 
+<span class="sd">Using TinEye, you can search by image or perform what we call a reverse image</span>
 
+<span class="sd">search.  You can do that by uploading an image or searching by URL. You can also</span>
 
+<span class="sd">simply drag and drop your images to start your search.  TinEye constantly crawls</span>
 
+<span class="sd">the web and adds images to its index.  Today, the TinEye index is over 50.2</span>
 
+<span class="sd">billion images `[tineye.com] &lt;https://tineye.com/how&gt;`_.</span>
 
+
 
+<span class="sd">.. hint::</span>
 
+
 
+<span class="sd">   This SearXNG engine only supports *&#39;searching by URL&#39;* and it does not use</span>
 
+<span class="sd">   the official API `[api.tineye.com] &lt;https://api.tineye.com/python/docs/&gt;`_.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</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">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
 
+
 
+    <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://tineye.com&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q2382535&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://api.tineye.com/python/docs/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;online_url_search&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;:py:obj:`searx.search.processors.online_url_search`&quot;&quot;&quot;</span>
 
+
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://tineye.com&#39;</span>
 
+<span class="n">search_string</span> <span class="o">=</span> <span class="s1">&#39;/api/v1/result_json/?page=</span><span class="si">{page}</span><span class="s1">&amp;</span><span class="si">{query}</span><span class="s1">&#39;</span>
 
+
 
+<span class="n">FORMAT_NOT_SUPPORTED</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span>
 
+    <span class="s2">&quot;Could not read that image url. This may be due to an unsupported file&quot;</span>
 
+    <span class="s2">&quot; format. TinEye only supports images that are JPEG, PNG, GIF, BMP, TIFF or WebP.&quot;</span>
 
+<span class="p">)</span>
 
+<span class="sd">&quot;&quot;&quot;TinEye error message&quot;&quot;&quot;</span>
 
+
 
+<span class="n">NO_SIGNATURE_ERROR</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span>
 
+    <span class="s2">&quot;The image is too simple to find matches. TinEye requires a basic level of&quot;</span>
 
+    <span class="s2">&quot; visual detail to successfully identify matches.&quot;</span>
 
+<span class="p">)</span>
 
+<span class="sd">&quot;&quot;&quot;TinEye error message&quot;&quot;&quot;</span>
 
+
 
+<span class="n">DOWNLOAD_ERROR</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;The image could not be downloaded.&quot;</span><span class="p">)</span>
 
+<span class="sd">&quot;&quot;&quot;TinEye error message&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online_url_search/tineye.html#searx.engines.tineye.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Build TinEye HTTP request using ``search_urls`` of a :py:obj:`engine_type`.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;raise_for_httperror&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
 
+
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;search_urls&#39;</span><span class="p">][</span><span class="s1">&#39;data:image&#39;</span><span class="p">]:</span>
 
+        <span class="n">query</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;search_urls&#39;</span><span class="p">][</span><span class="s1">&#39;data:image&#39;</span><span class="p">]</span>
 
+    <span class="k">elif</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;search_urls&#39;</span><span class="p">][</span><span class="s1">&#39;http&#39;</span><span class="p">]:</span>
 
+        <span class="n">query</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;search_urls&#39;</span><span class="p">][</span><span class="s1">&#39;http&#39;</span><span class="p">]</span>
 
+
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;query URL: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
 
+    <span class="n">query</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">})</span>
 
+
 
+    <span class="c1"># see https://github.com/TinEye/pytineye/blob/main/pytineye/api.py</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">search_string</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="n">query</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">])</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
 
+        <span class="p">{</span>
 
+            <span class="s1">&#39;Connection&#39;</span><span class="p">:</span> <span class="s1">&#39;keep-alive&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;Accept-Encoding&#39;</span><span class="p">:</span> <span class="s1">&#39;gzip, defalte, br&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;Host&#39;</span><span class="p">:</span> <span class="s1">&#39;tineye.com&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;DNT&#39;</span><span class="p">:</span> <span class="s1">&#39;1&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;TE&#39;</span><span class="p">:</span> <span class="s1">&#39;trailers&#39;</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+    <span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="parse_tineye_match">
 
+<a class="viewcode-back" href="../../../dev/engines/online_url_search/tineye.html#searx.engines.tineye.parse_tineye_match">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">parse_tineye_match</span><span class="p">(</span><span class="n">match_json</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Takes parsed JSON from the API server and turns it into a :py:obj:`dict`</span>
 
+<span class="sd">    object.</span>
 
+
 
+<span class="sd">    Attributes `(class Match) &lt;https://github.com/TinEye/pytineye/blob/main/pytineye/api.py&gt;`__</span>
 
+
 
+<span class="sd">    - `image_url`, link to the result image.</span>
 
+<span class="sd">    - `domain`, domain this result was found on.</span>
 
+<span class="sd">    - `score`, a number (0 to 100) that indicates how closely the images match.</span>
 
+<span class="sd">    - `width`, image width in pixels.</span>
 
+<span class="sd">    - `height`, image height in pixels.</span>
 
+<span class="sd">    - `size`, image area in pixels.</span>
 
+<span class="sd">    - `format`, image format.</span>
 
+<span class="sd">    - `filesize`, image size in bytes.</span>
 
+<span class="sd">    - `overlay`, overlay URL.</span>
 
+<span class="sd">    - `tags`, whether this match belongs to a collection or stock domain.</span>
 
+
 
+<span class="sd">    - `backlinks`, a list of Backlink objects pointing to the original websites</span>
 
+<span class="sd">      and image URLs. List items are instances of :py:obj:`dict`, (`Backlink</span>
 
+<span class="sd">      &lt;https://github.com/TinEye/pytineye/blob/main/pytineye/api.py&gt;`__):</span>
 
+
 
+<span class="sd">      - `url`, the image URL to the image.</span>
 
+<span class="sd">      - `backlink`, the original website URL.</span>
 
+<span class="sd">      - `crawl_date`, the date the image was crawled.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># HINT: there exists an alternative backlink dict in the domains list / e.g.::</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1">#     match_json[&#39;domains&#39;][0][&#39;backlinks&#39;]</span>
 
+
 
+    <span class="n">backlinks</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">if</span> <span class="s2">&quot;backlinks&quot;</span> <span class="ow">in</span> <span class="n">match_json</span><span class="p">:</span>
 
+
 
+        <span class="k">for</span> <span class="n">backlink_json</span> <span class="ow">in</span> <span class="n">match_json</span><span class="p">[</span><span class="s2">&quot;backlinks&quot;</span><span class="p">]:</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">backlink_json</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="n">crawl_date</span> <span class="o">=</span> <span class="n">backlink_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;crawl_date&quot;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">crawl_date</span><span class="p">:</span>
 
+                <span class="n">crawl_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">crawl_date</span><span class="p">,</span> <span class="s1">&#39;%Y-%m-</span><span class="si">%d</span><span class="s1">&#39;</span><span class="p">)</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">crawl_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">min</span>
 
+
 
+            <span class="n">backlinks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                <span class="p">{</span>
 
+                    <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">backlink_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;url&quot;</span><span class="p">),</span>
 
+                    <span class="s1">&#39;backlink&#39;</span><span class="p">:</span> <span class="n">backlink_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;backlink&quot;</span><span class="p">),</span>
 
+                    <span class="s1">&#39;crawl_date&#39;</span><span class="p">:</span> <span class="n">crawl_date</span><span class="p">,</span>
 
+                    <span class="s1">&#39;image_name&#39;</span><span class="p">:</span> <span class="n">backlink_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;image_name&quot;</span><span class="p">),</span>
 
+                <span class="p">}</span>
 
+            <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="p">{</span>
 
+        <span class="s1">&#39;image_url&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;image_url&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;domain&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;domain&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;score&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;score&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;width&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;width&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;height&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;height&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;size&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;size&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;image_format&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;format&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;filesize&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;filesize&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;overlay&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;overlay&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;tags&#39;</span><span class="p">:</span> <span class="n">match_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;tags&quot;</span><span class="p">),</span>
 
+        <span class="s1">&#39;backlinks&#39;</span><span class="p">:</span> <span class="n">backlinks</span><span class="p">,</span>
 
+    <span class="p">}</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online_url_search/tineye.html#searx.engines.tineye.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse HTTP response from TinEye.&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="c1"># handle the 422 client side errors, and the possible 400 status code error</span>
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="ow">in</span> <span class="p">(</span><span class="mi">400</span><span class="p">,</span> <span class="mi">422</span><span class="p">):</span>
 
+        <span class="n">json_data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+        <span class="n">suggestions</span> <span class="o">=</span> <span class="n">json_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;suggestions&#39;</span><span class="p">,</span> <span class="p">{})</span>
 
+        <span class="n">message</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;HTTP Status Code: </span><span class="si">{</span><span class="n">resp</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s1">&#39;</span>
 
+
 
+        <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">422</span><span class="p">:</span>
 
+            <span class="n">s_key</span> <span class="o">=</span> <span class="n">suggestions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;key&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">s_key</span> <span class="o">==</span> <span class="s2">&quot;Invalid image URL&quot;</span><span class="p">:</span>
 
+                <span class="c1"># test https://docs.searxng.org/_static/searxng-wordmark.svg</span>
 
+                <span class="n">message</span> <span class="o">=</span> <span class="n">FORMAT_NOT_SUPPORTED</span>
 
+            <span class="k">elif</span> <span class="n">s_key</span> <span class="o">==</span> <span class="s1">&#39;NO_SIGNATURE_ERROR&#39;</span><span class="p">:</span>
 
+                <span class="c1"># test https://pngimg.com/uploads/dot/dot_PNG4.png</span>
 
+                <span class="n">message</span> <span class="o">=</span> <span class="n">NO_SIGNATURE_ERROR</span>
 
+            <span class="k">elif</span> <span class="n">s_key</span> <span class="o">==</span> <span class="s1">&#39;Download Error&#39;</span><span class="p">:</span>
 
+                <span class="c1"># test https://notexists</span>
 
+                <span class="n">message</span> <span class="o">=</span> <span class="n">DOWNLOAD_ERROR</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;Unknown suggestion key encountered: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">s_key</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>  <span class="c1"># 400</span>
 
+            <span class="n">description</span> <span class="o">=</span> <span class="n">suggestions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;description&#39;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">description</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 
+                <span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;,&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
 
+
 
+        <span class="c1"># see https://github.com/searxng/searxng/pull/1456#issuecomment-1193105023</span>
 
+        <span class="c1"># results.add(results.types.Answer(answer=message))</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">results</span>
 
+
 
+    <span class="c1"># Raise for all other responses</span>
 
+    <span class="n">resp</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
 
+
 
+    <span class="n">json_data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+
 
+    <span class="k">for</span> <span class="n">match_json</span> <span class="ow">in</span> <span class="n">json_data</span><span class="p">[</span><span class="s1">&#39;matches&#39;</span><span class="p">]:</span>
 
+
 
+        <span class="n">tineye_match</span> <span class="o">=</span> <span class="n">parse_tineye_match</span><span class="p">(</span><span class="n">match_json</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">tineye_match</span><span class="p">[</span><span class="s1">&#39;backlinks&#39;</span><span class="p">]:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">backlink</span> <span class="o">=</span> <span class="n">tineye_match</span><span class="p">[</span><span class="s1">&#39;backlinks&#39;</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;images.html&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">backlink</span><span class="p">[</span><span class="s1">&#39;backlink&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;thumbnail_src&#39;</span><span class="p">:</span> <span class="n">tineye_match</span><span class="p">[</span><span class="s1">&#39;image_url&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;source&#39;</span><span class="p">:</span> <span class="n">backlink</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">backlink</span><span class="p">[</span><span class="s1">&#39;image_name&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">backlink</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;format&#39;</span><span class="p">:</span> <span class="n">tineye_match</span><span class="p">[</span><span class="s1">&#39;image_format&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;width&#39;</span><span class="p">:</span> <span class="n">tineye_match</span><span class="p">[</span><span class="s1">&#39;width&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;height&#39;</span><span class="p">:</span> <span class="n">tineye_match</span><span class="p">[</span><span class="s1">&#39;height&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">backlink</span><span class="p">[</span><span class="s1">&#39;crawl_date&#39;</span><span class="p">],</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="c1"># append number of results</span>
 
+
 
+    <span class="n">number_of_results</span> <span class="o">=</span> <span class="n">json_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;num_matches&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">number_of_results</span><span class="p">:</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;number_of_results&#39;</span><span class="p">:</span> <span class="n">number_of_results</span><span class="p">})</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 367 - 0
_modules/searx/engines/torznab.html
View File 

@@ -0,0 +1,367 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.torznab &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.torznab</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.torznab</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Torznab_ is an API specification that provides a standardized way to query</span>
 
+<span class="sd">torrent site for content. It is used by a number of torrent applications,</span>
 
+<span class="sd">including Prowlarr_ and Jackett_.</span>
 
+
 
+<span class="sd">Using this engine together with Prowlarr_ or Jackett_ allows you to search</span>
 
+<span class="sd">a huge number of torrent sites which are not directly supported.</span>
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">The engine has the following settings:</span>
 
+
 
+<span class="sd">``base_url``:</span>
 
+<span class="sd">  Torznab endpoint URL.</span>
 
+
 
+<span class="sd">``api_key``:</span>
 
+<span class="sd">  The API key to use for authentication.</span>
 
+
 
+<span class="sd">``torznab_categories``:</span>
 
+<span class="sd">  The categories to use for searching. This is a list of category IDs.  See</span>
 
+<span class="sd">  Prowlarr-categories_ or Jackett-categories_ for more information.</span>
 
+
 
+<span class="sd">``show_torrent_files``:</span>
 
+<span class="sd">  Whether to show the torrent file in the search results.  Be careful as using</span>
 
+<span class="sd">  this with Prowlarr_ or Jackett_ leaks the API key.  This should be used only</span>
 
+<span class="sd">  if you are querying a Torznab endpoint without authentication or if the</span>
 
+<span class="sd">  instance is private.  Be aware that private trackers may ban you if you share</span>
 
+<span class="sd">  the torrent file.  Defaults to ``false``.</span>
 
+
 
+<span class="sd">``show_magnet_links``:</span>
 
+<span class="sd">  Whether to show the magnet link in the search results.  Be aware that private</span>
 
+<span class="sd">  trackers may ban you if you share the magnet link.  Defaults to ``true``.</span>
 
+
 
+<span class="sd">.. _Torznab:</span>
 
+<span class="sd">   https://torznab.github.io/spec-1.3-draft/index.html</span>
 
+<span class="sd">.. _Prowlarr:</span>
 
+<span class="sd">   https://github.com/Prowlarr/Prowlarr</span>
 
+<span class="sd">.. _Jackett:</span>
 
+<span class="sd">   https://github.com/Jackett/Jackett</span>
 
+<span class="sd">.. _Prowlarr-categories:</span>
 
+<span class="sd">   https://wiki.servarr.com/en/prowlarr/cardigann-yml-definition#categories</span>
 
+<span class="sd">.. _Jackett-categories:</span>
 
+<span class="sd">   https://github.com/Jackett/Jackett/wiki/Jackett-Categories</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">quote</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">etree</span>  <span class="c1"># type: ignore</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">SearxEngineAPIException</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">humanize_bytes</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</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">logging</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="c1"># engine settings</span>
 
+<span class="n">about</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s2">&quot;https://torznab.github.io/spec-1.3-draft&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;XML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="n">categories</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;files&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="n">time_range_support</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
 
+
 
+<span class="c1"># defined in settings.yml</span>
 
+<span class="c1"># example (Jackett): &quot;http://localhost:9117/api/v2.0/indexers/all/results/torznab&quot;</span>
 
+<span class="n">base_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="n">api_key</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="c1"># https://newznab.readthedocs.io/en/latest/misc/api/#predefined-categories</span>
 
+<span class="n">torznab_categories</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="n">show_torrent_files</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="n">show_magnet_links</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+
 
+<div class="viewcode-block" id="init">
 
+<a class="viewcode-back" href="../../../dev/engines/online/torznab.html#searx.engines.torznab.init">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialize the engine.&quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">base_url</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;missing torznab base_url&#39;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/torznab.html#searx.engines.torznab.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Build the request params.&quot;&quot;&quot;</span>
 
+    <span class="n">search_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="s1">&#39;?t=search&amp;q=</span><span class="si">{search_query}</span><span class="s1">&#39;</span>
 
+
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">api_key</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 
+        <span class="n">search_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;apikey=</span><span class="si">{api_key}</span><span class="s1">&#39;</span>
 
+    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">torznab_categories</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 
+        <span class="n">search_url</span> <span class="o">+=</span> <span class="s1">&#39;&amp;cat=</span><span class="si">{torznab_categories}</span><span class="s1">&#39;</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
 
+        <span class="n">search_query</span><span class="o">=</span><span class="n">quote</span><span class="p">(</span><span class="n">query</span><span class="p">),</span> <span class="n">api_key</span><span class="o">=</span><span class="n">api_key</span><span class="p">,</span> <span class="n">torznab_categories</span><span class="o">=</span><span class="s2">&quot;,&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">torznab_categories</span><span class="p">])</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/torznab.html#searx.engines.torznab.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse the XML response and return a list of results.&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">search_results</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">XML</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">content</span><span class="p">)</span>
 
+
 
+    <span class="c1"># handle errors:  https://newznab.readthedocs.io/en/latest/misc/api/#newznab-error-codes</span>
 
+    <span class="k">if</span> <span class="n">search_results</span><span class="o">.</span><span class="n">tag</span> <span class="o">==</span> <span class="s2">&quot;error&quot;</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineAPIException</span><span class="p">(</span><span class="n">search_results</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;description&quot;</span><span class="p">))</span>
 
+
 
+    <span class="n">channel</span><span class="p">:</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span> <span class="o">=</span> <span class="n">search_results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+
 
+    <span class="n">item</span><span class="p">:</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span>
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">channel</span><span class="o">.</span><span class="n">iterfind</span><span class="p">(</span><span class="s1">&#39;item&#39;</span><span class="p">):</span>
 
+        <span class="n">result</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">build_result</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="build_result">
 
+<a class="viewcode-back" href="../../../dev/engines/online/torznab.html#searx.engines.torznab.build_result">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">build_result</span><span class="p">(</span><span class="n">item</span><span class="p">:</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Build a result from a XML item.&quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># extract attributes from XML</span>
 
+    <span class="c1"># see https://torznab.github.io/spec-1.3-draft/torznab/Specification-v1.3.html#predefined-attributes</span>
 
+    <span class="n">enclosure</span><span class="p">:</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;enclosure&#39;</span><span class="p">)</span>
 
+    <span class="n">enclosure_url</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="k">if</span> <span class="n">enclosure</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">enclosure_url</span> <span class="o">=</span> <span class="n">enclosure</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;url&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">filesize</span> <span class="o">=</span> <span class="n">get_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;size&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">filesize</span> <span class="ow">and</span> <span class="n">enclosure</span><span class="p">:</span>
 
+        <span class="n">filesize</span> <span class="o">=</span> <span class="n">enclosure</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;length&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">guid</span> <span class="o">=</span> <span class="n">get_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;guid&#39;</span><span class="p">)</span>
 
+    <span class="n">comments</span> <span class="o">=</span> <span class="n">get_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;comments&#39;</span><span class="p">)</span>
 
+    <span class="n">pubDate</span> <span class="o">=</span> <span class="n">get_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;pubDate&#39;</span><span class="p">)</span>
 
+    <span class="n">seeders</span> <span class="o">=</span> <span class="n">get_torznab_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;seeders&#39;</span><span class="p">)</span>
 
+    <span class="n">leechers</span> <span class="o">=</span> <span class="n">get_torznab_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;leechers&#39;</span><span class="p">)</span>
 
+    <span class="n">peers</span> <span class="o">=</span> <span class="n">get_torznab_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;peers&#39;</span><span class="p">)</span>
 
+
 
+    <span class="c1"># map attributes to searx result</span>
 
+    <span class="n">result</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;torrent.html&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">get_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">),</span>
 
+        <span class="s1">&#39;filesize&#39;</span><span class="p">:</span> <span class="n">humanize_bytes</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">filesize</span><span class="p">))</span> <span class="k">if</span> <span class="n">filesize</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
 
+        <span class="s1">&#39;files&#39;</span><span class="p">:</span> <span class="n">get_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;files&#39;</span><span class="p">),</span>
 
+        <span class="s1">&#39;seed&#39;</span><span class="p">:</span> <span class="n">seeders</span><span class="p">,</span>
 
+        <span class="s1">&#39;leech&#39;</span><span class="p">:</span> <span class="n">_map_leechers</span><span class="p">(</span><span class="n">leechers</span><span class="p">,</span> <span class="n">seeders</span><span class="p">,</span> <span class="n">peers</span><span class="p">),</span>
 
+        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">_map_result_url</span><span class="p">(</span><span class="n">guid</span><span class="p">,</span> <span class="n">comments</span><span class="p">),</span>
 
+        <span class="s1">&#39;publishedDate&#39;</span><span class="p">:</span> <span class="n">_map_published_date</span><span class="p">(</span><span class="n">pubDate</span><span class="p">),</span>
 
+        <span class="s1">&#39;torrentfile&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+        <span class="s1">&#39;magnetlink&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">link</span> <span class="o">=</span> <span class="n">get_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;link&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">show_torrent_files</span><span class="p">:</span>
 
+        <span class="n">result</span><span class="p">[</span><span class="s1">&#39;torrentfile&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_map_torrent_file</span><span class="p">(</span><span class="n">link</span><span class="p">,</span> <span class="n">enclosure_url</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">show_magnet_links</span><span class="p">:</span>
 
+        <span class="n">magneturl</span> <span class="o">=</span> <span class="n">get_torznab_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;magneturl&#39;</span><span class="p">)</span>
 
+        <span class="n">result</span><span class="p">[</span><span class="s1">&#39;magnetlink&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_map_magnet_link</span><span class="p">(</span><span class="n">magneturl</span><span class="p">,</span> <span class="n">guid</span><span class="p">,</span> <span class="n">enclosure_url</span><span class="p">,</span> <span class="n">link</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">result</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_map_result_url</span><span class="p">(</span><span class="n">guid</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="n">comments</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">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+    <span class="k">if</span> <span class="n">guid</span> <span class="ow">and</span> <span class="n">guid</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;http&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">guid</span>
 
+    <span class="k">if</span> <span class="n">comments</span> <span class="ow">and</span> <span class="n">comments</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;http&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">comments</span>
 
+    <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_map_leechers</span><span class="p">(</span><span class="n">leechers</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="n">seeders</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="n">peers</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">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+    <span class="k">if</span> <span class="n">leechers</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">leechers</span>
 
+    <span class="k">if</span> <span class="n">seeders</span> <span class="ow">and</span> <span class="n">peers</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">peers</span><span class="p">)</span> <span class="o">-</span> <span class="nb">int</span><span class="p">(</span><span class="n">seeders</span><span class="p">))</span>
 
+    <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_map_published_date</span><span class="p">(</span><span class="n">pubDate</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">-&gt;</span> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+    <span class="k">if</span> <span class="n">pubDate</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">pubDate</span><span class="p">,</span> <span class="s1">&#39;</span><span class="si">%a</span><span class="s1">, </span><span class="si">%d</span><span class="s1"> %b %Y %H:%M:%S %z&#39;</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="p">(</span><span class="ne">ValueError</span><span class="p">,</span> <span class="ne">TypeError</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;ignore exception (publishedDate): </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_map_torrent_file</span><span class="p">(</span><span class="n">link</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="n">enclosure_url</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">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+    <span class="k">if</span> <span class="n">link</span> <span class="ow">and</span> <span class="n">link</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;http&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">link</span>
 
+    <span class="k">if</span> <span class="n">enclosure_url</span> <span class="ow">and</span> <span class="n">enclosure_url</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;http&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">enclosure_url</span>
 
+    <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_map_magnet_link</span><span class="p">(</span>
 
+    <span class="n">magneturl</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="n">guid</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="n">enclosure_url</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="n">link</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="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+    <span class="k">if</span> <span class="n">magneturl</span> <span class="ow">and</span> <span class="n">magneturl</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;magnet&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">magneturl</span>
 
+    <span class="k">if</span> <span class="n">guid</span> <span class="ow">and</span> <span class="n">guid</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;magnet&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">guid</span>
 
+    <span class="k">if</span> <span class="n">enclosure_url</span> <span class="ow">and</span> <span class="n">enclosure_url</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;magnet&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">enclosure_url</span>
 
+    <span class="k">if</span> <span class="n">link</span> <span class="ow">and</span> <span class="n">link</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;magnet&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">link</span>
 
+    <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_attribute">
 
+<a class="viewcode-back" href="../../../dev/engines/online/torznab.html#searx.engines.torznab.get_attribute">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">:</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">,</span> <span class="n">property_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get attribute from item.&quot;&quot;&quot;</span>
 
+    <span class="n">property_element</span><span class="p">:</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">property_name</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">property_element</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">property_element</span><span class="o">.</span><span class="n">text</span>
 
+    <span class="k">return</span> <span class="kc">None</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_torznab_attribute">
 
+<a class="viewcode-back" href="../../../dev/engines/online/torznab.html#searx.engines.torznab.get_torznab_attribute">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_torznab_attribute</span><span class="p">(</span><span class="n">item</span><span class="p">:</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span><span class="p">,</span> <span class="n">attribute_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get torznab special attribute from item.&quot;&quot;&quot;</span>
 
+    <span class="n">element</span><span class="p">:</span> <span class="n">etree</span><span class="o">.</span><span class="n">Element</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">find</span><span class="p">(</span>
 
+        <span class="s1">&#39;.//torznab:attr[@name=&quot;</span><span class="si">{attribute_name}</span><span class="s1">&quot;]&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">attribute_name</span><span class="o">=</span><span class="n">attribute_name</span><span class="p">),</span>
 
+        <span class="p">{</span><span class="s1">&#39;torznab&#39;</span><span class="p">:</span> <span class="s1">&#39;http://torznab.com/schemas/2015/feed&#39;</span><span class="p">},</span>
 
+    <span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">element</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">element</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="kc">None</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 201 - 0
_modules/searx/engines/voidlinux.html
View File 

@@ -0,0 +1,201 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.voidlinux &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.voidlinux</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.voidlinux</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;SearXNG engine for `Void Linux binary packages`_.  Void is a general purpose</span>
 
+<span class="sd">operating system, based on the monolithic Linux kernel. Its package system</span>
 
+<span class="sd">allows you to quickly install, update and remove software; software is provided</span>
 
+<span class="sd">in binary packages or can be built directly from sources with the help of the</span>
 
+<span class="sd">XBPS source packages collection.</span>
 
+
 
+<span class="sd">.. _Void Linux binary packages: https://voidlinux.org/packages/</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</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">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">quote_plus</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">humanize_bytes</span>
 
+
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;website&#39;</span><span class="p">:</span> <span class="s1">&#39;https://voidlinux.org/packages/&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;wikidata_id&#39;</span><span class="p">:</span> <span class="s1">&#39;Q19310966&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;use_official_api&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s1">&#39;official_api_documentation&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s1">&#39;require_api_key&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s1">&#39;results&#39;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;packages&#39;</span><span class="p">,</span> <span class="s1">&#39;it&#39;</span><span class="p">]</span>
 
+
 
+<span class="n">base_url</span> <span class="o">=</span> <span class="s2">&quot;https://xq-api.voidlinux.org&quot;</span>
 
+<span class="n">pkg_repo_url</span> <span class="o">=</span> <span class="s2">&quot;https://github.com/void-linux/void-packages&quot;</span>
 
+
 
+<span class="n">void_arch</span> <span class="o">=</span> <span class="s1">&#39;x86_64&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;Default architecture to search for.  For valid values see :py:obj:`ARCH_RE`&quot;&quot;&quot;</span>
 
+
 
+<span class="n">ARCH_RE</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="s1">&#39;aarch64-musl|armv6l-musl|armv7l-musl|x86_64-musl|aarch64|armv6l|armv7l|i686|x86_64&#39;</span><span class="p">)</span>
 
+<span class="sd">&quot;&quot;&quot;Regular expression that match a architecture in the query string.&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+    <span class="n">arch_path</span> <span class="o">=</span> <span class="n">ARCH_RE</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="k">if</span> <span class="n">arch_path</span><span class="p">:</span>
 
+        <span class="n">arch_path</span> <span class="o">=</span> <span class="n">arch_path</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 
+        <span class="n">query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">arch_path</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">arch_path</span> <span class="o">=</span> <span class="n">void_arch</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s2">/v1/query/</span><span class="si">{</span><span class="n">arch_path</span><span class="si">}</span><span class="s2">?q=</span><span class="si">{</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/void.html#searx.engines.voidlinux.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">    At Void Linux, several packages sometimes share the same source code</span>
 
+<span class="sd">    (template) and therefore also have the same URL.  Results with identical</span>
 
+<span class="sd">    URLs are merged as one result for SearXNG.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">packages</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()[</span><span class="s1">&#39;data&#39;</span><span class="p">]:</span>
 
+
 
+        <span class="c1"># 32bit and dbg packages don&#39;t have their own package templates</span>
 
+        <span class="n">github_slug</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="sa">r</span><span class="s2">&quot;-(32bit|dbg)$&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">])</span>
 
+        <span class="n">pkg_url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">pkg_repo_url</span><span class="si">}</span><span class="s2">/tree/master/srcpkgs/</span><span class="si">{</span><span class="n">github_slug</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+        <span class="n">pkg_list</span> <span class="o">=</span> <span class="n">packages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">pkg_url</span><span class="p">,</span> <span class="p">[])</span>
 
+        <span class="n">pkg_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;short_desc&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2"> - </span><span class="si">{</span><span class="n">humanize_bytes</span><span class="p">(</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;filename_size&#39;</span><span class="p">])</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
 
+                <span class="s1">&#39;package_name&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;version&#39;</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;v</span><span class="si">{</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;version&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">result</span><span class="p">[</span><span class="s1">&#39;revision&#39;</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
 
+                <span class="s1">&#39;tags&#39;</span><span class="p">:</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;repository&#39;</span><span class="p">],</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+        <span class="n">packages</span><span class="p">[</span><span class="n">pkg_url</span><span class="p">]</span> <span class="o">=</span> <span class="n">pkg_list</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">pkg_url</span><span class="p">,</span> <span class="n">pkg_list</span> <span class="ow">in</span> <span class="n">packages</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">pkg_url</span><span class="p">,</span>
 
+                <span class="s1">&#39;template&#39;</span><span class="p">:</span> <span class="s1">&#39;packages.html&#39;</span><span class="p">,</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="s1">&#39; | &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">pkg_list</span><span class="p">),</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">pkg_list</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s1">&#39;content&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;package_name&#39;</span><span class="p">:</span> <span class="s1">&#39; | &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="s1">&#39;package_name&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">pkg_list</span><span class="p">),</span>
 
+                <span class="s1">&#39;version&#39;</span><span class="p">:</span> <span class="n">pkg_list</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s1">&#39;version&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;tags&#39;</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="p">[</span><span class="s1">&#39;tags&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">pkg_list</span><span class="p">],</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 946 - 0
_modules/searx/engines/wikidata.html
View File 

@@ -0,0 +1,946 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.wikidata &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.wikidata</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.wikidata</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This module implements the Wikidata engine.  Some implementations are shared</span>
 
+<span class="sd">from :ref:`wikipedia engine`.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=missing-class-docstring</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">hashlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">md5</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span><span class="p">,</span> <span class="n">unquote</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="kn">import</span> <span class="n">loads</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">dateutil.parser</span><span class="w"> </span><span class="kn">import</span> <span class="n">isoparse</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">babel.dates</span><span class="w"> </span><span class="kn">import</span> <span class="n">format_datetime</span><span class="p">,</span> <span class="n">format_date</span><span class="p">,</span> <span class="n">format_time</span><span class="p">,</span> <span class="n">get_datetime_format</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">WIKIDATA_UNITS</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">post</span><span class="p">,</span> <span class="n">get</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">searx_useragent</span><span class="p">,</span> <span class="n">get_string_replaces_function</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.external_urls</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_external_url</span><span class="p">,</span> <span class="n">get_earth_coordinates_url</span><span class="p">,</span> <span class="n">area_to_osm_zoom</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines.wikipedia</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">fetch_wikimedia_traits</span><span class="p">,</span>
 
+    <span class="n">get_wiki_params</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">logging</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="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://wikidata.org/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q2013&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://query.wikidata.org/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">display_type</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;infobox&quot;</span><span class="p">]</span>
 
+<span class="sd">&quot;&quot;&quot;A list of display types composed from ``infobox`` and ``list``.  The latter</span>
 
+<span class="sd">one will add a hit to the result list.  The first one will show a hit in the</span>
 
+<span class="sd">info box.  Both values can be set, or one of the two can be set.&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="c1"># SPARQL</span>
 
+<span class="n">SPARQL_ENDPOINT_URL</span> <span class="o">=</span> <span class="s1">&#39;https://query.wikidata.org/sparql&#39;</span>
 
+<span class="n">SPARQL_EXPLAIN_URL</span> <span class="o">=</span> <span class="s1">&#39;https://query.wikidata.org/bigdata/namespace/wdq/sparql?explain&#39;</span>
 
+<span class="n">WIKIDATA_PROPERTIES</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;P434&#39;</span><span class="p">:</span> <span class="s1">&#39;MusicBrainz&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P435&#39;</span><span class="p">:</span> <span class="s1">&#39;MusicBrainz&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P436&#39;</span><span class="p">:</span> <span class="s1">&#39;MusicBrainz&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P966&#39;</span><span class="p">:</span> <span class="s1">&#39;MusicBrainz&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P345&#39;</span><span class="p">:</span> <span class="s1">&#39;IMDb&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P2397&#39;</span><span class="p">:</span> <span class="s1">&#39;YouTube&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P1651&#39;</span><span class="p">:</span> <span class="s1">&#39;YouTube&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P2002&#39;</span><span class="p">:</span> <span class="s1">&#39;Twitter&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P2013&#39;</span><span class="p">:</span> <span class="s1">&#39;Facebook&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P2003&#39;</span><span class="p">:</span> <span class="s1">&#39;Instagram&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P4033&#39;</span><span class="p">:</span> <span class="s1">&#39;Mastodon&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P11947&#39;</span><span class="p">:</span> <span class="s1">&#39;Lemmy&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;P12622&#39;</span><span class="p">:</span> <span class="s1">&#39;PeerTube&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># SERVICE wikibase:mwapi : https://www.mediawiki.org/wiki/Wikidata_Query_Service/User_Manual/MWAPI</span>
 
+<span class="c1"># SERVICE wikibase:label: https://en.wikibooks.org/wiki/SPARQL/SERVICE_-_Label#Manual_Label_SERVICE</span>
 
+<span class="c1"># https://en.wikibooks.org/wiki/SPARQL/WIKIDATA_Precision,_Units_and_Coordinates</span>
 
+<span class="c1"># https://www.mediawiki.org/wiki/Wikibase/Indexing/RDF_Dump_Format#Data_model</span>
 
+<span class="c1"># optimization:</span>
 
+<span class="c1"># * https://www.wikidata.org/wiki/Wikidata:SPARQL_query_service/query_optimization</span>
 
+<span class="c1"># * https://github.com/blazegraph/database/wiki/QueryHints</span>
 
+<span class="n">QUERY_TEMPLATE</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
 
+<span class="s2">SELECT ?item ?itemLabel ?itemDescription ?lat ?long %SELECT%</span>
 
+<span class="s2">WHERE</span>
 
+<span class="s2">{</span>
 
+<span class="s2">  SERVICE wikibase:mwapi {</span>
 
+<span class="s2">        bd:serviceParam wikibase:endpoint &quot;www.wikidata.org&quot;;</span>
 
+<span class="s2">        wikibase:api &quot;EntitySearch&quot;;</span>
 
+<span class="s2">        wikibase:limit 1;</span>
 
+<span class="s2">        mwapi:search &quot;%QUERY%&quot;;</span>
 
+<span class="s2">        mwapi:language &quot;%LANGUAGE%&quot;.</span>
 
+<span class="s2">        ?item wikibase:apiOutputItem mwapi:item.</span>
 
+<span class="s2">  }</span>
 
+<span class="s2">  hint:Prior hint:runFirst &quot;true&quot;.</span>
 
+
 
+<span class="s2">  %WHERE%</span>
 
+
 
+<span class="s2">  SERVICE wikibase:label {</span>
 
+<span class="s2">      bd:serviceParam wikibase:language &quot;%LANGUAGE%,en&quot;.</span>
 
+<span class="s2">      ?item rdfs:label ?itemLabel .</span>
 
+<span class="s2">      ?item schema:description ?itemDescription .</span>
 
+<span class="s2">      %WIKIBASE_LABELS%</span>
 
+<span class="s2">  }</span>
 
+
 
+<span class="s2">}</span>
 
+<span class="s2">GROUP BY ?item ?itemLabel ?itemDescription ?lat ?long </span><span class="si">%G</span><span class="s2">ROUP_BY%</span>
 
+<span class="s2">&quot;&quot;&quot;</span>
 
+
 
+<span class="c1"># Get the calendar names and the property names</span>
 
+<span class="n">QUERY_PROPERTY_NAMES</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
 
+<span class="s2">SELECT ?item ?name</span>
 
+<span class="s2">WHERE {</span>
 
+<span class="s2">    {</span>
 
+<span class="s2">      SELECT ?item</span>
 
+<span class="s2">      WHERE { ?item wdt:P279* wd:Q12132 }</span>
 
+<span class="s2">    } UNION {</span>
 
+<span class="s2">      VALUES ?item { %ATTRIBUTES% }</span>
 
+<span class="s2">    }</span>
 
+<span class="s2">    OPTIONAL { ?item rdfs:label ?name. }</span>
 
+<span class="s2">}</span>
 
+<span class="s2">&quot;&quot;&quot;</span>
 
+
 
+<span class="c1"># see the property &quot;dummy value&quot; of https://www.wikidata.org/wiki/Q2013 (Wikidata)</span>
 
+<span class="c1"># hard coded here to avoid to an additional SPARQL request when the server starts</span>
 
+<span class="n">DUMMY_ENTITY_URLS</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span>
 
+    <span class="s2">&quot;http://www.wikidata.org/entity/&quot;</span> <span class="o">+</span> <span class="n">wid</span> <span class="k">for</span> <span class="n">wid</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">&quot;Q4115189&quot;</span><span class="p">,</span> <span class="s2">&quot;Q13406268&quot;</span><span class="p">,</span> <span class="s2">&quot;Q15397819&quot;</span><span class="p">,</span> <span class="s2">&quot;Q17339402&quot;</span><span class="p">)</span>
 
+<span class="p">)</span>
 
+
 
+
 
+<span class="c1"># https://www.w3.org/TR/sparql11-query/#rSTRING_LITERAL1</span>
 
+<span class="c1"># https://lists.w3.org/Archives/Public/public-rdf-dawg/2011OctDec/0175.html</span>
 
+<span class="n">sparql_string_escape</span> <span class="o">=</span> <span class="n">get_string_replaces_function</span><span class="p">(</span>
 
+    <span class="c1"># fmt: off</span>
 
+    <span class="p">{</span>
 
+        <span class="s1">&#39;</span><span class="se">\t</span><span class="s1">&#39;</span><span class="p">:</span> <span class="s1">&#39;</span><span class="se">\\\t</span><span class="s1">&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">:</span> <span class="s1">&#39;</span><span class="se">\\\n</span><span class="s1">&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;</span><span class="se">\r</span><span class="s1">&#39;</span><span class="p">:</span> <span class="s1">&#39;</span><span class="se">\\\r</span><span class="s1">&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;</span><span class="se">\b</span><span class="s1">&#39;</span><span class="p">:</span> <span class="s1">&#39;</span><span class="se">\\\b</span><span class="s1">&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;</span><span class="se">\f</span><span class="s1">&#39;</span><span class="p">:</span> <span class="s1">&#39;</span><span class="se">\\\f</span><span class="s1">&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;</span><span class="se">\&quot;</span><span class="s1">&#39;</span><span class="p">:</span> <span class="s1">&#39;</span><span class="se">\\\&quot;</span><span class="s1">&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;</span><span class="se">\&#39;</span><span class="s1">&#39;</span><span class="p">:</span> <span class="s1">&#39;</span><span class="se">\\\&#39;</span><span class="s1">&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;</span><span class="se">\\</span><span class="s1">&#39;</span><span class="p">:</span> <span class="s1">&#39;</span><span class="se">\\\\</span><span class="s1">&#39;</span>
 
+    <span class="p">}</span>
 
+    <span class="c1"># fmt: on</span>
 
+<span class="p">)</span>
 
+
 
+<span class="n">replace_http_by_https</span> <span class="o">=</span> <span class="n">get_string_replaces_function</span><span class="p">({</span><span class="s1">&#39;http:&#39;</span><span class="p">:</span> <span class="s1">&#39;https:&#39;</span><span class="p">})</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_headers</span><span class="p">():</span>
 
+    <span class="c1"># user agent: https://www.mediawiki.org/wiki/Wikidata_Query_Service/User_Manual#Query_limits</span>
 
+    <span class="k">return</span> <span class="p">{</span><span class="s1">&#39;Accept&#39;</span><span class="p">:</span> <span class="s1">&#39;application/sparql-results+json&#39;</span><span class="p">,</span> <span class="s1">&#39;User-Agent&#39;</span><span class="p">:</span> <span class="n">searx_useragent</span><span class="p">()}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_label_for_entity</span><span class="p">(</span><span class="n">entity_id</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+    <span class="n">name</span> <span class="o">=</span> <span class="n">WIKIDATA_PROPERTIES</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">entity_id</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">name</span> <span class="o">=</span> <span class="n">WIKIDATA_PROPERTIES</span><span class="o">.</span><span class="n">get</span><span class="p">((</span><span class="n">entity_id</span><span class="p">,</span> <span class="n">language</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">name</span> <span class="o">=</span> <span class="n">WIKIDATA_PROPERTIES</span><span class="o">.</span><span class="n">get</span><span class="p">((</span><span class="n">entity_id</span><span class="p">,</span> <span class="n">language</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]))</span>
 
+    <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">name</span> <span class="o">=</span> <span class="n">WIKIDATA_PROPERTIES</span><span class="o">.</span><span class="n">get</span><span class="p">((</span><span class="n">entity_id</span><span class="p">,</span> <span class="s1">&#39;en&#39;</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">name</span> <span class="o">=</span> <span class="n">entity_id</span>
 
+    <span class="k">return</span> <span class="n">name</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">send_wikidata_query</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;GET&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">&#39;GET&#39;</span><span class="p">:</span>
 
+        <span class="c1"># query will be cached by wikidata</span>
 
+        <span class="n">http_response</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">SPARQL_ENDPOINT_URL</span> <span class="o">+</span> <span class="s1">&#39;?&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span> <span class="n">headers</span><span class="o">=</span><span class="n">get_headers</span><span class="p">(),</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="c1"># query won&#39;t be cached by wikidata</span>
 
+        <span class="n">http_response</span> <span class="o">=</span> <span class="n">post</span><span class="p">(</span><span class="n">SPARQL_ENDPOINT_URL</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">},</span> <span class="n">headers</span><span class="o">=</span><span class="n">get_headers</span><span class="p">(),</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">http_response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;SPARQL endpoint error </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">http_response</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;request time </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">http_response</span><span class="o">.</span><span class="n">elapsed</span><span class="p">))</span>
 
+    <span class="n">http_response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
 
+    <span class="k">return</span> <span class="n">loads</span><span class="p">(</span><span class="n">http_response</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+
 
+    <span class="n">eng_tag</span><span class="p">,</span> <span class="n">_wiki_netloc</span> <span class="o">=</span> <span class="n">get_wiki_params</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="p">)</span>
 
+    <span class="n">query</span><span class="p">,</span> <span class="n">attributes</span> <span class="o">=</span> <span class="n">get_query</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">)</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;request --&gt; language </span><span class="si">%s</span><span class="s2"> // len(attributes): </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">attributes</span><span class="p">))</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;method&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;POST&#39;</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">SPARQL_ENDPOINT_URL</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;query&#39;</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="s1">&#39;headers&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">get_headers</span><span class="p">()</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;attributes&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">attributes</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">jsonresponse</span> <span class="o">=</span> <span class="n">loads</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
 
+
 
+    <span class="n">language</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">search_params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span>
 
+    <span class="n">attributes</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">search_params</span><span class="p">[</span><span class="s1">&#39;attributes&#39;</span><span class="p">]</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;request --&gt; language </span><span class="si">%s</span><span class="s2"> // len(attributes): </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">language</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">attributes</span><span class="p">))</span>
 
+
 
+    <span class="n">seen_entities</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">jsonresponse</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;results&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;bindings&#39;</span><span class="p">,</span> <span class="p">[]):</span>
 
+        <span class="n">attribute_result</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">value</span><span class="p">[</span><span class="s1">&#39;value&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">result</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
 
+        <span class="n">entity_url</span> <span class="o">=</span> <span class="n">attribute_result</span><span class="p">[</span><span class="s1">&#39;item&#39;</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="n">entity_url</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">seen_entities</span> <span class="ow">and</span> <span class="n">entity_url</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">DUMMY_ENTITY_URLS</span><span class="p">:</span>
 
+            <span class="n">seen_entities</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">entity_url</span><span class="p">)</span>
 
+            <span class="n">results</span> <span class="o">+=</span> <span class="n">get_results</span><span class="p">(</span><span class="n">attribute_result</span><span class="p">,</span> <span class="n">attributes</span><span class="p">,</span> <span class="n">language</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;The SPARQL request returns duplicate entities: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">attribute_result</span><span class="p">))</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="n">_IMG_SRC_DEFAULT_URL_PREFIX</span> <span class="o">=</span> <span class="s2">&quot;https://commons.wikimedia.org/wiki/Special:FilePath/&quot;</span>
 
+<span class="n">_IMG_SRC_NEW_URL_PREFIX</span> <span class="o">=</span> <span class="s2">&quot;https://upload.wikimedia.org/wikipedia/commons/thumb/&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_thumbnail">
 
+<a class="viewcode-back" href="../../../dev/engines/online/wikipedia.html#searx.engines.wikidata.get_thumbnail">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_thumbnail</span><span class="p">(</span><span class="n">img_src</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get Thumbnail image from wikimedia commons</span>
 
+
 
+<span class="sd">    Images from commons.wikimedia.org are (HTTP) redirected to</span>
 
+<span class="sd">    upload.wikimedia.org.  The redirected URL can be calculated by this</span>
 
+<span class="sd">    function.</span>
 
+
 
+<span class="sd">    - https://stackoverflow.com/a/33691240</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;get_thumbnail(): </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">img_src</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">img_src</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">_IMG_SRC_DEFAULT_URL_PREFIX</span> <span class="ow">in</span> <span class="n">img_src</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">]:</span>
 
+        <span class="n">img_src_name</span> <span class="o">=</span> <span class="n">unquote</span><span class="p">(</span><span class="n">img_src</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">_IMG_SRC_DEFAULT_URL_PREFIX</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;?&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;%20&quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">))</span>
 
+        <span class="n">img_src_name_first</span> <span class="o">=</span> <span class="n">img_src_name</span>
 
+        <span class="n">img_src_name_second</span> <span class="o">=</span> <span class="n">img_src_name</span>
 
+
 
+        <span class="k">if</span> <span class="s2">&quot;.svg&quot;</span> <span class="ow">in</span> <span class="n">img_src_name</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">]:</span>
 
+            <span class="n">img_src_name_second</span> <span class="o">=</span> <span class="n">img_src_name</span> <span class="o">+</span> <span class="s2">&quot;.png&quot;</span>
 
+
 
+        <span class="n">img_src_size</span> <span class="o">=</span> <span class="n">img_src</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">_IMG_SRC_DEFAULT_URL_PREFIX</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;?&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
 
+        <span class="n">img_src_size</span> <span class="o">=</span> <span class="n">img_src_size</span><span class="p">[</span><span class="n">img_src_size</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s2">&quot;=&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span> <span class="p">:</span> <span class="n">img_src_size</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s2">&quot;&amp;&quot;</span><span class="p">)]</span>
 
+        <span class="n">img_src_name_md5</span> <span class="o">=</span> <span class="n">md5</span><span class="p">(</span><span class="n">img_src_name</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
 
+        <span class="n">img_src</span> <span class="o">=</span> <span class="p">(</span>
 
+            <span class="n">_IMG_SRC_NEW_URL_PREFIX</span>
 
+            <span class="o">+</span> <span class="n">img_src_name_md5</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+            <span class="o">+</span> <span class="s2">&quot;/&quot;</span>
 
+            <span class="o">+</span> <span class="n">img_src_name_md5</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="s2">&quot;/&quot;</span>
 
+            <span class="o">+</span> <span class="n">img_src_name_first</span>
 
+            <span class="o">+</span> <span class="s2">&quot;/&quot;</span>
 
+            <span class="o">+</span> <span class="n">img_src_size</span>
 
+            <span class="o">+</span> <span class="s2">&quot;px-&quot;</span>
 
+            <span class="o">+</span> <span class="n">img_src_name_second</span>
 
+        <span class="p">)</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;get_thumbnail() redirected: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">img_src</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">img_src</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_results</span><span class="p">(</span><span class="n">attribute_result</span><span class="p">,</span> <span class="n">attributes</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+    <span class="c1"># pylint: disable=too-many-branches</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">infobox_title</span> <span class="o">=</span> <span class="n">attribute_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;itemLabel&#39;</span><span class="p">)</span>
 
+    <span class="n">infobox_id</span> <span class="o">=</span> <span class="n">attribute_result</span><span class="p">[</span><span class="s1">&#39;item&#39;</span><span class="p">]</span>
 
+    <span class="n">infobox_id_lang</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">infobox_urls</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">infobox_attributes</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">infobox_content</span> <span class="o">=</span> <span class="n">attribute_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;itemDescription&#39;</span><span class="p">,</span> <span class="p">[])</span>
 
+    <span class="n">img_src</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">img_src_priority</span> <span class="o">=</span> <span class="mi">0</span>
 
+
 
+    <span class="k">for</span> <span class="n">attribute</span> <span class="ow">in</span> <span class="n">attributes</span><span class="p">:</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">attribute</span><span class="o">.</span><span class="n">get_str</span><span class="p">(</span><span class="n">attribute_result</span><span class="p">,</span> <span class="n">language</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">value</span> <span class="o">!=</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
 
+            <span class="n">attribute_type</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">attribute</span><span class="p">)</span>
 
+
 
+            <span class="k">if</span> <span class="n">attribute_type</span> <span class="ow">in</span> <span class="p">(</span><span class="n">WDURLAttribute</span><span class="p">,</span> <span class="n">WDArticle</span><span class="p">):</span>
 
+                <span class="c1"># get_select() method : there is group_concat(distinct ...;separator=&quot;, &quot;)</span>
 
+                <span class="c1"># split the value here</span>
 
+                <span class="k">for</span> <span class="n">url</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;, &#39;</span><span class="p">):</span>
 
+                    <span class="n">infobox_urls</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">attribute</span><span class="o">.</span><span class="n">get_label</span><span class="p">(</span><span class="n">language</span><span class="p">),</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">attribute</span><span class="o">.</span><span class="n">kwargs</span><span class="p">})</span>
 
+                    <span class="c1"># &quot;normal&quot; results (not infobox) include official website and Wikipedia links.</span>
 
+                    <span class="k">if</span> <span class="s2">&quot;list&quot;</span> <span class="ow">in</span> <span class="n">display_type</span> <span class="ow">and</span> <span class="p">(</span><span class="n">attribute</span><span class="o">.</span><span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;official&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">attribute_type</span> <span class="o">==</span> <span class="n">WDArticle</span><span class="p">):</span>
 
+                        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">infobox_title</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s2">&quot;content&quot;</span><span class="p">:</span> <span class="n">infobox_content</span><span class="p">})</span>
 
+
 
+                    <span class="c1"># update the infobox_id with the wikipedia URL</span>
 
+                    <span class="c1"># first the local wikipedia URL, and as fallback the english wikipedia URL</span>
 
+                    <span class="k">if</span> <span class="n">attribute_type</span> <span class="o">==</span> <span class="n">WDArticle</span> <span class="ow">and</span> <span class="p">(</span>
 
+                        <span class="p">(</span><span class="n">attribute</span><span class="o">.</span><span class="n">language</span> <span class="o">==</span> <span class="s1">&#39;en&#39;</span> <span class="ow">and</span> <span class="n">infobox_id_lang</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">or</span> <span class="n">attribute</span><span class="o">.</span><span class="n">language</span> <span class="o">!=</span> <span class="s1">&#39;en&#39;</span>
 
+                    <span class="p">):</span>
 
+                        <span class="n">infobox_id_lang</span> <span class="o">=</span> <span class="n">attribute</span><span class="o">.</span><span class="n">language</span>
 
+                        <span class="n">infobox_id</span> <span class="o">=</span> <span class="n">url</span>
 
+            <span class="k">elif</span> <span class="n">attribute_type</span> <span class="o">==</span> <span class="n">WDImageAttribute</span><span class="p">:</span>
 
+                <span class="c1"># this attribute is an image.</span>
 
+                <span class="c1"># replace the current image only the priority is lower</span>
 
+                <span class="c1"># (the infobox contain only one image).</span>
 
+                <span class="k">if</span> <span class="n">attribute</span><span class="o">.</span><span class="n">priority</span> <span class="o">&gt;</span> <span class="n">img_src_priority</span><span class="p">:</span>
 
+                    <span class="n">img_src</span> <span class="o">=</span> <span class="n">get_thumbnail</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
+                    <span class="n">img_src_priority</span> <span class="o">=</span> <span class="n">attribute</span><span class="o">.</span><span class="n">priority</span>
 
+            <span class="k">elif</span> <span class="n">attribute_type</span> <span class="o">==</span> <span class="n">WDGeoAttribute</span><span class="p">:</span>
 
+                <span class="c1"># geocoordinate link</span>
 
+                <span class="c1"># use the area to get the OSM zoom</span>
 
+                <span class="c1"># Note: ignore the unit (must be km² otherwise the calculation is wrong)</span>
 
+                <span class="c1"># Should use normalized value p:P2046/psn:P2046/wikibase:quantityAmount</span>
 
+                <span class="n">area</span> <span class="o">=</span> <span class="n">attribute_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;P2046&#39;</span><span class="p">)</span>
 
+                <span class="n">osm_zoom</span> <span class="o">=</span> <span class="n">area_to_osm_zoom</span><span class="p">(</span><span class="n">area</span><span class="p">)</span> <span class="k">if</span> <span class="n">area</span> <span class="k">else</span> <span class="mi">19</span>
 
+                <span class="n">url</span> <span class="o">=</span> <span class="n">attribute</span><span class="o">.</span><span class="n">get_geo_url</span><span class="p">(</span><span class="n">attribute_result</span><span class="p">,</span> <span class="n">osm_zoom</span><span class="o">=</span><span class="n">osm_zoom</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="n">url</span><span class="p">:</span>
 
+                    <span class="n">infobox_urls</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">attribute</span><span class="o">.</span><span class="n">get_label</span><span class="p">(</span><span class="n">language</span><span class="p">),</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;entity&#39;</span><span class="p">:</span> <span class="n">attribute</span><span class="o">.</span><span class="n">name</span><span class="p">})</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">infobox_attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                    <span class="p">{</span><span class="s1">&#39;label&#39;</span><span class="p">:</span> <span class="n">attribute</span><span class="o">.</span><span class="n">get_label</span><span class="p">(</span><span class="n">language</span><span class="p">),</span> <span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="n">value</span><span class="p">,</span> <span class="s1">&#39;entity&#39;</span><span class="p">:</span> <span class="n">attribute</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
 
+                <span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">infobox_id</span><span class="p">:</span>
 
+        <span class="n">infobox_id</span> <span class="o">=</span> <span class="n">replace_http_by_https</span><span class="p">(</span><span class="n">infobox_id</span><span class="p">)</span>
 
+
 
+    <span class="c1"># add the wikidata URL at the end</span>
 
+    <span class="n">infobox_urls</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="s1">&#39;Wikidata&#39;</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">attribute_result</span><span class="p">[</span><span class="s1">&#39;item&#39;</span><span class="p">]})</span>
 
+
 
+    <span class="k">if</span> <span class="p">(</span>
 
+        <span class="s2">&quot;list&quot;</span> <span class="ow">in</span> <span class="n">display_type</span>
 
+        <span class="ow">and</span> <span class="n">img_src</span> <span class="ow">is</span> <span class="kc">None</span>
 
+        <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">infobox_attributes</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span>
 
+        <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">infobox_urls</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
 
+        <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">infobox_content</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span>
 
+    <span class="p">):</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">infobox_urls</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s1">&#39;url&#39;</span><span class="p">],</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">infobox_title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">infobox_content</span><span class="p">})</span>
 
+    <span class="k">elif</span> <span class="s2">&quot;infobox&quot;</span> <span class="ow">in</span> <span class="n">display_type</span><span class="p">:</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;infobox&#39;</span><span class="p">:</span> <span class="n">infobox_title</span><span class="p">,</span>
 
+                <span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="n">infobox_id</span><span class="p">,</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">infobox_content</span><span class="p">,</span>
 
+                <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">img_src</span><span class="p">,</span>
 
+                <span class="s1">&#39;urls&#39;</span><span class="p">:</span> <span class="n">infobox_urls</span><span class="p">,</span>
 
+                <span class="s1">&#39;attributes&#39;</span><span class="p">:</span> <span class="n">infobox_attributes</span><span class="p">,</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_query</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+    <span class="n">attributes</span> <span class="o">=</span> <span class="n">get_attributes</span><span class="p">(</span><span class="n">language</span><span class="p">)</span>
 
+    <span class="n">select</span> <span class="o">=</span> <span class="p">[</span><span class="n">a</span><span class="o">.</span><span class="n">get_select</span><span class="p">()</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">attributes</span><span class="p">]</span>
 
+    <span class="n">where</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">,</span> <span class="p">[</span><span class="n">a</span><span class="o">.</span><span class="n">get_where</span><span class="p">()</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">attributes</span><span class="p">]))</span>
 
+    <span class="n">wikibase_label</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">,</span> <span class="p">[</span><span class="n">a</span><span class="o">.</span><span class="n">get_wikibase_label</span><span class="p">()</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">attributes</span><span class="p">]))</span>
 
+    <span class="n">group_by</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">,</span> <span class="p">[</span><span class="n">a</span><span class="o">.</span><span class="n">get_group_by</span><span class="p">()</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">attributes</span><span class="p">]))</span>
 
+    <span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="n">QUERY_TEMPLATE</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;%QUERY%&#39;</span><span class="p">,</span> <span class="n">sparql_string_escape</span><span class="p">(</span><span class="n">query</span><span class="p">))</span>
 
+        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;%SELECT%&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">select</span><span class="p">))</span>
 
+        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;%WHERE%&#39;</span><span class="p">,</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">  &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">where</span><span class="p">))</span>
 
+        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;%WIKIBASE_LABELS%&#39;</span><span class="p">,</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">      &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">wikibase_label</span><span class="p">))</span>
 
+        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">%G</span><span class="s1">ROUP_BY%&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">group_by</span><span class="p">))</span>
 
+        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;%LANGUAGE%&#39;</span><span class="p">,</span> <span class="n">language</span><span class="p">)</span>
 
+    <span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">query</span><span class="p">,</span> <span class="n">attributes</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_attributes</span><span class="p">(</span><span class="n">language</span><span class="p">):</span>
 
+    <span class="c1"># pylint: disable=too-many-statements</span>
 
+    <span class="n">attributes</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_value</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
 
+        <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_amount</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
 
+        <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDAmountAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_label</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
 
+        <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDLabelAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_url</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">url_path_prefix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 
+        <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDURLAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">url_id</span><span class="p">,</span> <span class="n">url_path_prefix</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">))</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_image</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 
+        <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDImageAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">url_id</span><span class="p">,</span> <span class="n">priority</span><span class="p">))</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">add_date</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
 
+        <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDDateAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
 
+
 
+    <span class="c1"># Dates</span>
 
+    <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="p">[</span>
 
+        <span class="s1">&#39;P571&#39;</span><span class="p">,</span>  <span class="c1"># inception date</span>
 
+        <span class="s1">&#39;P576&#39;</span><span class="p">,</span>  <span class="c1"># dissolution date</span>
 
+        <span class="s1">&#39;P580&#39;</span><span class="p">,</span>  <span class="c1"># start date</span>
 
+        <span class="s1">&#39;P582&#39;</span><span class="p">,</span>  <span class="c1"># end date</span>
 
+        <span class="s1">&#39;P569&#39;</span><span class="p">,</span>  <span class="c1"># date of birth</span>
 
+        <span class="s1">&#39;P570&#39;</span><span class="p">,</span>  <span class="c1"># date of death</span>
 
+        <span class="s1">&#39;P619&#39;</span><span class="p">,</span>  <span class="c1"># date of spacecraft launch</span>
 
+        <span class="s1">&#39;P620&#39;</span><span class="p">,</span>
 
+    <span class="p">]:</span>  <span class="c1"># date of spacecraft landing</span>
 
+        <span class="n">add_date</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="p">[</span>
 
+        <span class="s1">&#39;P27&#39;</span><span class="p">,</span>  <span class="c1"># country of citizenship</span>
 
+        <span class="s1">&#39;P495&#39;</span><span class="p">,</span>  <span class="c1"># country of origin</span>
 
+        <span class="s1">&#39;P17&#39;</span><span class="p">,</span>  <span class="c1"># country</span>
 
+        <span class="s1">&#39;P159&#39;</span><span class="p">,</span>
 
+    <span class="p">]:</span>  <span class="c1"># headquarters location</span>
 
+        <span class="n">add_label</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
 
+
 
+    <span class="c1"># Places</span>
 
+    <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="p">[</span>
 
+        <span class="s1">&#39;P36&#39;</span><span class="p">,</span>  <span class="c1"># capital</span>
 
+        <span class="s1">&#39;P35&#39;</span><span class="p">,</span>  <span class="c1"># head of state</span>
 
+        <span class="s1">&#39;P6&#39;</span><span class="p">,</span>  <span class="c1"># head of government</span>
 
+        <span class="s1">&#39;P122&#39;</span><span class="p">,</span>  <span class="c1"># basic form of government</span>
 
+        <span class="s1">&#39;P37&#39;</span><span class="p">,</span>
 
+    <span class="p">]:</span>  <span class="c1"># official language</span>
 
+        <span class="n">add_label</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
 
+
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P1082&#39;</span><span class="p">)</span>  <span class="c1"># population</span>
 
+    <span class="n">add_amount</span><span class="p">(</span><span class="s1">&#39;P2046&#39;</span><span class="p">)</span>  <span class="c1"># area</span>
 
+    <span class="n">add_amount</span><span class="p">(</span><span class="s1">&#39;P281&#39;</span><span class="p">)</span>  <span class="c1"># postal code</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P38&#39;</span><span class="p">)</span>  <span class="c1"># currency</span>
 
+    <span class="n">add_amount</span><span class="p">(</span><span class="s1">&#39;P2048&#39;</span><span class="p">)</span>  <span class="c1"># height (building)</span>
 
+
 
+    <span class="c1"># Media</span>
 
+    <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="p">[</span>
 
+        <span class="s1">&#39;P400&#39;</span><span class="p">,</span>  <span class="c1"># platform (videogames, computing)</span>
 
+        <span class="s1">&#39;P50&#39;</span><span class="p">,</span>  <span class="c1"># author</span>
 
+        <span class="s1">&#39;P170&#39;</span><span class="p">,</span>  <span class="c1"># creator</span>
 
+        <span class="s1">&#39;P57&#39;</span><span class="p">,</span>  <span class="c1"># director</span>
 
+        <span class="s1">&#39;P175&#39;</span><span class="p">,</span>  <span class="c1"># performer</span>
 
+        <span class="s1">&#39;P178&#39;</span><span class="p">,</span>  <span class="c1"># developer</span>
 
+        <span class="s1">&#39;P162&#39;</span><span class="p">,</span>  <span class="c1"># producer</span>
 
+        <span class="s1">&#39;P176&#39;</span><span class="p">,</span>  <span class="c1"># manufacturer</span>
 
+        <span class="s1">&#39;P58&#39;</span><span class="p">,</span>  <span class="c1"># screenwriter</span>
 
+        <span class="s1">&#39;P272&#39;</span><span class="p">,</span>  <span class="c1"># production company</span>
 
+        <span class="s1">&#39;P264&#39;</span><span class="p">,</span>  <span class="c1"># record label</span>
 
+        <span class="s1">&#39;P123&#39;</span><span class="p">,</span>  <span class="c1"># publisher</span>
 
+        <span class="s1">&#39;P449&#39;</span><span class="p">,</span>  <span class="c1"># original network</span>
 
+        <span class="s1">&#39;P750&#39;</span><span class="p">,</span>  <span class="c1"># distributed by</span>
 
+        <span class="s1">&#39;P86&#39;</span><span class="p">,</span>
 
+    <span class="p">]:</span>  <span class="c1"># composer</span>
 
+        <span class="n">add_label</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
 
+
 
+    <span class="n">add_date</span><span class="p">(</span><span class="s1">&#39;P577&#39;</span><span class="p">)</span>  <span class="c1"># publication date</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P136&#39;</span><span class="p">)</span>  <span class="c1"># genre (music, film, artistic...)</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P364&#39;</span><span class="p">)</span>  <span class="c1"># original language</span>
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P212&#39;</span><span class="p">)</span>  <span class="c1"># ISBN-13</span>
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P957&#39;</span><span class="p">)</span>  <span class="c1"># ISBN-10</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P275&#39;</span><span class="p">)</span>  <span class="c1"># copyright license</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P277&#39;</span><span class="p">)</span>  <span class="c1"># programming language</span>
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P348&#39;</span><span class="p">)</span>  <span class="c1"># version</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P840&#39;</span><span class="p">)</span>  <span class="c1"># narrative location</span>
 
+
 
+    <span class="c1"># Languages</span>
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P1098&#39;</span><span class="p">)</span>  <span class="c1"># number of speakers</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P282&#39;</span><span class="p">)</span>  <span class="c1"># writing system</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P1018&#39;</span><span class="p">)</span>  <span class="c1"># language regulatory body</span>
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P218&#39;</span><span class="p">)</span>  <span class="c1"># language code (ISO 639-1)</span>
 
+
 
+    <span class="c1"># Other</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P169&#39;</span><span class="p">)</span>  <span class="c1"># ceo</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P112&#39;</span><span class="p">)</span>  <span class="c1"># founded by</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P1454&#39;</span><span class="p">)</span>  <span class="c1"># legal form (company, organization)</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P137&#39;</span><span class="p">)</span>  <span class="c1"># operator (service, facility, ...)</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P1029&#39;</span><span class="p">)</span>  <span class="c1"># crew members (tripulation)</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P225&#39;</span><span class="p">)</span>  <span class="c1"># taxon name</span>
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P274&#39;</span><span class="p">)</span>  <span class="c1"># chemical formula</span>
 
+    <span class="n">add_label</span><span class="p">(</span><span class="s1">&#39;P1346&#39;</span><span class="p">)</span>  <span class="c1"># winner (sports, contests, ...)</span>
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P1120&#39;</span><span class="p">)</span>  <span class="c1"># number of deaths</span>
 
+    <span class="n">add_value</span><span class="p">(</span><span class="s1">&#39;P498&#39;</span><span class="p">)</span>  <span class="c1"># currency code (ISO 4217)</span>
 
+
 
+    <span class="c1"># URL</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P856&#39;</span><span class="p">,</span> <span class="n">official</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>  <span class="c1"># official website</span>
 
+    <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDArticle</span><span class="p">(</span><span class="n">language</span><span class="p">))</span>  <span class="c1"># wikipedia (user language)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">language</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;en&#39;</span><span class="p">):</span>
 
+        <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDArticle</span><span class="p">(</span><span class="s1">&#39;en&#39;</span><span class="p">))</span>  <span class="c1"># wikipedia (english)</span>
 
+
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P1324&#39;</span><span class="p">)</span>  <span class="c1"># source code repository</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P1581&#39;</span><span class="p">)</span>  <span class="c1"># blog</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P434&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;musicbrainz_artist&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P435&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;musicbrainz_work&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P436&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;musicbrainz_release_group&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P966&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;musicbrainz_label&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P345&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;imdb_id&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P2397&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;youtube_channel&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P1651&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;youtube_video&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P2002&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;twitter_profile&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P2013&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;facebook_profile&#39;</span><span class="p">)</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P2003&#39;</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;instagram_profile&#39;</span><span class="p">)</span>
 
+
 
+    <span class="c1"># Fediverse</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P4033&#39;</span><span class="p">,</span> <span class="n">url_path_prefix</span><span class="o">=</span><span class="s1">&#39;/@&#39;</span><span class="p">)</span>  <span class="c1"># Mastodon user</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P11947&#39;</span><span class="p">,</span> <span class="n">url_path_prefix</span><span class="o">=</span><span class="s1">&#39;/c/&#39;</span><span class="p">)</span>  <span class="c1"># Lemmy community</span>
 
+    <span class="n">add_url</span><span class="p">(</span><span class="s1">&#39;P12622&#39;</span><span class="p">,</span> <span class="n">url_path_prefix</span><span class="o">=</span><span class="s1">&#39;/c/&#39;</span><span class="p">)</span>  <span class="c1"># PeerTube channel</span>
 
+
 
+    <span class="c1"># Map</span>
 
+    <span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">WDGeoAttribute</span><span class="p">(</span><span class="s1">&#39;P625&#39;</span><span class="p">))</span>
 
+
 
+    <span class="c1"># Image</span>
 
+    <span class="n">add_image</span><span class="p">(</span><span class="s1">&#39;P15&#39;</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;wikimedia_image&#39;</span><span class="p">)</span>  <span class="c1"># route map</span>
 
+    <span class="n">add_image</span><span class="p">(</span><span class="s1">&#39;P242&#39;</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;wikimedia_image&#39;</span><span class="p">)</span>  <span class="c1"># locator map</span>
 
+    <span class="n">add_image</span><span class="p">(</span><span class="s1">&#39;P154&#39;</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;wikimedia_image&#39;</span><span class="p">)</span>  <span class="c1"># logo</span>
 
+    <span class="n">add_image</span><span class="p">(</span><span class="s1">&#39;P18&#39;</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;wikimedia_image&#39;</span><span class="p">)</span>  <span class="c1"># image</span>
 
+    <span class="n">add_image</span><span class="p">(</span><span class="s1">&#39;P41&#39;</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;wikimedia_image&#39;</span><span class="p">)</span>  <span class="c1"># flag</span>
 
+    <span class="n">add_image</span><span class="p">(</span><span class="s1">&#39;P2716&#39;</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;wikimedia_image&#39;</span><span class="p">)</span>  <span class="c1"># collage</span>
 
+    <span class="n">add_image</span><span class="p">(</span><span class="s1">&#39;P2910&#39;</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">7</span><span class="p">,</span> <span class="n">url_id</span><span class="o">=</span><span class="s1">&#39;wikimedia_image&#39;</span><span class="p">)</span>  <span class="c1"># icon</span>
 
+
 
+    <span class="k">return</span> <span class="n">attributes</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">WDAttribute</span><span class="p">:</span>
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">,)</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="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_select</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s1">&#39;(group_concat(distinct ?</span><span class="si">{name}</span><span class="s1">;separator=&quot;, &quot;) as ?</span><span class="si">{name}</span><span class="s1">s)&#39;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_label</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">get_label_for_entity</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="n">language</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_where</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;OPTIONAL { ?item wdt:</span><span class="si">{name}</span><span class="s2"> ?</span><span class="si">{name}</span><span class="s2"> . }&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_wikibase_label</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_group_by</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+        <span class="k">return</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s1">&#39;s&#39;</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="s1">&#39;&lt;&#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39;:&#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s1">&#39;&gt;&#39;</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">WDAmountAttribute</span><span class="p">(</span><span class="n">WDAttribute</span><span class="p">):</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_select</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s1">&#39;?</span><span class="si">{name}</span><span class="s1"> ?</span><span class="si">{name}</span><span class="s1">Unit&#39;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_where</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;&quot;  OPTIONAL { ?item p:</span><span class="si">{name}</span><span class="s2"> ?</span><span class="si">{name}</span><span class="s2">Node .</span>
 
+<span class="s2">    ?</span><span class="si">{name}</span><span class="s2">Node rdf:type wikibase:BestRank ; ps:</span><span class="si">{name}</span><span class="s2"> ?</span><span class="si">{name}</span><span class="s2"> .</span>
 
+<span class="s2">    OPTIONAL { ?</span><span class="si">{name}</span><span class="s2">Node psv:</span><span class="si">{name}</span><span class="s2">/wikibase:quantityUnit ?</span><span class="si">{name}</span><span class="s2">Unit. } }&quot;&quot;&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
 
+            <span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_group_by</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">get_select</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">result</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">name</span><span class="p">)</span>
 
+        <span class="n">unit</span> <span class="o">=</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s2">&quot;Unit&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">unit</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">unit</span> <span class="o">=</span> <span class="n">unit</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;http://www.wikidata.org/entity/&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="n">value</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="n">get_label_for_entity</span><span class="p">(</span><span class="n">unit</span><span class="p">,</span> <span class="n">language</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">value</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">WDArticle</span><span class="p">(</span><span class="n">WDAttribute</span><span class="p">):</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">&#39;language&#39;</span><span class="p">,</span> <span class="s1">&#39;kwargs&#39;</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">language</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="s1">&#39;wikipedia&#39;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">language</span> <span class="o">=</span> <span class="n">language</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span> <span class="o">=</span> <span class="n">kwargs</span> <span class="ow">or</span> <span class="p">{}</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_label</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="c1"># language parameter is ignored</span>
 
+        <span class="k">return</span> <span class="s2">&quot;Wikipedia (</span><span class="si">{language}</span><span class="s2">)&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{language}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">language</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_select</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;?article</span><span class="si">{language}</span><span class="s2"> ?articleName</span><span class="si">{language}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{language}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">language</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_where</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;&quot;OPTIONAL { ?article</span><span class="si">{language}</span><span class="s2"> schema:about ?item ;</span>
 
+<span class="s2">             schema:inLanguage &quot;</span><span class="si">{language}</span><span class="s2">&quot; ;</span>
 
+<span class="s2">             schema:isPartOf &lt;https://</span><span class="si">{language}</span><span class="s2">.wikipedia.org/&gt; ;</span>
 
+<span class="s2">             schema:name ?articleName</span><span class="si">{language}</span><span class="s2"> . }&quot;&quot;&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
 
+            <span class="s1">&#39;</span><span class="si">{language}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">language</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_group_by</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">get_select</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="n">key</span> <span class="o">=</span> <span class="s1">&#39;article</span><span class="si">{language}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{language}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">language</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">WDLabelAttribute</span><span class="p">(</span><span class="n">WDAttribute</span><span class="p">):</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_select</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s1">&#39;(group_concat(distinct ?</span><span class="si">{name}</span><span class="s1">Label;separator=&quot;, &quot;) as ?</span><span class="si">{name}</span><span class="s1">Labels)&#39;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_where</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;OPTIONAL { ?item wdt:</span><span class="si">{name}</span><span class="s2"> ?</span><span class="si">{name}</span><span class="s2"> . }&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_wikibase_label</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;?</span><span class="si">{name}</span><span class="s2"> rdfs:label ?</span><span class="si">{name}</span><span class="s2">Label .&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s1">&#39;Labels&#39;</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">WDURLAttribute</span><span class="p">(</span><span class="n">WDAttribute</span><span class="p">):</span>
 
+
 
+    <span class="n">HTTP_WIKIMEDIA_IMAGE</span> <span class="o">=</span> <span class="s1">&#39;http://commons.wikimedia.org/wiki/Special:FilePath/&#39;</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">&#39;url_id&#39;</span><span class="p">,</span> <span class="s1">&#39;url_path_prefix&#39;</span><span class="p">,</span> <span class="s1">&#39;kwargs&#39;</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="n">url_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">url_path_prefix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">        :param url_id: ID matching one key in ``external_urls.json`` for</span>
 
+<span class="sd">            converting IDs to full URLs.</span>
 
+
 
+<span class="sd">        :param url_path_prefix: Path prefix if the values are of format</span>
 
+<span class="sd">            ``account@domain``.  If provided, value are rewritten to</span>
 
+<span class="sd">            ``https://&lt;domain&gt;&lt;url_path_prefix&gt;&lt;account&gt;``.  For example::</span>
 
+
 
+<span class="sd">              WDURLAttribute(&#39;P4033&#39;, url_path_prefix=&#39;/@&#39;)</span>
 
+
 
+<span class="sd">            Adds Property `P4033 &lt;https://www.wikidata.org/wiki/Property:P4033&gt;`_</span>
 
+<span class="sd">            to the wikidata query.  This field might return for example</span>
 
+<span class="sd">            ``libreoffice@fosstodon.org`` and the URL built from this is then:</span>
 
+
 
+<span class="sd">            - account: ``libreoffice``</span>
 
+<span class="sd">            - domain: ``fosstodon.org``</span>
 
+<span class="sd">            - result url: https://fosstodon.org/@libreoffice</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">url_id</span> <span class="o">=</span> <span class="n">url_id</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">url_path_prefix</span> <span class="o">=</span> <span class="n">url_path_prefix</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span> <span class="o">=</span> <span class="n">kwargs</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s1">&#39;s&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="kc">None</span>
 
+
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_id</span><span class="p">:</span>
 
+            <span class="n">url_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_id</span>
 
+            <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">WDURLAttribute</span><span class="o">.</span><span class="n">HTTP_WIKIMEDIA_IMAGE</span><span class="p">):</span>
 
+                <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">WDURLAttribute</span><span class="o">.</span><span class="n">HTTP_WIKIMEDIA_IMAGE</span><span class="p">)</span> <span class="p">:]</span>
 
+                <span class="n">url_id</span> <span class="o">=</span> <span class="s1">&#39;wikimedia_image&#39;</span>
 
+            <span class="k">return</span> <span class="n">get_external_url</span><span class="p">(</span><span class="n">url_id</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_path_prefix</span><span class="p">:</span>
 
+            <span class="p">[</span><span class="n">account</span><span class="p">,</span> <span class="n">domain</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">&quot;@ &quot;</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">&#39;@&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)]</span>
 
+            <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;https://</span><span class="si">{</span><span class="n">domain</span><span class="si">}{</span><span class="bp">self</span><span class="o">.</span><span class="n">url_path_prefix</span><span class="si">}{</span><span class="n">account</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+        <span class="k">return</span> <span class="n">value</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">WDGeoAttribute</span><span class="p">(</span><span class="n">WDAttribute</span><span class="p">):</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_label</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;OpenStreetMap&quot;</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_select</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;?</span><span class="si">{name}</span><span class="s2">Lat ?</span><span class="si">{name}</span><span class="s2">Long&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_where</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;&quot;OPTIONAL { ?item p:</span><span class="si">{name}</span><span class="s2">/psv:</span><span class="si">{name}</span><span class="s2"> [</span>
 
+<span class="s2">    wikibase:geoLatitude ?</span><span class="si">{name}</span><span class="s2">Lat ;</span>
 
+<span class="s2">    wikibase:geoLongitude ?</span><span class="si">{name}</span><span class="s2">Long ] }&quot;&quot;&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
 
+            <span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_group_by</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">get_select</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="n">latitude</span> <span class="o">=</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s1">&#39;Lat&#39;</span><span class="p">)</span>
 
+        <span class="n">longitude</span> <span class="o">=</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s1">&#39;Long&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">latitude</span> <span class="ow">and</span> <span class="n">longitude</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">latitude</span> <span class="o">+</span> <span class="s1">&#39; &#39;</span> <span class="o">+</span> <span class="n">longitude</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_geo_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">osm_zoom</span><span class="o">=</span><span class="mi">19</span><span class="p">):</span>
 
+        <span class="n">latitude</span> <span class="o">=</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s1">&#39;Lat&#39;</span><span class="p">)</span>
 
+        <span class="n">longitude</span> <span class="o">=</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s1">&#39;Long&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">latitude</span> <span class="ow">and</span> <span class="n">longitude</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">get_earth_coordinates_url</span><span class="p">(</span><span class="n">latitude</span><span class="p">,</span> <span class="n">longitude</span><span class="p">,</span> <span class="n">osm_zoom</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">WDImageAttribute</span><span class="p">(</span><span class="n">WDURLAttribute</span><span class="p">):</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;priority&#39;</span><span class="p">,)</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="n">url_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="mi">100</span><span class="p">):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">url_id</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">priority</span> <span class="o">=</span> <span class="n">priority</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">WDDateAttribute</span><span class="p">(</span><span class="n">WDAttribute</span><span class="p">):</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_select</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s1">&#39;?</span><span class="si">{name}</span><span class="s1"> ?</span><span class="si">{name}</span><span class="s1">timePrecision ?</span><span class="si">{name}</span><span class="s1">timeZone ?</span><span class="si">{name}</span><span class="s1">timeCalendar&#39;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_where</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="c1"># To remove duplicate, add</span>
 
+        <span class="c1"># FILTER NOT EXISTS { ?item p:{name}/psv:{name}/wikibase:timeValue ?{name}bis FILTER (?{name}bis &lt; ?{name}) }</span>
 
+        <span class="c1"># this filter is too slow, so the response function ignore duplicate results</span>
 
+        <span class="c1"># (see the seen_entities variable)</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;&quot;OPTIONAL { ?item p:</span><span class="si">{name}</span><span class="s2">/psv:</span><span class="si">{name}</span><span class="s2"> [</span>
 
+<span class="s2">    wikibase:timeValue ?</span><span class="si">{name}</span><span class="s2"> ;</span>
 
+<span class="s2">    wikibase:timePrecision ?</span><span class="si">{name}</span><span class="s2">timePrecision ;</span>
 
+<span class="s2">    wikibase:timeTimezone ?</span><span class="si">{name}</span><span class="s2">timeZone ;</span>
 
+<span class="s2">    wikibase:timeCalendarModel ?</span><span class="si">{name}</span><span class="s2">timeCalendar ] . }</span>
 
+<span class="s2">    hint:Prior hint:rangeSafe true;&quot;&quot;&quot;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
 
+            <span class="s1">&#39;</span><span class="si">{name}</span><span class="s1">&#39;</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="k">def</span><span class="w"> </span><span class="nf">get_group_by</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">get_select</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">format_8</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="p">):</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+        <span class="c1"># precision: less than a year</span>
 
+        <span class="k">return</span> <span class="n">value</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">format_9</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="p">):</span>
 
+        <span class="n">year</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
+        <span class="c1"># precision: year</span>
 
+        <span class="k">if</span> <span class="n">year</span> <span class="o">&lt;</span> <span class="mi">1584</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">year</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
 
+                <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">year</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">year</span><span class="p">)</span>
 
+        <span class="n">timestamp</span> <span class="o">=</span> <span class="n">isoparse</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">format_date</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">&#39;yyyy&#39;</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">locale</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">format_10</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="p">):</span>
 
+        <span class="c1"># precision: month</span>
 
+        <span class="n">timestamp</span> <span class="o">=</span> <span class="n">isoparse</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">format_date</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">&#39;MMMM y&#39;</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">locale</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">format_11</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="p">):</span>
 
+        <span class="c1"># precision: day</span>
 
+        <span class="n">timestamp</span> <span class="o">=</span> <span class="n">isoparse</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">format_date</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">&#39;full&#39;</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">locale</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">format_13</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="p">):</span>
 
+        <span class="n">timestamp</span> <span class="o">=</span> <span class="n">isoparse</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
+        <span class="c1"># precision: minute</span>
 
+        <span class="k">return</span> <span class="p">(</span>
 
+            <span class="n">get_datetime_format</span><span class="p">(</span><span class="nb">format</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">locale</span><span class="p">)</span>
 
+            <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;&#39;&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+            <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{0}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">format_time</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="s1">&#39;full&#39;</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">locale</span><span class="p">))</span>
 
+            <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="si">{1}</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">format_date</span><span class="p">(</span><span class="n">timestamp</span><span class="p">,</span> <span class="s1">&#39;short&#39;</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">locale</span><span class="p">))</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">format_14</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="p">):</span>
 
+        <span class="c1"># precision: second.</span>
 
+        <span class="k">return</span> <span class="n">format_datetime</span><span class="p">(</span><span class="n">isoparse</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="nb">format</span><span class="o">=</span><span class="s1">&#39;full&#39;</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">locale</span><span class="p">)</span>
 
+
 
+    <span class="n">DATE_FORMAT</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;0&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">1000000000</span><span class="p">),</span>
 
+        <span class="s1">&#39;1&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">100000000</span><span class="p">),</span>
 
+        <span class="s1">&#39;2&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">10000000</span><span class="p">),</span>
 
+        <span class="s1">&#39;3&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">1000000</span><span class="p">),</span>
 
+        <span class="s1">&#39;4&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">100000</span><span class="p">),</span>
 
+        <span class="s1">&#39;5&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">10000</span><span class="p">),</span>
 
+        <span class="s1">&#39;6&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">1000</span><span class="p">),</span>
 
+        <span class="s1">&#39;7&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">100</span><span class="p">),</span>
 
+        <span class="s1">&#39;8&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_8&#39;</span><span class="p">,</span> <span class="mi">10</span><span class="p">),</span>
 
+        <span class="s1">&#39;9&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_9&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>  <span class="c1"># year</span>
 
+        <span class="s1">&#39;10&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_10&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>  <span class="c1"># month</span>
 
+        <span class="s1">&#39;11&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_11&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>  <span class="c1"># day</span>
 
+        <span class="s1">&#39;12&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_13&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>  <span class="c1"># hour (not supported by babel, display minute)</span>
 
+        <span class="s1">&#39;13&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_13&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>  <span class="c1"># minute</span>
 
+        <span class="s1">&#39;14&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;format_14&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>  <span class="c1"># second</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">result</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">name</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span> <span class="ow">or</span> <span class="n">value</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">precision</span> <span class="o">=</span> <span class="n">result</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">name</span> <span class="o">+</span> <span class="s1">&#39;timePrecision&#39;</span><span class="p">)</span>
 
+        <span class="n">date_format</span> <span class="o">=</span> <span class="n">WDDateAttribute</span><span class="o">.</span><span class="n">DATE_FORMAT</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">precision</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">date_format</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">format_method</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">date_format</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
 
+            <span class="n">precision</span> <span class="o">=</span> <span class="n">date_format</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="k">if</span> <span class="n">precision</span> <span class="o">&gt;=</span> <span class="mi">1</span><span class="p">:</span>
 
+                    <span class="n">t</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+                    <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">):</span>
 
+                        <span class="n">value</span> <span class="o">=</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">t</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+                    <span class="k">else</span><span class="p">:</span>
 
+                        <span class="n">value</span> <span class="o">=</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+                <span class="k">return</span> <span class="n">format_method</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">language</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="k">return</span> <span class="n">value</span>
 
+        <span class="k">return</span> <span class="n">value</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">debug_explain_wikidata_query</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;GET&#39;</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="n">method</span> <span class="o">==</span> <span class="s1">&#39;GET&#39;</span><span class="p">:</span>
 
+        <span class="n">http_response</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">SPARQL_EXPLAIN_URL</span> <span class="o">+</span> <span class="s1">&#39;&amp;&#39;</span> <span class="o">+</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span> <span class="n">headers</span><span class="o">=</span><span class="n">get_headers</span><span class="p">())</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">http_response</span> <span class="o">=</span> <span class="n">post</span><span class="p">(</span><span class="n">SPARQL_EXPLAIN_URL</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">},</span> <span class="n">headers</span><span class="o">=</span><span class="n">get_headers</span><span class="p">())</span>
 
+    <span class="n">http_response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
 
+    <span class="k">return</span> <span class="n">http_response</span><span class="o">.</span><span class="n">content</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+    <span class="c1"># WIKIDATA_PROPERTIES : add unit symbols</span>
 
+    <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">WIKIDATA_UNITS</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="n">WIKIDATA_PROPERTIES</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">]</span>
 
+
 
+    <span class="c1"># WIKIDATA_PROPERTIES : add property labels</span>
 
+    <span class="n">wikidata_property_names</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">attribute</span> <span class="ow">in</span> <span class="n">get_attributes</span><span class="p">(</span><span class="s1">&#39;en&#39;</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">attribute</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="n">WDAttribute</span><span class="p">,</span> <span class="n">WDAmountAttribute</span><span class="p">,</span> <span class="n">WDURLAttribute</span><span class="p">,</span> <span class="n">WDDateAttribute</span><span class="p">,</span> <span class="n">WDLabelAttribute</span><span class="p">):</span>
 
+            <span class="k">if</span> <span class="n">attribute</span><span class="o">.</span><span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">WIKIDATA_PROPERTIES</span><span class="p">:</span>
 
+                <span class="n">wikidata_property_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;wd:&quot;</span> <span class="o">+</span> <span class="n">attribute</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
 
+    <span class="n">query</span> <span class="o">=</span> <span class="n">QUERY_PROPERTY_NAMES</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;%ATTRIBUTES%&#39;</span><span class="p">,</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">wikidata_property_names</span><span class="p">))</span>
 
+    <span class="n">jsonresponse</span> <span class="o">=</span> <span class="n">send_wikidata_query</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">20</span><span class="p">)</span>
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">jsonresponse</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;results&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;bindings&#39;</span><span class="p">,</span> <span class="p">{}):</span>
 
+        <span class="n">name</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">][</span><span class="s1">&#39;value&#39;</span><span class="p">]</span>
 
+        <span class="n">lang</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">][</span><span class="s1">&#39;xml:lang&#39;</span><span class="p">]</span>
 
+        <span class="n">entity_id</span> <span class="o">=</span> <span class="n">result</span><span class="p">[</span><span class="s1">&#39;item&#39;</span><span class="p">][</span><span class="s1">&#39;value&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;http://www.wikidata.org/entity/&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+        <span class="n">WIKIDATA_PROPERTIES</span><span class="p">[(</span><span class="n">entity_id</span><span class="p">,</span> <span class="n">lang</span><span class="p">)]</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">capitalize</span><span class="p">()</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/wikipedia.html#searx.engines.wikidata.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Uses languages evaluated from :py:obj:`wikipedia.fetch_wikimedia_traits</span>
 
+<span class="sd">    &lt;searx.engines.wikipedia.fetch_wikimedia_traits&gt;` and removes</span>
 
+
 
+<span class="sd">    - ``traits.custom[&#39;wiki_netloc&#39;]``: wikidata does not have net-locations for</span>
 
+<span class="sd">      the languages and the list of all</span>
 
+
 
+<span class="sd">    - ``traits.custom[&#39;WIKIPEDIA_LANGUAGES&#39;]``: not used in the wikipedia engine</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">fetch_wikimedia_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">)</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]</span> <span class="o">=</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 443 - 0
_modules/searx/engines/wikipedia.html
View File 

@@ -0,0 +1,443 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.wikipedia &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.wikipedia</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.wikipedia</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This module implements the Wikipedia engine.  Some of this implementations</span>
 
+<span class="sd">are shared by other engines:</span>
 
+
 
+<span class="sd">- :ref:`wikidata engine`</span>
 
+
 
+<span class="sd">The list of supported languages is :py:obj:`fetched &lt;fetch_wikimedia_traits&gt;` from</span>
 
+<span class="sd">the article linked by :py:obj:`list_of_wikipedias`.</span>
 
+
 
+<span class="sd">Unlike traditional search engines, wikipedia does not support one Wikipedia for</span>
 
+<span class="sd">all languages, but there is one Wikipedia for each supported language. Some of</span>
 
+<span class="sd">these Wikipedias have a LanguageConverter_ enabled</span>
 
+<span class="sd">(:py:obj:`rest_v1_summary_url`).</span>
 
+
 
+<span class="sd">A LanguageConverter_ (LC) is a system based on language variants that</span>
 
+<span class="sd">automatically converts the content of a page into a different variant. A variant</span>
 
+<span class="sd">is mostly the same language in a different script.</span>
 
+
 
+<span class="sd">- `Wikipedias in multiple writing systems`_</span>
 
+<span class="sd">- `Automatic conversion between traditional and simplified Chinese characters`_</span>
 
+
 
+<span class="sd">PR-2554_:</span>
 
+<span class="sd">  The Wikipedia link returned by the API is still the same in all cases</span>
 
+<span class="sd">  (`https://zh.wikipedia.org/wiki/出租車`_) but if your browser&#39;s</span>
 
+<span class="sd">  ``Accept-Language`` is set to any of ``zh``, ``zh-CN``, ``zh-TW``, ``zh-HK``</span>
 
+<span class="sd">  or .. Wikipedia&#39;s LC automatically returns the desired script in their</span>
 
+<span class="sd">  web-page.</span>
 
+
 
+<span class="sd">  - You can test the API here: https://reqbin.com/gesg2kvx</span>
 
+
 
+<span class="sd">.. _https://zh.wikipedia.org/wiki/出租車:</span>
 
+<span class="sd">   https://zh.wikipedia.org/wiki/%E5%87%BA%E7%A7%9F%E8%BB%8A</span>
 
+
 
+<span class="sd">To support Wikipedia&#39;s LanguageConverter_, a SearXNG request to Wikipedia uses</span>
 
+<span class="sd">:py:obj:`get_wiki_params` and :py:obj:`wiki_lc_locale_variants&#39; in the</span>
 
+<span class="sd">:py:obj:`fetch_wikimedia_traits` function.</span>
 
+
 
+<span class="sd">To test in SearXNG, query for ``!wp 出租車`` with each of the available Chinese</span>
 
+<span class="sd">options:</span>
 
+
 
+<span class="sd">- ``!wp 出租車 :zh``    should show 出租車</span>
 
+<span class="sd">- ``!wp 出租車 :zh-CN`` should show 出租车</span>
 
+<span class="sd">- ``!wp 出租車 :zh-TW`` should show 計程車</span>
 
+<span class="sd">- ``!wp 出租車 :zh-HK`` should show 的士</span>
 
+<span class="sd">- ``!wp 出租車 :zh-SG`` should show 德士</span>
 
+
 
+<span class="sd">.. _LanguageConverter:</span>
 
+<span class="sd">   https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter</span>
 
+<span class="sd">.. _Wikipedias in multiple writing systems:</span>
 
+<span class="sd">   https://meta.wikimedia.org/wiki/Wikipedias_in_multiple_writing_systems</span>
 
+<span class="sd">.. _Automatic conversion between traditional and simplified Chinese characters:</span>
 
+<span class="sd">   https://en.wikipedia.org/wiki/Chinese_Wikipedia#Automatic_conversion_between_traditional_and_simplified_Chinese_characters</span>
 
+<span class="sd">.. _PR-2554: https://github.com/searx/searx/pull/2554</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">urllib.parse</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">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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">utils</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">network</span> <span class="k">as</span> <span class="n">_network</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">locales</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.wikipedia.org/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q52&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://en.wikipedia.org/api/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">display_type</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;infobox&quot;</span><span class="p">]</span>
 
+<span class="sd">&quot;&quot;&quot;A list of display types composed from ``infobox`` and ``list``.  The latter</span>
 
+<span class="sd">one will add a hit to the result list.  The first one will show a hit in the</span>
 
+<span class="sd">info box.  Both values can be set, or one of the two can be set.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="sd">&quot;&quot;&quot;The HTTP ``Accept-Language`` header is needed for wikis where</span>
 
+<span class="sd">LanguageConverter_ is enabled.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">list_of_wikipedias</span> <span class="o">=</span> <span class="s1">&#39;https://meta.wikimedia.org/wiki/List_of_Wikipedias&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;`List of all wikipedias &lt;https://meta.wikimedia.org/wiki/List_of_Wikipedias&gt;`_</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">wikipedia_article_depth</span> <span class="o">=</span> <span class="s1">&#39;https://meta.wikimedia.org/wiki/Wikipedia_article_depth&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;The *editing depth* of Wikipedia is one of several possible rough indicators</span>
 
+<span class="sd">of the encyclopedia&#39;s collaborative quality, showing how frequently its articles</span>
 
+<span class="sd">are updated.  The measurement of depth was introduced after some limitations of</span>
 
+<span class="sd">the classic measurement of article count were realized.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">rest_v1_summary_url</span> <span class="o">=</span> <span class="s1">&#39;https://</span><span class="si">{wiki_netloc}</span><span class="s1">/api/rest_v1/page/summary/</span><span class="si">{title}</span><span class="s1">&#39;</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">`wikipedia rest_v1 summary API`_:</span>
 
+<span class="sd">  The summary response includes an extract of the first paragraph of the page in</span>
 
+<span class="sd">  plain text and HTML as well as the type of page. This is useful for page</span>
 
+<span class="sd">  previews (fka. Hovercards, aka. Popups) on the web and link previews in the</span>
 
+<span class="sd">  apps.</span>
 
+
 
+<span class="sd">HTTP ``Accept-Language`` header (:py:obj:`send_accept_language_header`):</span>
 
+<span class="sd">  The desired language variant code for wikis where LanguageConverter_ is</span>
 
+<span class="sd">  enabled.</span>
 
+
 
+<span class="sd">.. _wikipedia rest_v1 summary API:</span>
 
+<span class="sd">   https://en.wikipedia.org/api/rest_v1/#/Page%20content/get_page_summary__title_</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">wiki_lc_locale_variants</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;zh&quot;</span><span class="p">:</span> <span class="p">(</span>
 
+        <span class="s2">&quot;zh-CN&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;zh-HK&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;zh-MO&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;zh-MY&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;zh-SG&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;zh-TW&quot;</span><span class="p">,</span>
 
+    <span class="p">),</span>
 
+    <span class="s2">&quot;zh-classical&quot;</span><span class="p">:</span> <span class="p">(</span><span class="s2">&quot;zh-classical&quot;</span><span class="p">,),</span>
 
+<span class="p">}</span>
 
+<span class="sd">&quot;&quot;&quot;Mapping rule of the LanguageConverter_ to map a language and its variants to</span>
 
+<span class="sd">a Locale (used in the HTTP ``Accept-Language`` header). For example see `LC</span>
 
+<span class="sd">Chinese`_.</span>
 
+
 
+<span class="sd">.. _LC Chinese:</span>
 
+<span class="sd">   https://meta.wikimedia.org/wiki/Wikipedias_in_multiple_writing_systems#Chinese</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">wikipedia_script_variants</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;zh&quot;</span><span class="p">:</span> <span class="p">(</span>
 
+        <span class="s2">&quot;zh_Hant&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;zh_Hans&quot;</span><span class="p">,</span>
 
+    <span class="p">)</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_wiki_params">
 
+<a class="viewcode-back" href="../../../dev/engines/online/wikipedia.html#searx.engines.wikipedia.get_wiki_params">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_wiki_params</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">eng_traits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns the Wikipedia language tag and the netloc that fits to the</span>
 
+<span class="sd">    ``sxng_locale``.  To support LanguageConverter_ this function rates a locale</span>
 
+<span class="sd">    (region) higher than a language (compare :py:obj:`wiki_lc_locale_variants`).</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="s1">&#39;en&#39;</span><span class="p">))</span>
 
+    <span class="n">wiki_netloc</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">,</span> <span class="s1">&#39;en.wikipedia.org&#39;</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">wiki_netloc</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/wikipedia.html#searx.engines.wikipedia.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Assemble a request (`wikipedia rest_v1 summary API`_).&quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="n">query</span><span class="o">.</span><span class="n">islower</span><span class="p">():</span>
 
+        <span class="n">query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">title</span><span class="p">()</span>
 
+
 
+    <span class="n">_eng_tag</span><span class="p">,</span> <span class="n">wiki_netloc</span> <span class="o">=</span> <span class="n">get_wiki_params</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="p">)</span>
 
+    <span class="n">title</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">quote</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="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">rest_v1_summary_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">wiki_netloc</span><span class="o">=</span><span class="n">wiki_netloc</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">)</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;raise_for_httperror&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;soft_max_redirects&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">2</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<span class="c1"># get response from search-request</span>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">404</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="p">[]</span>
 
+    <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">api_result</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</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="k">pass</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="p">(</span>
 
+                <span class="n">api_result</span><span class="p">[</span><span class="s1">&#39;type&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;https://mediawiki.org/wiki/HyperSwitch/errors/bad_request&#39;</span>
 
+                <span class="ow">and</span> <span class="n">api_result</span><span class="p">[</span><span class="s1">&#39;detail&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;title-invalid-characters&#39;</span>
 
+            <span class="p">):</span>
 
+                <span class="k">return</span> <span class="p">[]</span>
 
+
 
+    <span class="n">_network</span><span class="o">.</span><span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+    <span class="n">api_result</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
 
+    <span class="n">title</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">html_to_text</span><span class="p">(</span><span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;titles&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;display&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;title&#39;</span><span class="p">))</span>
 
+    <span class="n">wikipedia_link</span> <span class="o">=</span> <span class="n">api_result</span><span class="p">[</span><span class="s1">&#39;content_urls&#39;</span><span class="p">][</span><span class="s1">&#39;desktop&#39;</span><span class="p">][</span><span class="s1">&#39;page&#39;</span><span class="p">]</span>
 
+
 
+    <span class="k">if</span> <span class="s2">&quot;list&quot;</span> <span class="ow">in</span> <span class="n">display_type</span> <span class="ow">or</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;type&#39;</span><span class="p">)</span> <span class="o">!=</span> <span class="s1">&#39;standard&#39;</span><span class="p">:</span>
 
+        <span class="c1"># show item in the result list if &#39;list&#39; is in the display options or it</span>
 
+        <span class="c1"># is a item that can&#39;t be displayed in a infobox.</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">wikipedia_link</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)})</span>
 
+
 
+    <span class="k">if</span> <span class="s2">&quot;infobox&quot;</span> <span class="ow">in</span> <span class="n">display_type</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;type&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="s1">&#39;standard&#39;</span><span class="p">:</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                <span class="p">{</span>
 
+                    <span class="s1">&#39;infobox&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                    <span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="n">wikipedia_link</span><span class="p">,</span>
 
+                    <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;extract&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
 
+                    <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;source&#39;</span><span class="p">),</span>
 
+                    <span class="s1">&#39;urls&#39;</span><span class="p">:</span> <span class="p">[{</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="s1">&#39;Wikipedia&#39;</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">wikipedia_link</span><span class="p">}],</span>
 
+                <span class="p">}</span>
 
+            <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="c1"># Nonstandard language codes</span>
 
+<span class="c1">#</span>
 
+<span class="c1"># These Wikipedias use language codes that do not conform to the ISO 639</span>
 
+<span class="c1"># standard (which is how wiki subdomains are chosen nowadays).</span>
 
+
 
+<span class="n">lang_map</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">LOCALE_BEST_MATCH</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
 
+<span class="n">lang_map</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
 
+    <span class="p">{</span>
 
+        <span class="s1">&#39;be-tarask&#39;</span><span class="p">:</span> <span class="s1">&#39;bel&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;ak&#39;</span><span class="p">:</span> <span class="s1">&#39;aka&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;als&#39;</span><span class="p">:</span> <span class="s1">&#39;gsw&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;bat-smg&#39;</span><span class="p">:</span> <span class="s1">&#39;sgs&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;cbk-zam&#39;</span><span class="p">:</span> <span class="s1">&#39;cbk&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;fiu-vro&#39;</span><span class="p">:</span> <span class="s1">&#39;vro&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;map-bms&#39;</span><span class="p">:</span> <span class="s1">&#39;map&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;no&#39;</span><span class="p">:</span> <span class="s1">&#39;nb-NO&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;nrm&#39;</span><span class="p">:</span> <span class="s1">&#39;nrf&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;roa-rup&#39;</span><span class="p">:</span> <span class="s1">&#39;rup&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;nds-nl&#39;</span><span class="p">:</span> <span class="s1">&#39;nds&#39;</span><span class="p">,</span>
 
+        <span class="c1">#&#39;simple: – invented code used for the Simple English Wikipedia (not the official IETF code en-simple)</span>
 
+        <span class="s1">&#39;zh-min-nan&#39;</span><span class="p">:</span> <span class="s1">&#39;nan&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;zh-yue&#39;</span><span class="p">:</span> <span class="s1">&#39;yue&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;an&#39;</span><span class="p">:</span> <span class="s1">&#39;arg&#39;</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">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+    <span class="n">fetch_wikimedia_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">)</span>
 
+    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;WIKIPEDIA_LANGUAGES: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]))</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_wikimedia_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/wikipedia.html#searx.engines.wikipedia.fetch_wikimedia_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_wikimedia_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages from Wikipedia.  Not all languages from the</span>
 
+<span class="sd">    :py:obj:`list_of_wikipedias` are supported by SearXNG locales, only those</span>
 
+<span class="sd">    known from :py:obj:`searx.locales.LOCALE_NAMES` or those with a minimal</span>
 
+<span class="sd">    :py:obj:`editing depth &lt;wikipedia_article_depth&gt;`.</span>
 
+
 
+<span class="sd">    The location of the Wikipedia address of a language is mapped in a</span>
 
+<span class="sd">    :py:obj:`custom field &lt;searx.enginelib.traits.EngineTraits.custom&gt;`</span>
 
+<span class="sd">    (``wiki_netloc``).  Here is a reduced example:</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">       traits.custom[&#39;wiki_netloc&#39;] = {</span>
 
+<span class="sd">           &quot;en&quot;: &quot;en.wikipedia.org&quot;,</span>
 
+<span class="sd">           ..</span>
 
+<span class="sd">           &quot;gsw&quot;: &quot;als.wikipedia.org&quot;,</span>
 
+<span class="sd">           ..</span>
 
+<span class="sd">           &quot;zh&quot;: &quot;zh.wikipedia.org&quot;,</span>
 
+<span class="sd">           &quot;zh-classical&quot;: &quot;zh-classical.wikipedia.org&quot;</span>
 
+<span class="sd">       }</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=too-many-branches</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="c1"># insert alias to map from a script or region to a wikipedia variant</span>
 
+
 
+    <span class="k">for</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">sxng_tag_list</span> <span class="ow">in</span> <span class="n">wikipedia_script_variants</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">for</span> <span class="n">sxng_tag</span> <span class="ow">in</span> <span class="n">sxng_tag_list</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+    <span class="k">for</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">sxng_tag_list</span> <span class="ow">in</span> <span class="n">wiki_lc_locale_variants</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">for</span> <span class="n">sxng_tag</span> <span class="ow">in</span> <span class="n">sxng_tag_list</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+
 
+    <span class="n">resp</span> <span class="o">=</span> <span class="n">_network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">list_of_wikipedias</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from Wikipedia is not OK.&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+    <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//table[contains(@class,&quot;sortable&quot;)]//tbody/tr&#39;</span><span class="p">):</span>
 
+
 
+        <span class="n">cols</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;./td&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">cols</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">cols</span> <span class="o">=</span> <span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">text_content</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">cols</span><span class="p">]</span>
 
+
 
+        <span class="n">depth</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">cols</span><span class="p">[</span><span class="mi">11</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">,</span> <span class="s1">&#39;0&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
 
+        <span class="n">articles</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">cols</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
 
+
 
+        <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">cols</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
 
+        <span class="n">wiki_url</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;./td[4]/a/@href&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="n">wiki_url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">wiki_url</span><span class="p">)</span>
 
+
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">language_tag</span><span class="p">(</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="n">lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">))</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="c1"># print(&quot;ERROR: %s [%s] is unknown by babel&quot; % (cols[0], eng_tag))</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">finally</span><span class="p">:</span>
 
+            <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="n">sxng_tag</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">locales</span><span class="o">.</span><span class="n">LOCALE_NAMES</span><span class="p">:</span>
 
+
 
+            <span class="k">if</span> <span class="n">articles</span> <span class="o">&lt;</span> <span class="mi">10000</span><span class="p">:</span>
 
+                <span class="c1"># exclude languages with too few articles</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="k">if</span> <span class="nb">int</span><span class="p">(</span><span class="n">depth</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">20</span><span class="p">:</span>
 
+                <span class="c1"># Rough indicator of a Wikipedia’s quality, showing how</span>
 
+                <span class="c1"># frequently its articles are updated.</span>
 
+                <span class="k">continue</span>
 
+
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">][</span><span class="n">eng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">wiki_url</span><span class="o">.</span><span class="n">netloc</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">sort</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="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 447 - 0
_modules/searx/engines/xpath.html
View File 

@@ -0,0 +1,447 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.xpath &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.xpath</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.xpath</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;The XPath engine is a *generic* engine with which it is possible to configure</span>
 
+<span class="sd">engines in the settings.</span>
 
+
 
+<span class="sd">.. _XPath selector: https://quickref.me/xpath.html#xpath-selectors</span>
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">Request:</span>
 
+
 
+<span class="sd">- :py:obj:`search_url`</span>
 
+<span class="sd">- :py:obj:`lang_all`</span>
 
+<span class="sd">- :py:obj:`soft_max_redirects`</span>
 
+<span class="sd">- :py:obj:`method`</span>
 
+<span class="sd">- :py:obj:`request_body`</span>
 
+<span class="sd">- :py:obj:`cookies`</span>
 
+<span class="sd">- :py:obj:`headers`</span>
 
+
 
+<span class="sd">Paging:</span>
 
+
 
+<span class="sd">- :py:obj:`paging`</span>
 
+<span class="sd">- :py:obj:`page_size`</span>
 
+<span class="sd">- :py:obj:`first_page_num`</span>
 
+
 
+<span class="sd">Time Range:</span>
 
+
 
+<span class="sd">- :py:obj:`time_range_support`</span>
 
+<span class="sd">- :py:obj:`time_range_url`</span>
 
+<span class="sd">- :py:obj:`time_range_map`</span>
 
+
 
+<span class="sd">Safe-Search:</span>
 
+
 
+<span class="sd">- :py:obj:`safe_search_support`</span>
 
+<span class="sd">- :py:obj:`safe_search_map`</span>
 
+
 
+<span class="sd">Response:</span>
 
+
 
+<span class="sd">- :py:obj:`no_result_for_http_status`</span>
 
+
 
+<span class="sd">`XPath selector`_:</span>
 
+
 
+<span class="sd">- :py:obj:`results_xpath`</span>
 
+<span class="sd">- :py:obj:`url_xpath`</span>
 
+<span class="sd">- :py:obj:`title_xpath`</span>
 
+<span class="sd">- :py:obj:`content_xpath`</span>
 
+<span class="sd">- :py:obj:`thumbnail_xpath`</span>
 
+<span class="sd">- :py:obj:`suggestion_xpath`</span>
 
+
 
+
 
+<span class="sd">Example</span>
 
+<span class="sd">=======</span>
 
+
 
+<span class="sd">Here is a simple example of a XPath engine configured in the :ref:`settings</span>
 
+<span class="sd">engines` section, further read :ref:`engines-dev`.</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">  - name : bitbucket</span>
 
+<span class="sd">    engine : xpath</span>
 
+<span class="sd">    paging : True</span>
 
+<span class="sd">    search_url : https://bitbucket.org/repo/all/{pageno}?name={query}</span>
 
+<span class="sd">    url_xpath : //article[@class=&quot;repo-summary&quot;]//a[@class=&quot;repo-link&quot;]/@href</span>
 
+<span class="sd">    title_xpath : //article[@class=&quot;repo-summary&quot;]//a[@class=&quot;repo-link&quot;]</span>
 
+<span class="sd">    content_xpath : //article[@class=&quot;repo-summary&quot;]/p</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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">extract_text</span><span class="p">,</span> <span class="n">extract_url</span><span class="p">,</span> <span class="n">eval_xpath</span><span class="p">,</span> <span class="n">eval_xpath_list</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">raise_for_httperror</span>
 
+<span class="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="n">search_url</span> <span class="o">=</span> <span class="kc">None</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">Search URL of the engine.  Example::</span>
 
+
 
+<span class="sd">    https://example.org/?search={query}&amp;page={pageno}{time_range}{safe_search}</span>
 
+
 
+<span class="sd">Replacements are:</span>
 
+
 
+<span class="sd">``{query}``:</span>
 
+<span class="sd">  Search terms from user.</span>
 
+
 
+<span class="sd">``{pageno}``:</span>
 
+<span class="sd">  Page number if engine supports paging :py:obj:`paging`</span>
 
+
 
+<span class="sd">``{lang}``:</span>
 
+<span class="sd">  ISO 639-1 language code (en, de, fr ..)</span>
 
+
 
+<span class="sd">``{time_range}``:</span>
 
+<span class="sd">  :py:obj:`URL parameter &lt;time_range_url&gt;` if engine :py:obj:`supports time</span>
 
+<span class="sd">  range &lt;time_range_support&gt;`.  The value for the parameter is taken from</span>
 
+<span class="sd">  :py:obj:`time_range_map`.</span>
 
+
 
+<span class="sd">``{safe_search}``:</span>
 
+<span class="sd">  Safe-search :py:obj:`URL parameter &lt;safe_search_map&gt;` if engine</span>
 
+<span class="sd">  :py:obj:`supports safe-search &lt;safe_search_support&gt;`.  The ``{safe_search}``</span>
 
+<span class="sd">  replacement is taken from the :py:obj:`safes_search_map`.  Filter results::</span>
 
+
 
+<span class="sd">      0: none, 1: moderate, 2:strict</span>
 
+
 
+<span class="sd">  If not supported, the URL parameter is an empty string.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">lang_all</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
 
+<span class="sd">&#39;&#39;&#39;Replacement ``{lang}`` in :py:obj:`search_url` if language ``all`` is</span>
 
+<span class="sd">selected.</span>
 
+<span class="sd">&#39;&#39;&#39;</span>
 
+
 
+<span class="n">no_result_for_http_status</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="sd">&#39;&#39;&#39;Return empty result for these HTTP status codes instead of throwing an error.</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">    no_result_for_http_status: []</span>
 
+<span class="sd">&#39;&#39;&#39;</span>
 
+
 
+<span class="n">soft_max_redirects</span> <span class="o">=</span> <span class="mi">0</span>
 
+<span class="sd">&#39;&#39;&#39;Maximum redirects, soft limit. Record an error but don&#39;t stop the engine&#39;&#39;&#39;</span>
 
+
 
+<span class="n">results_xpath</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="sd">&#39;&#39;&#39;`XPath selector`_ for the list of result items&#39;&#39;&#39;</span>
 
+
 
+<span class="n">url_xpath</span> <span class="o">=</span> <span class="kc">None</span>
 
+<span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``url``.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">content_xpath</span> <span class="o">=</span> <span class="kc">None</span>
 
+<span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``content``.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">title_xpath</span> <span class="o">=</span> <span class="kc">None</span>
 
+<span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``title``.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">thumbnail_xpath</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``thumbnail``.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">suggestion_xpath</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``suggestion``.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">cached_xpath</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="n">cached_url</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+
 
+<span class="n">cookies</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="sd">&#39;&#39;&#39;Some engines might offer different result based on cookies.</span>
 
+<span class="sd">Possible use-case: To set safesearch cookie.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">headers</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="sd">&#39;&#39;&#39;Some engines might offer different result based headers.  Possible use-case:</span>
 
+<span class="sd">To set header to moderate.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">method</span> <span class="o">=</span> <span class="s1">&#39;GET&#39;</span>
 
+<span class="sd">&#39;&#39;&#39;Some engines might require to do POST requests for search.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">request_body</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+<span class="sd">&#39;&#39;&#39;The body of the request.  This can only be used if different :py:obj:`method`</span>
 
+<span class="sd">is set, e.g. ``POST``.  For formatting see the documentation of :py:obj:`search_url`::</span>
 
+
 
+<span class="sd">    search={query}&amp;page={pageno}{time_range}{safe_search}</span>
 
+<span class="sd">&#39;&#39;&#39;</span>
 
+
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="sd">&#39;&#39;&#39;Engine supports paging [True or False].&#39;&#39;&#39;</span>
 
+
 
+<span class="n">page_size</span> <span class="o">=</span> <span class="mi">1</span>
 
+<span class="sd">&#39;&#39;&#39;Number of results on each page.  Only needed if the site requires not a page</span>
 
+<span class="sd">number, but an offset.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">first_page_num</span> <span class="o">=</span> <span class="mi">1</span>
 
+<span class="sd">&#39;&#39;&#39;Number of the first page (usually 0 or 1).&#39;&#39;&#39;</span>
 
+
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="sd">&#39;&#39;&#39;Engine supports search time range.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">time_range_url</span> <span class="o">=</span> <span class="s1">&#39;&amp;hours=</span><span class="si">{time_range_val}</span><span class="s1">&#39;</span>
 
+<span class="sd">&#39;&#39;&#39;Time range URL parameter in the in :py:obj:`search_url`.  If no time range is</span>
 
+<span class="sd">requested by the user, the URL parameter is an empty string.  The</span>
 
+<span class="sd">``{time_range_val}`` replacement is taken from the :py:obj:`time_range_map`.</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">    time_range_url : &#39;&amp;days={time_range_val}&#39;</span>
 
+<span class="sd">&#39;&#39;&#39;</span>
 
+
 
+<span class="n">time_range_map</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="mi">24</span><span class="p">,</span>
 
+    <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">7</span><span class="p">,</span>
 
+    <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">30</span><span class="p">,</span>
 
+    <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">365</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="sd">&#39;&#39;&#39;Maps time range value from user to ``{time_range_val}`` in</span>
 
+<span class="sd">:py:obj:`time_range_url`.</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">    time_range_map:</span>
 
+<span class="sd">      day: 1</span>
 
+<span class="sd">      week: 7</span>
 
+<span class="sd">      month: 30</span>
 
+<span class="sd">      year: 365</span>
 
+<span class="sd">&#39;&#39;&#39;</span>
 
+
 
+<span class="n">safe_search_support</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="sd">&#39;&#39;&#39;Engine supports safe-search.&#39;&#39;&#39;</span>
 
+
 
+<span class="n">safe_search_map</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=none&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=moderate&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=strict&#39;</span><span class="p">}</span>
 
+<span class="sd">&#39;&#39;&#39;Maps safe-search value to ``{safe_search}`` in :py:obj:`search_url`.</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">    safesearch: true</span>
 
+<span class="sd">    safes_search_map:</span>
 
+<span class="sd">      0: &#39;&amp;filter=none&#39;</span>
 
+<span class="sd">      1: &#39;&amp;filter=moderate&#39;</span>
 
+<span class="sd">      2: &#39;&amp;filter=strict&#39;</span>
 
+
 
+<span class="sd">&#39;&#39;&#39;</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/xpath.html#searx.engines.xpath.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&#39;&#39;&#39;Build request parameters (see :ref:`engine request`).&#39;&#39;&#39;</span>
 
+    <span class="n">lang</span> <span class="o">=</span> <span class="n">lang_all</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;all&#39;</span><span class="p">:</span>
 
+        <span class="n">lang</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">][:</span><span class="mi">2</span><span class="p">]</span>
 
+
 
+    <span class="n">time_range</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;time_range&#39;</span><span class="p">):</span>
 
+        <span class="n">time_range_val</span> <span class="o">=</span> <span class="n">time_range_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;time_range&#39;</span><span class="p">))</span>
 
+        <span class="n">time_range</span> <span class="o">=</span> <span class="n">time_range_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">time_range_val</span><span class="o">=</span><span class="n">time_range_val</span><span class="p">)</span>
 
+
 
+    <span class="n">safe_search</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+    <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]:</span>
 
+        <span class="n">safe_search</span> <span class="o">=</span> <span class="n">safe_search_map</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]]</span>
 
+
 
+    <span class="n">fargs</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">})[</span><span class="mi">2</span><span class="p">:],</span>
 
+        <span class="s1">&#39;lang&#39;</span><span class="p">:</span> <span class="n">lang</span><span class="p">,</span>
 
+        <span class="s1">&#39;pageno&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">page_size</span> <span class="o">+</span> <span class="n">first_page_num</span><span class="p">,</span>
 
+        <span class="s1">&#39;time_range&#39;</span><span class="p">:</span> <span class="n">time_range</span><span class="p">,</span>
 
+        <span class="s1">&#39;safe_search&#39;</span><span class="p">:</span> <span class="n">safe_search</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cookies</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">headers</span><span class="p">)</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">fargs</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;method&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">method</span>
 
+
 
+    <span class="k">if</span> <span class="n">request_body</span><span class="p">:</span>
 
+        <span class="c1"># don&#39;t url-encode the query if it&#39;s in the request body</span>
 
+        <span class="n">fargs</span><span class="p">[</span><span class="s1">&#39;query&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">request_body</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">fargs</span><span class="p">)</span>
 
+
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;soft_max_redirects&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">soft_max_redirects</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;raise_for_httperror&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
 
+
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/xpath.html#searx.engines.xpath.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>  <span class="c1"># pylint: disable=too-many-branches</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Scrap *results* from the response (see :ref:`result types`).&quot;&quot;&quot;</span>
 
+    <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+    <span class="k">if</span> <span class="n">no_result_for_http_status</span> <span class="ow">and</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="ow">in</span> <span class="n">no_result_for_http_status</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">results</span>
 
+
 
+    <span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">results</span>
 
+
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+    <span class="n">is_onion</span> <span class="o">=</span> <span class="s1">&#39;onions&#39;</span> <span class="ow">in</span> <span class="n">categories</span>
 
+
 
+    <span class="k">if</span> <span class="n">results_xpath</span><span class="p">:</span>
 
+        <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">results_xpath</span><span class="p">):</span>
 
+
 
+            <span class="n">url</span> <span class="o">=</span> <span class="n">extract_url</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">url_xpath</span><span class="p">,</span> <span class="n">min_len</span><span class="o">=</span><span class="mi">1</span><span class="p">),</span> <span class="n">search_url</span><span class="p">)</span>
 
+            <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">title_xpath</span><span class="p">,</span> <span class="n">min_len</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span>
 
+            <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">content_xpath</span><span class="p">))</span>
 
+            <span class="n">tmp_result</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">}</span>
 
+
 
+            <span class="c1"># add thumbnail if available</span>
 
+            <span class="k">if</span> <span class="n">thumbnail_xpath</span><span class="p">:</span>
 
+                <span class="n">thumbnail_xpath_result</span> <span class="o">=</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">thumbnail_xpath</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">thumbnail_xpath_result</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 
+                    <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">extract_url</span><span class="p">(</span><span class="n">thumbnail_xpath_result</span><span class="p">,</span> <span class="n">search_url</span><span class="p">)</span>
 
+
 
+            <span class="c1"># add alternative cached url if available</span>
 
+            <span class="k">if</span> <span class="n">cached_xpath</span><span class="p">:</span>
 
+                <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;cached_url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">cached_url</span> <span class="o">+</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">cached_xpath</span><span class="p">,</span> <span class="n">min_len</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span>
 
+
 
+            <span class="k">if</span> <span class="n">is_onion</span><span class="p">:</span>
 
+                <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;is_onion&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tmp_result</span><span class="p">)</span>
 
+
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">cached_xpath</span><span class="p">:</span>
 
+            <span class="k">for</span> <span class="n">url</span><span class="p">,</span> <span class="n">title</span><span class="p">,</span> <span class="n">content</span><span class="p">,</span> <span class="n">cached</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span>
 
+                <span class="p">(</span><span class="n">extract_url</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">search_url</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">url_xpath</span><span class="p">)),</span>
 
+                <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">title_xpath</span><span class="p">)),</span>
 
+                <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">content_xpath</span><span class="p">)),</span>
 
+                <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">cached_xpath</span><span class="p">)),</span>
 
+            <span class="p">):</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                    <span class="p">{</span>
 
+                        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+                        <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
 
+                        <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
 
+                        <span class="s1">&#39;cached_url&#39;</span><span class="p">:</span> <span class="n">cached_url</span> <span class="o">+</span> <span class="n">cached</span><span class="p">,</span>
 
+                        <span class="s1">&#39;is_onion&#39;</span><span class="p">:</span> <span class="n">is_onion</span><span class="p">,</span>
 
+                    <span class="p">}</span>
 
+                <span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="k">for</span> <span class="n">url</span><span class="p">,</span> <span class="n">title</span><span class="p">,</span> <span class="n">content</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span>
 
+                <span class="p">(</span><span class="n">extract_url</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">search_url</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">url_xpath</span><span class="p">)),</span>
 
+                <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">title_xpath</span><span class="p">)),</span>
 
+                <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">content_xpath</span><span class="p">)),</span>
 
+            <span class="p">):</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span> <span class="s1">&#39;is_onion&#39;</span><span class="p">:</span> <span class="n">is_onion</span><span class="p">})</span>
 
+
 
+    <span class="k">if</span> <span class="n">suggestion_xpath</span><span class="p">:</span>
 
+        <span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">suggestion_xpath</span><span class="p">):</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">suggestion</span><span class="p">)})</span>
 
+
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;found </span><span class="si">%s</span><span class="s2"> results&quot;</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">results</span><span class="p">))</span>
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 304 - 0
_modules/searx/engines/yahoo.html
View File 

@@ -0,0 +1,304 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.yahoo &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.yahoo</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.yahoo</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Yahoo Search (Web)</span>
 
+
 
+<span class="sd">Languages are supported by mapping the language to a domain.  If domain is not</span>
 
+<span class="sd">found in :py:obj:`lang2domain` URL ``&lt;lang&gt;.search.yahoo.com`` is used.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">unquote</span><span class="p">,</span>
 
+    <span class="n">urlencode</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</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="p">(</span>
 
+    <span class="n">eval_xpath_getindex</span><span class="p">,</span>
 
+    <span class="n">eval_xpath_list</span><span class="p">,</span>
 
+    <span class="n">extract_text</span><span class="p">,</span>
 
+    <span class="n">html_to_text</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
 
+
 
+<span class="c1"># about</span>
 
+<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://search.yahoo.com/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://developer.yahoo.com/api/&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;HTML&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># engine dependent config</span>
 
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">,</span> <span class="s1">&#39;web&#39;</span><span class="p">]</span>
 
+<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="c1"># send_accept_language_header = True</span>
 
+
 
+<span class="n">time_range_dict</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;1d&#39;</span><span class="p">,</span> <span class="s1">&#39;d&#39;</span><span class="p">),</span>
 
+    <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;1w&#39;</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">),</span>
 
+    <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;1m&#39;</span><span class="p">,</span> <span class="s1">&#39;m&#39;</span><span class="p">),</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">lang2domain</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;zh_chs&#39;</span><span class="p">:</span> <span class="s1">&#39;hk.search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;zh_cht&#39;</span><span class="p">:</span> <span class="s1">&#39;tw.search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;any&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;en&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;bg&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;cs&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;da&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;el&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;et&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;he&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;hr&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ja&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;ko&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;sk&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+    <span class="s1">&#39;sl&#39;</span><span class="p">:</span> <span class="s1">&#39;search.yahoo.com&#39;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="sd">&quot;&quot;&quot;Map language to domain&quot;&quot;&quot;</span>
 
+
 
+<span class="n">yahoo_languages</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;all&quot;</span><span class="p">:</span> <span class="s2">&quot;any&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;ar&quot;</span><span class="p">:</span> <span class="s2">&quot;ar&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;bg&quot;</span><span class="p">:</span> <span class="s2">&quot;bg&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;cs&quot;</span><span class="p">:</span> <span class="s2">&quot;cs&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;da&quot;</span><span class="p">:</span> <span class="s2">&quot;da&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;de&quot;</span><span class="p">:</span> <span class="s2">&quot;de&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;el&quot;</span><span class="p">:</span> <span class="s2">&quot;el&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;en&quot;</span><span class="p">:</span> <span class="s2">&quot;en&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;es&quot;</span><span class="p">:</span> <span class="s2">&quot;es&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;et&quot;</span><span class="p">:</span> <span class="s2">&quot;et&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;fi&quot;</span><span class="p">:</span> <span class="s2">&quot;fi&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;fr&quot;</span><span class="p">:</span> <span class="s2">&quot;fr&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;he&quot;</span><span class="p">:</span> <span class="s2">&quot;he&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;hr&quot;</span><span class="p">:</span> <span class="s2">&quot;hr&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;hu&quot;</span><span class="p">:</span> <span class="s2">&quot;hu&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;it&quot;</span><span class="p">:</span> <span class="s2">&quot;it&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;ja&quot;</span><span class="p">:</span> <span class="s2">&quot;ja&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;ko&quot;</span><span class="p">:</span> <span class="s2">&quot;ko&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;lt&quot;</span><span class="p">:</span> <span class="s2">&quot;lt&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;lv&quot;</span><span class="p">:</span> <span class="s2">&quot;lv&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;nl&quot;</span><span class="p">:</span> <span class="s2">&quot;nl&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;no&quot;</span><span class="p">:</span> <span class="s2">&quot;no&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;pl&quot;</span><span class="p">:</span> <span class="s2">&quot;pl&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;pt&quot;</span><span class="p">:</span> <span class="s2">&quot;pt&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;ro&quot;</span><span class="p">:</span> <span class="s2">&quot;ro&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;ru&quot;</span><span class="p">:</span> <span class="s2">&quot;ru&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;sk&quot;</span><span class="p">:</span> <span class="s2">&quot;sk&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;sl&quot;</span><span class="p">:</span> <span class="s2">&quot;sl&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;sv&quot;</span><span class="p">:</span> <span class="s2">&quot;sv&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;th&quot;</span><span class="p">:</span> <span class="s2">&quot;th&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;tr&quot;</span><span class="p">:</span> <span class="s2">&quot;tr&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;zh&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_chs&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;zh_Hans&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_chs&quot;</span><span class="p">,</span>
 
+    <span class="s1">&#39;zh-CN&#39;</span><span class="p">:</span> <span class="s2">&quot;zh_chs&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;zh_Hant&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_cht&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;zh-HK&quot;</span><span class="p">:</span> <span class="s2">&quot;zh_cht&quot;</span><span class="p">,</span>
 
+    <span class="s1">&#39;zh-TW&#39;</span><span class="p">:</span> <span class="s2">&quot;zh_cht&quot;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<div class="viewcode-block" id="request">
 
+<a class="viewcode-back" href="../../../dev/engines/online/yahoo.html#searx.engines.yahoo.request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;build request&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">lang</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">&quot;language&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+    <span class="n">lang</span> <span class="o">=</span> <span class="n">yahoo_languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">lang</span><span class="p">,</span> <span class="s2">&quot;any&quot;</span><span class="p">)</span>
 
+
 
+    <span class="n">offset</span> <span class="o">=</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">7</span> <span class="o">+</span> <span class="mi">1</span>
 
+    <span class="n">age</span><span class="p">,</span> <span class="n">btf</span> <span class="o">=</span> <span class="n">time_range_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">],</span> <span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
 
+
 
+    <span class="n">args</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">(</span>
 
+        <span class="p">{</span>
 
+            <span class="s1">&#39;p&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
 
+            <span class="s1">&#39;ei&#39;</span><span class="p">:</span> <span class="s1">&#39;UTF-8&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;fl&#39;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
 
+            <span class="s1">&#39;vl&#39;</span><span class="p">:</span> <span class="s1">&#39;lang_&#39;</span> <span class="o">+</span> <span class="n">lang</span><span class="p">,</span>
 
+            <span class="s1">&#39;btf&#39;</span><span class="p">:</span> <span class="n">btf</span><span class="p">,</span>
 
+            <span class="s1">&#39;fr2&#39;</span><span class="p">:</span> <span class="s1">&#39;time&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;age&#39;</span><span class="p">:</span> <span class="n">age</span><span class="p">,</span>
 
+            <span class="s1">&#39;b&#39;</span><span class="p">:</span> <span class="n">offset</span><span class="p">,</span>
 
+            <span class="s1">&#39;xargs&#39;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
 
+        <span class="p">}</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="n">domain</span> <span class="o">=</span> <span class="n">lang2domain</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">lang</span><span class="p">,</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">.search.yahoo.com&#39;</span> <span class="o">%</span> <span class="n">lang</span><span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https://</span><span class="si">%s</span><span class="s1">/search?</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">domain</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="parse_url">
 
+<a class="viewcode-back" href="../../../dev/engines/online/yahoo.html#searx.engines.yahoo.parse_url">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">parse_url</span><span class="p">(</span><span class="n">url_string</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;remove yahoo-specific tracking-url&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">endings</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;/RS&#39;</span><span class="p">,</span> <span class="s1">&#39;/RK&#39;</span><span class="p">]</span>
 
+    <span class="n">endpositions</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">start</span> <span class="o">=</span> <span class="n">url_string</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;http&#39;</span><span class="p">,</span> <span class="n">url_string</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;/RU=&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">ending</span> <span class="ow">in</span> <span class="n">endings</span><span class="p">:</span>
 
+        <span class="n">endpos</span> <span class="o">=</span> <span class="n">url_string</span><span class="o">.</span><span class="n">rfind</span><span class="p">(</span><span class="n">ending</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">endpos</span> <span class="o">&gt;</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
 
+            <span class="n">endpositions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">endpos</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">start</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">endpositions</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">url_string</span>
 
+
 
+    <span class="n">end</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">endpositions</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">unquote</span><span class="p">(</span><span class="n">url_string</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">end</span><span class="p">])</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="response">
 
+<a class="viewcode-back" href="../../../dev/engines/online/yahoo.html#searx.engines.yahoo.response">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;parse response&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="c1"># parse results</span>
 
+    <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[contains(@class,&quot;algo-sr&quot;)]&#39;</span><span class="p">):</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//h3/a/@href&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">url</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">parse_url</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+
 
+        <span class="n">title</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//h3//a/@aria-label&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+        <span class="n">title</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
 
+        <span class="n">content</span> <span class="o">=</span> <span class="n">eval_xpath_getindex</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;compText&quot;)]&#39;</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+        <span class="n">content</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">content</span><span class="p">,</span> <span class="n">allow_none</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
+
 
+        <span class="c1"># append result</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">{</span>
 
+                <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
 
+                <span class="c1"># title sometimes contains HTML tags / see</span>
 
+                <span class="c1"># https://github.com/searxng/searxng/issues/3790</span>
 
+                <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">html_to_text</span><span class="p">(</span><span class="n">title</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">()),</span>
 
+                <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">html_to_text</span><span class="p">(</span><span class="n">content</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">()),</span>
 
+            <span class="p">}</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s1">&#39;//div[contains(@class, &quot;AlsoTry&quot;)]//table//a&#39;</span><span class="p">):</span>
 
+        <span class="c1"># append suggestion</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">suggestion</span><span class="p">)})</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 366 - 0
_modules/searx/engines/zlibrary.html
View File 

@@ -0,0 +1,366 @@
 
+<!DOCTYPE html>
 
+
 
+<html lang="en" data-content_root="../../../">
 
+  <head>
 
+    <meta charset="utf-8" />
 
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    <title>searx.engines.zlibrary &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.engines.zlibrary</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.engines.zlibrary</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;`Z-Library`_ (abbreviated as z-lib, formerly BookFinder) is a shadow library</span>
 
+<span class="sd">project for file-sharing access to scholarly journal articles, academic texts</span>
 
+<span class="sd">and general-interest books.  It began as a mirror of Library Genesis, from which</span>
 
+<span class="sd">most of its books originate.</span>
 
+
 
+<span class="sd">.. _Z-Library: https://zlibrary-global.se/</span>
 
+
 
+<span class="sd">Configuration</span>
 
+<span class="sd">=============</span>
 
+
 
+<span class="sd">The engine has the following additional settings:</span>
 
+
 
+<span class="sd">- :py:obj:`zlib_year_from`</span>
 
+<span class="sd">- :py:obj:`zlib_year_to`</span>
 
+<span class="sd">- :py:obj:`zlib_ext`</span>
 
+
 
+<span class="sd">With this options a SearXNG maintainer is able to configure **additional**</span>
 
+<span class="sd">engines for specific searches in Z-Library.  For example a engine to search</span>
 
+<span class="sd">only for EPUB from 2010 to 2020.</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">   - name: z-library 2010s epub</span>
 
+<span class="sd">     engine: zlibrary</span>
 
+<span class="sd">     shortcut: zlib2010s</span>
 
+<span class="sd">     zlib_year_from: &#39;2010&#39;</span>
 
+<span class="sd">     zlib_year_to: &#39;2020&#39;</span>
 
+<span class="sd">     zlib_ext: &#39;EPUB&#39;</span>
 
+
 
+<span class="sd">Implementations</span>
 
+<span class="sd">===============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Optional</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">quote</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</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">extract_text</span><span class="p">,</span> <span class="n">eval_xpath</span><span class="p">,</span> <span class="n">eval_xpath_list</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</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">ENGINE_TRAITS</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">SearxException</span>
 
+
 
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</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">logging</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="c1"># about</span>
 
+<span class="n">about</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s2">&quot;https://zlibrary-global.se&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s2">&quot;Q104863992&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
 
+    <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s2">&quot;HTML&quot;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="n">categories</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;files&quot;</span><span class="p">]</span>
 
+<span class="n">paging</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="n">base_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;https://zlibrary-global.se&quot;</span>
 
+
 
+<span class="n">zlib_year_from</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;Filter z-library&#39;s results by year from. E.g &#39;2010&#39;.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">zlib_year_to</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;Filter z-library&#39;s results by year to. E.g. &#39;2010&#39;.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">zlib_ext</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;Filter z-library&#39;s results by a file ending. Common filters for example are</span>
 
+<span class="sd">``PDF`` and ``EPUB``.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="init">
 
+<a class="viewcode-back" href="../../../dev/engines/online/zlibrary.html#searx.engines.zlibrary.init">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Check of engine&#39;s settings.&quot;&quot;&quot;</span>
 
+    <span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span> <span class="o">=</span> <span class="n">EngineTraits</span><span class="p">(</span><span class="o">**</span><span class="n">ENGINE_TRAITS</span><span class="p">[</span><span class="s2">&quot;z-library&quot;</span><span class="p">])</span>
 
+
 
+    <span class="k">if</span> <span class="n">zlib_ext</span> <span class="ow">and</span> <span class="n">zlib_ext</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;ext&quot;</span><span class="p">]:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;invalid setting ext: </span><span class="si">{</span><span class="n">zlib_ext</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">zlib_year_from</span> <span class="ow">and</span> <span class="n">zlib_year_from</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;year_from&quot;</span><span class="p">]:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;invalid setting year_from: </span><span class="si">{</span><span class="n">zlib_year_from</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">zlib_year_to</span> <span class="ow">and</span> <span class="n">zlib_year_to</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;year_to&quot;</span><span class="p">]:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;invalid setting year_to: </span><span class="si">{</span><span class="n">zlib_year_to</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</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="n">traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;language&quot;</span><span class="p">],</span> <span class="n">traits</span><span class="o">.</span><span class="n">all_locale</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">search_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="n">base_url</span>
 
+        <span class="o">+</span> <span class="s2">&quot;/s/</span><span class="si">{search_query}</span><span class="s2">/?page=</span><span class="si">{pageno}</span><span class="s2">&quot;</span>
 
+        <span class="o">+</span> <span class="s2">&quot;&amp;yearFrom=</span><span class="si">{zlib_year_from}</span><span class="s2">&quot;</span>
 
+        <span class="o">+</span> <span class="s2">&quot;&amp;yearTo=</span><span class="si">{zlib_year_to}</span><span class="s2">&quot;</span>
 
+        <span class="o">+</span> <span class="s2">&quot;&amp;languages[]=</span><span class="si">{lang}</span><span class="s2">&quot;</span>
 
+        <span class="o">+</span> <span class="s2">&quot;&amp;extensions[]=</span><span class="si">{zlib_ext}</span><span class="s2">&quot;</span>
 
+    <span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
 
+        <span class="n">search_query</span><span class="o">=</span><span class="n">quote</span><span class="p">(</span><span class="n">query</span><span class="p">),</span>
 
+        <span class="n">pageno</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">],</span>
 
+        <span class="n">lang</span><span class="o">=</span><span class="n">lang</span><span class="p">,</span>
 
+        <span class="n">zlib_year_from</span><span class="o">=</span><span class="n">zlib_year_from</span><span class="p">,</span>
 
+        <span class="n">zlib_year_to</span><span class="o">=</span><span class="n">zlib_year_to</span><span class="p">,</span>
 
+        <span class="n">zlib_ext</span><span class="o">=</span><span class="n">zlib_ext</span><span class="p">,</span>
 
+    <span class="p">)</span>
 
+    <span class="n">params</span><span class="p">[</span><span class="s2">&quot;verify&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
 
+    <span class="k">return</span> <span class="n">params</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">domain_is_seized</span><span class="p">(</span><span class="n">dom</span><span class="p">):</span>
 
+    <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//title&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="s2">&quot;seized&quot;</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//title&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">text</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
 
+    <span class="n">results</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">domain_is_seized</span><span class="p">(</span><span class="n">dom</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="n">SearxException</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;zlibrary domain is seized: </span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//div[@id=&quot;searchResultBox&quot;]//div[contains(@class, &quot;resItemBox&quot;)]&#39;</span><span class="p">):</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">_parse_result</span><span class="p">(</span><span class="n">item</span><span class="p">))</span>
 
+
 
+    <span class="k">return</span> <span class="n">results</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">selector</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+    <span class="k">return</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">selector</span><span class="p">))</span>
 
+
 
+
 
+<span class="n">i18n_language</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Language&quot;</span><span class="p">)</span>
 
+<span class="n">i18n_book_rating</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Book rating&quot;</span><span class="p">)</span>
 
+<span class="n">i18n_file_quality</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;File quality&quot;</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_parse_result</span><span class="p">(</span><span class="n">item</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
 
+
 
+    <span class="n">author_elements</span> <span class="o">=</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//div[@class=&quot;authors&quot;]//a[@itemprop=&quot;author&quot;]&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">result</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;template&quot;</span><span class="p">:</span> <span class="s2">&quot;paper.html&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">item</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;(.//a[starts-with(@href, &quot;/book/&quot;)])[1]/@href&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
 
+        <span class="s2">&quot;title&quot;</span><span class="p">:</span> <span class="n">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//*[@itemprop=&quot;name&quot;]&#39;</span><span class="p">),</span>
 
+        <span class="s2">&quot;authors&quot;</span><span class="p">:</span> <span class="p">[</span><span class="n">extract_text</span><span class="p">(</span><span class="n">author</span><span class="p">)</span> <span class="k">for</span> <span class="n">author</span> <span class="ow">in</span> <span class="n">author_elements</span><span class="p">],</span>
 
+        <span class="s2">&quot;publisher&quot;</span><span class="p">:</span> <span class="n">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//a[@title=&quot;Publisher&quot;]&#39;</span><span class="p">),</span>
 
+        <span class="s2">&quot;type&quot;</span><span class="p">:</span> <span class="n">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;property__file&quot;)]//div[contains(@class, &quot;property_value&quot;)]&#39;</span><span class="p">),</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">thumbnail</span> <span class="o">=</span> <span class="n">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//img[contains(@class, &quot;cover&quot;)]/@data-src&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">thumbnail</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">):</span>
 
+        <span class="n">result</span><span class="p">[</span><span class="s2">&quot;thumbnail&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">thumbnail</span>
 
+
 
+    <span class="n">year</span> <span class="o">=</span> <span class="n">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;property_year&quot;)]//div[contains(@class, &quot;property_value&quot;)]&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">year</span><span class="p">:</span>
 
+        <span class="n">result</span><span class="p">[</span><span class="s2">&quot;publishedDate&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">year</span><span class="p">,</span> <span class="s1">&#39;%Y&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">content</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">language</span> <span class="o">=</span> <span class="n">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//div[contains(@class, &quot;property_language&quot;)]//div[contains(@class, &quot;property_value&quot;)]&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">language</span><span class="p">:</span>
 
+        <span class="n">content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">i18n_language</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">language</span><span class="o">.</span><span class="n">capitalize</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+    <span class="n">book_rating</span> <span class="o">=</span> <span class="n">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//span[contains(@class, &quot;book-rating-interest-score&quot;)]&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">book_rating</span> <span class="ow">and</span> <span class="nb">float</span><span class="p">(</span><span class="n">book_rating</span><span class="p">):</span>
 
+        <span class="n">content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">i18n_book_rating</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">book_rating</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+    <span class="n">file_quality</span> <span class="o">=</span> <span class="n">_text</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="s1">&#39;.//span[contains(@class, &quot;book-rating-quality-score&quot;)]&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">file_quality</span> <span class="ow">and</span> <span class="nb">float</span><span class="p">(</span><span class="n">file_quality</span><span class="p">):</span>
 
+        <span class="n">content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">i18n_file_quality</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">file_quality</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+    <span class="n">result</span><span class="p">[</span><span class="s2">&quot;content&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot; | &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">result</span>
 
+
 
+
 
+<div class="viewcode-block" id="fetch_traits">
 
+<a class="viewcode-back" href="../../../dev/engines/online/zlibrary.html#searx.engines.zlibrary.fetch_traits">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Fetch languages and other search arguments from zlibrary&#39;s search form.&quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=import-outside-toplevel, too-many-branches</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.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">get</span>  <span class="c1"># see https://github.com/searxng/searxng/issues/762</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">language_tag</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_use_old_values</span><span class="p">():</span>
 
+        <span class="c1"># don&#39;t change anything, re-use the existing values</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="n">ENGINE_TRAITS</span><span class="p">[</span><span class="s2">&quot;z-library&quot;</span><span class="p">][</span><span class="s2">&quot;all_locale&quot;</span><span class="p">]</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span> <span class="o">=</span> <span class="n">ENGINE_TRAITS</span><span class="p">[</span><span class="s2">&quot;z-library&quot;</span><span class="p">][</span><span class="s2">&quot;custom&quot;</span><span class="p">]</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span> <span class="o">=</span> <span class="n">ENGINE_TRAITS</span><span class="p">[</span><span class="s2">&quot;z-library&quot;</span><span class="p">][</span><span class="s2">&quot;languages&quot;</span><span class="p">]</span>
 
+
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">base_url</span><span class="p">,</span> <span class="n">verify</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="n">SearxException</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;ERROR: zlibrary domain &#39;</span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s2">&#39; is seized?&quot;</span><span class="p">)</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;  --&gt; </span><span class="si">{</span><span class="n">exc</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+        <span class="n">_use_old_values</span><span class="p">()</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Response from zlibrary&#39;s search page is not OK.&quot;</span><span class="p">)</span>
 
+    <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="k">if</span> <span class="n">domain_is_seized</span><span class="p">(</span><span class="n">dom</span><span class="p">):</span>
 
+        <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;ERROR: zlibrary domain is seized: </span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+        <span class="n">_use_old_values</span><span class="p">()</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">all_locale</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;ext&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;year_from&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;year_to&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">for</span> <span class="n">year</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//div[@id=&#39;advSearch-noJS&#39;]//select[@id=&#39;sf_yearFrom&#39;]/option&quot;</span><span class="p">):</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;year_from&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">year</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">))</span>
 
+
 
+    <span class="k">for</span> <span class="n">year</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//div[@id=&#39;advSearch-noJS&#39;]//select[@id=&#39;sf_yearTo&#39;]/option&quot;</span><span class="p">):</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;year_to&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">year</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">))</span>
 
+
 
+    <span class="k">for</span> <span class="n">ext</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//div[@id=&#39;advSearch-noJS&#39;]//select[@id=&#39;sf_extensions&#39;]/option&quot;</span><span class="p">):</span>
 
+        <span class="n">value</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">ext</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">value</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s2">&quot;ext&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
+
 
+    <span class="c1"># Handle languages</span>
 
+    <span class="c1"># Z-library uses English names for languages, so we need to map them to their respective locales</span>
 
+    <span class="n">language_name_locale_map</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="k">for</span> <span class="n">locale</span> <span class="ow">in</span> <span class="n">babel</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">localedata</span><span class="o">.</span><span class="n">locale_identifiers</span><span class="p">():</span>  <span class="c1"># type: ignore</span>
 
+        <span class="c1"># Create a Locale object for the current locale</span>
 
+        <span class="n">loc</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="n">locale</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">loc</span><span class="o">.</span><span class="n">english_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">language_name_locale_map</span><span class="p">[</span><span class="n">loc</span><span class="o">.</span><span class="n">english_name</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> <span class="o">=</span> <span class="n">loc</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="s2">&quot;//div[@id=&#39;advSearch-noJS&#39;]//select[@id=&#39;sf_languages&#39;]/option&quot;</span><span class="p">):</span>
 
+        <span class="n">eng_lang</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;value&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">eng_lang</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">try</span><span class="p">:</span>
 
+            <span class="n">locale</span> <span class="o">=</span> <span class="n">language_name_locale_map</span><span class="p">[</span><span class="n">eng_lang</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span>
 
+        <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
 
+            <span class="c1"># silently ignore unknown languages</span>
 
+            <span class="c1"># print(&quot;ERROR: %s is unknown by babel&quot; % (eng_lang))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">sxng_lang</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
 
+        <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_lang</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_lang</span><span class="p">:</span>
 
+                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_lang</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_lang</span><span class="p">))</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_lang</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_lang</span></div>
 
+
 
+</pre></div>
 
+
 
+            <div class="clearer"></div>
 
+          </div>
 
+        </div>
 
+      </div>
 
+  <span id="sidebar-top"></span>
 
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
 
+        <div class="sphinxsidebarwrapper">
 
+  
+    
+            <p class="logo"><a href="../../../index.html">
 
+              <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
 
+            </a></p>
 
+  
+
 
+<h3><a href="../../../index.html">Table of Contents</a></h3>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
 
+</ul>
 
+
 
+  <h3>Project Links</h3>
 
+  <ul>
 
+    <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
 
+  
+    <li><a href="https://searx.space">Public instances</a>
 
+  
+    <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
 
+  </ul><h3>Navigation</h3>
 
+<ul>
 
+  <li><a href="../../../index.html">Overview</a>
 
+    <ul>
 
+      <li><a href="../../index.html">Module code</a>
 
+        <ul>
 
+      <li><a href="../engines.html">searx.engines</a>
 
+        
+          
+          </ul>
 
+      </li></ul>
 
+      </li>
 
+    </ul>
 
+  </li>
 
+</ul>
 
+<search id="searchbox" style="display: none" role="search">
 
+  <h3 id="searchlabel">Quick search</h3>
 
+    <div class="searchformwrapper">
 
+    <form class="search" action="../../../search.html" method="get">
 
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 
+      <input type="submit" value="Go" />
 
+    </form>
 
+    </div>
 
+</search>
 
+<script>document.getElementById('searchbox').style.display = "block"</script>
 
+        </div>
 
+      </div>
 
+      <div class="clearer"></div>
 
+    </div>
 
+    <div class="footer" role="contentinfo">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 255 - 0
_modules/searx/exceptions.html
View File 

@@ -0,0 +1,255 @@
 
+<!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.exceptions &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.exceptions</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.exceptions</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Exception types raised by SearXNG modules.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
 
+
 
+
 
+<div class="viewcode-block" id="SearxException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base SearXNG exception.&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxParameterException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxParameterException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxParameterException</span><span class="p">(</span><span class="n">SearxException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Raised when query miss a required parameter&quot;&quot;&quot;</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="n">value</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span> <span class="ow">or</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;Empty &#39;</span> <span class="o">+</span> <span class="n">name</span> <span class="o">+</span> <span class="s1">&#39; parameter&#39;</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;Invalid value &quot;&#39;</span> <span class="o">+</span> <span class="n">value</span> <span class="o">+</span> <span class="s1">&#39;&quot; for parameter &#39;</span> <span class="o">+</span> <span class="n">name</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">parameter_name</span> <span class="o">=</span> <span class="n">name</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">parameter_value</span> <span class="o">=</span> <span class="n">value</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxSettingsException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxSettingsException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxSettingsException</span><span class="p">(</span><span class="n">SearxException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Error while loading the settings&quot;&quot;&quot;</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">message</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="ne">Exception</span><span class="p">],</span> <span class="n">filename</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">filename</span> <span class="o">=</span> <span class="n">filename</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxEngineException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxEngineException</span><span class="p">(</span><span class="n">SearxException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Error inside an engine&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxXPathSyntaxException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxXPathSyntaxException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxXPathSyntaxException</span><span class="p">(</span><span class="n">SearxEngineException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Syntax error in a XPATH&quot;&quot;&quot;</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">xpath_spec</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="n">message</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span>
 
+        <span class="c1"># str(xpath_spec) to deal with str and XPath instance</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">xpath_str</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxEngineResponseException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineResponseException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxEngineResponseException</span><span class="p">(</span><span class="n">SearxEngineException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Impossible to parse the result of an engine&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxEngineAPIException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineAPIException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxEngineAPIException</span><span class="p">(</span><span class="n">SearxEngineResponseException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The website has returned an application error&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxEngineAccessDeniedException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineAccessDeniedException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxEngineAccessDeniedException</span><span class="p">(</span><span class="n">SearxEngineResponseException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The website is blocking the access&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">SUSPEND_TIME_SETTING</span> <span class="o">=</span> <span class="s2">&quot;search.suspended_times.SearxEngineAccessDenied&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;This settings contains the default suspended time (default 86400 sec / 1</span>
 
+<span class="sd">    day).&quot;&quot;&quot;</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">suspended_time</span><span class="p">:</span> <span class="nb">int</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">message</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;Access denied&#39;</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Generic exception to raise when an engine denies access to the results.</span>
 
+
 
+<span class="sd">        :param suspended_time: How long the engine is going to be suspended in</span>
 
+<span class="sd">            second. Defaults to None.</span>
 
+<span class="sd">        :type suspended_time: int, None</span>
 
+<span class="sd">        :param message: Internal message.  Defaults to ``Access denied``</span>
 
+<span class="sd">        :type message: str</span>
 
+<span class="sd">        &quot;&quot;&quot;</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">suspended_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_default_suspended_time</span><span class="p">()</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span> <span class="o">+</span> <span class="s1">&#39;, suspended_time=&#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">suspended_time</span><span class="p">))</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">suspended_time</span> <span class="o">=</span> <span class="n">suspended_time</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_get_default_suspended_time</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</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="c1"># pylint: disable=C0415</span>
 
+
 
+        <span class="k">return</span> <span class="n">get_setting</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SUSPEND_TIME_SETTING</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxEngineCaptchaException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineCaptchaException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxEngineCaptchaException</span><span class="p">(</span><span class="n">SearxEngineAccessDeniedException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The website has returned a CAPTCHA.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">SUSPEND_TIME_SETTING</span> <span class="o">=</span> <span class="s2">&quot;search.suspended_times.SearxEngineCaptcha&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;This settings contains the default suspended time (default 86400 sec / 1</span>
 
+<span class="sd">    day).&quot;&quot;&quot;</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">suspended_time</span><span class="p">:</span> <span class="nb">int</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">message</span><span class="o">=</span><span class="s1">&#39;CAPTCHA&#39;</span><span class="p">):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">,</span> <span class="n">suspended_time</span><span class="o">=</span><span class="n">suspended_time</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxEngineTooManyRequestsException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineTooManyRequestsException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxEngineTooManyRequestsException</span><span class="p">(</span><span class="n">SearxEngineAccessDeniedException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The website has returned a Too Many Request status code</span>
 
+
 
+<span class="sd">    By default, searx stops sending requests to this engine for 1 hour.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">SUSPEND_TIME_SETTING</span> <span class="o">=</span> <span class="s2">&quot;search.suspended_times.SearxEngineTooManyRequests&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;This settings contains the default suspended time (default 3660 sec / 1</span>
 
+<span class="sd">    hour).&quot;&quot;&quot;</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">suspended_time</span><span class="p">:</span> <span class="nb">int</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">message</span><span class="o">=</span><span class="s1">&#39;Too many request&#39;</span><span class="p">):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">,</span> <span class="n">suspended_time</span><span class="o">=</span><span class="n">suspended_time</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearxEngineXPathException">
 
+<a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineXPathException">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearxEngineXPathException</span><span class="p">(</span><span class="n">SearxEngineResponseException</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Error while getting the result of an XPath expression&quot;&quot;&quot;</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">xpath_spec</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="n">message</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span>
 
+        <span class="c1"># str(xpath_spec) to deal with str and XPath instance</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">xpath_str</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">xpath_spec</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 192 - 0
_modules/searx/extended_types.html
View File 

@@ -0,0 +1,192 @@
 
+<!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.extended_types &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.extended_types</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.extended_types</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;This module implements the type extensions applied by SearXNG.</span>
 
+
 
+<span class="sd">- :py:obj:`flask.request` is replaced by :py:obj:`sxng_request`</span>
 
+<span class="sd">- :py:obj:`flask.Request` is replaced by :py:obj:`SXNG_Request`</span>
 
+<span class="sd">- :py:obj:`httpx.response` is replaced by :py:obj:`SXNG_Response`</span>
 
+
 
+<span class="sd">----</span>
 
+
 
+<span class="sd">.. py:attribute:: sxng_request</span>
 
+<span class="sd">   :type: SXNG_Request</span>
 
+
 
+<span class="sd">   A replacement for :py:obj:`flask.request` with type cast :py:obj:`SXNG_Request`.</span>
 
+
 
+<span class="sd">.. autoclass:: SXNG_Request</span>
 
+<span class="sd">   :members:</span>
 
+
 
+<span class="sd">.. autoclass:: SXNG_Response</span>
 
+<span class="sd">   :members:</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=invalid-name</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;SXNG_Request&quot;</span><span class="p">,</span> <span class="s2">&quot;sxng_request&quot;</span><span class="p">,</span> <span class="s2">&quot;SXNG_Response&quot;</span><span class="p">]</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">flask</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">httpx</span>
 
+
 
+<span class="k">if</span> <span class="n">typing</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">searx.preferences</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">searx.results</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNG_Request">
 
+<a class="viewcode-back" href="../../dev/extended_types.html#searx.extended_types.SXNG_Request">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNG_Request</span><span class="p">(</span><span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;SearXNG extends the class :py:obj:`flask.Request` with properties from</span>
 
+<span class="sd">    *this* class definition, see type cast :py:obj:`sxng_request`.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">user_plugins</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;list of searx.plugins.Plugin.id (the id of the plugins)&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">preferences</span><span class="p">:</span> <span class="s2">&quot;searx.preferences.Preferences&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The prefernces of the request.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">errors</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A list of errors (translated text) added by :py:obj:`searx.webapp` in</span>
 
+<span class="sd">    case of errors.&quot;&quot;&quot;</span>
 
+    <span class="c1"># request.form is of type werkzeug.datastructures.ImmutableMultiDict</span>
 
+    <span class="c1"># form: dict[str, str]</span>
 
+
 
+    <span class="n">start_time</span><span class="p">:</span> <span class="nb">float</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Start time of the request, :py:obj:`timeit.default_timer` added by</span>
 
+<span class="sd">    :py:obj:`searx.webapp` to calculate the total time of the request.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">render_time</span><span class="p">:</span> <span class="nb">float</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Duration of the rendering, calculated and added by</span>
 
+<span class="sd">    :py:obj:`searx.webapp`.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">timings</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="s2">&quot;searx.results.Timing&quot;</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A list of :py:obj:`searx.results.Timing` of the engines, calculatid in</span>
 
+<span class="sd">    and hold by :py:obj:`searx.results.ResultContainer.timings`.&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<span class="c1">#: A replacement for :py:obj:`flask.request` with type cast :py:`SXNG_Request`.</span>
 
+<span class="n">sxng_request</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">flask</span><span class="o">.</span><span class="n">request</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNG_Response">
 
+<a class="viewcode-back" href="../../dev/extended_types.html#searx.extended_types.SXNG_Response">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNG_Response</span><span class="p">(</span><span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;SearXNG extends the class :py:obj:`httpx.Response` with properties from</span>
 
+<span class="sd">    *this* class (type cast of :py:obj:`httpx.Response`).</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">       response = httpx.get(&quot;https://example.org&quot;)</span>
 
+<span class="sd">       response = typing.cast(SXNG_Response, response)</span>
 
+<span class="sd">       if response.ok:</span>
 
+<span class="sd">          ...</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">ok</span><span class="p">:</span> <span class="nb">bool</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 643 - 0
_modules/searx/favicons/cache.html
View File 

@@ -0,0 +1,643 @@
 
+<!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.favicons.cache &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.favicons.cache</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.favicons.cache</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Implementations for caching favicons.</span>
 
+
 
+<span class="sd">:py:obj:`FaviconCacheConfig`:</span>
 
+<span class="sd">  Configuration of the favicon cache</span>
 
+
 
+<span class="sd">:py:obj:`FaviconCache`:</span>
 
+<span class="sd">  Abstract base class for the implementation of a favicon cache.</span>
 
+
 
+<span class="sd">:py:obj:`FaviconCacheSQLite`:</span>
 
+<span class="sd">  Favicon cache that manages the favicon BLOBs in a SQLite DB.</span>
 
+
 
+<span class="sd">:py:obj:`FaviconCacheNull`:</span>
 
+<span class="sd">  Fallback solution if the configured cache cannot be used for system reasons.</span>
 
+
 
+<span class="sd">----</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Literal</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">abc</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">dataclasses</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">hashlib</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">sqlite3</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">tempfile</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">typer</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">msgspec</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">sqlitedb</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.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">humanize_bytes</span><span class="p">,</span> <span class="n">humanize_number</span>
 
+
 
+<span class="n">CACHE</span><span class="p">:</span> <span class="s2">&quot;FaviconCache&quot;</span>
 
+<span class="n">FALLBACK_ICON</span> <span class="o">=</span> <span class="sa">b</span><span class="s2">&quot;FALLBACK_ICON&quot;</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="s1">&#39;favicons.cache&#39;</span><span class="p">)</span>
 
+<span class="n">app</span> <span class="o">=</span> <span class="n">typer</span><span class="o">.</span><span class="n">Typer</span><span class="p">()</span>
 
+
 
+
 
+<div class="viewcode-block" id="state">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.state">[docs]</a>
 
+<span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;show state of the cache&quot;&quot;&quot;</span>
 
+    <span class="nb">print</span><span class="p">(</span><span class="n">CACHE</span><span class="o">.</span><span class="n">state</span><span class="p">()</span><span class="o">.</span><span class="n">report</span><span class="p">())</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="maintenance">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.maintenance">[docs]</a>
 
+<span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="n">force</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">debug</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="w">    </span><span class="sd">&quot;&quot;&quot;perform maintenance of the cache&quot;&quot;&quot;</span>
 
+    <span class="n">root_log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">()</span>
 
+    <span class="k">if</span> <span class="n">debug</span><span class="p">:</span>
 
+        <span class="n">root_log</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">root_log</span><span class="o">.</span><span class="n">handlers</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span>
 
+        <span class="n">handler</span><span class="o">.</span><span class="n">setFormatter</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%(message)s</span><span class="s2">&quot;</span><span class="p">))</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
 
+
 
+    <span class="n">state_t0</span> <span class="o">=</span> <span class="n">CACHE</span><span class="o">.</span><span class="n">state</span><span class="p">()</span>
 
+    <span class="n">CACHE</span><span class="o">.</span><span class="n">maintenance</span><span class="p">(</span><span class="n">force</span><span class="o">=</span><span class="n">force</span><span class="p">)</span>
 
+    <span class="n">state_t1</span> <span class="o">=</span> <span class="n">CACHE</span><span class="o">.</span><span class="n">state</span><span class="p">()</span>
 
+    <span class="n">state_delta</span> <span class="o">=</span> <span class="n">state_t0</span> <span class="o">-</span> <span class="n">state_t1</span>
 
+    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;The cache has been reduced by:&quot;</span><span class="p">)</span>
 
+    <span class="nb">print</span><span class="p">(</span><span class="n">state_delta</span><span class="o">.</span><span class="n">report</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">- </span><span class="si">{descr}</span><span class="s2">: </span><span class="si">{val}</span><span class="s2">&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">))</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="init">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.init">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">cfg</span><span class="p">:</span> <span class="s2">&quot;FaviconCacheConfig&quot;</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialization of a global ``CACHE``&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">global</span> <span class="n">CACHE</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+    <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">db_type</span> <span class="o">==</span> <span class="s2">&quot;sqlite&quot;</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">sqlite_version_info</span> <span class="o">&lt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">35</span><span class="p">):</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
 
+                <span class="s2">&quot;Disable favicon caching completely: SQLite library (</span><span class="si">%s</span><span class="s2">) is too old! (require &gt;= 3.35)&quot;</span><span class="p">,</span>
 
+                <span class="n">sqlite3</span><span class="o">.</span><span class="n">sqlite_version</span><span class="p">,</span>
 
+            <span class="p">)</span>
 
+            <span class="n">CACHE</span> <span class="o">=</span> <span class="n">FaviconCacheNull</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">CACHE</span> <span class="o">=</span> <span class="n">FaviconCacheSQLite</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
 
+    <span class="k">elif</span> <span class="n">cfg</span><span class="o">.</span><span class="n">db_type</span> <span class="o">==</span> <span class="s2">&quot;mem&quot;</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">&quot;Favicons are cached in memory, don&#39;t use this in production!&quot;</span><span class="p">)</span>
 
+        <span class="n">CACHE</span> <span class="o">=</span> <span class="n">FaviconCacheMEM</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;favicons db_type &#39;</span><span class="si">{</span><span class="n">cfg</span><span class="o">.</span><span class="n">db_type</span><span class="si">}</span><span class="s2">&#39; is unknown&quot;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheConfig">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheConfig">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheConfig</span><span class="p">(</span><span class="n">msgspec</span><span class="o">.</span><span class="n">Struct</span><span class="p">):</span>  <span class="c1"># pylint: disable=too-few-public-methods</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Configuration of the favicon cache.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">db_type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;sqlite&quot;</span><span class="p">,</span> <span class="s2">&quot;mem&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;sqlite&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Type of the database:</span>
 
+
 
+<span class="sd">    ``sqlite``:</span>
 
+<span class="sd">      :py:obj:`.cache.FaviconCacheSQLite`</span>
 
+
 
+<span class="sd">    ``mem``:</span>
 
+<span class="sd">      :py:obj:`.cache.FaviconCacheMEM` (not recommended)</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">db_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">gettempdir</span><span class="p">()</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="s2">&quot;faviconcache.db&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;URL of the SQLite DB, the path to the database file.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">HOLD_TIME</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">30</span>  <span class="c1"># 30 days</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Hold time (default in sec.), after which a BLOB is removed from the cache.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">LIMIT_TOTAL_BYTES</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">50</span>  <span class="c1"># 50 MB</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Maximum of bytes (default) stored in the cache of all blobs.  Note: The</span>
 
+<span class="sd">    limit is only reached at each maintenance interval after which the oldest</span>
 
+<span class="sd">    BLOBs are deleted; the limit is exceeded during the maintenance period. If</span>
 
+<span class="sd">    the maintenance period is *too long* or maintenance is switched off</span>
 
+<span class="sd">    completely, the cache grows uncontrollably.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">BLOB_MAX_BYTES</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">20</span>  <span class="c1"># 20 KB</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The maximum BLOB size in bytes that a favicon may have so that it can be</span>
 
+<span class="sd">    saved in the cache.  If the favicon is larger, it is not saved in the cache</span>
 
+<span class="sd">    and must be requested by the client via the proxy.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">MAINTENANCE_PERIOD</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Maintenance period in seconds / when :py:obj:`MAINTENANCE_MODE` is set to</span>
 
+<span class="sd">    ``auto``.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">MAINTENANCE_MODE</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;auto&quot;</span><span class="p">,</span> <span class="s2">&quot;off&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;auto&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Type of maintenance mode</span>
 
+
 
+<span class="sd">    ``auto``:</span>
 
+<span class="sd">      Maintenance is carried out automatically as part of the maintenance</span>
 
+<span class="sd">      intervals (:py:obj:`MAINTENANCE_PERIOD`); no external process is required.</span>
 
+
 
+<span class="sd">    ``off``:</span>
 
+<span class="sd">      Maintenance is switched off and must be carried out by an external process</span>
 
+<span class="sd">      if required.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheStats">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheStats">[docs]</a>
 
+<span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheStats</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Dataclass wich provides information on the status of the cache.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">favicons</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="nb">bytes</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">domains</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">resolvers</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+    <span class="n">field_descr</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="p">(</span><span class="s2">&quot;favicons&quot;</span><span class="p">,</span> <span class="s2">&quot;number of favicons in cache&quot;</span><span class="p">,</span> <span class="n">humanize_number</span><span class="p">),</span>
 
+        <span class="p">(</span><span class="s2">&quot;bytes&quot;</span><span class="p">,</span> <span class="s2">&quot;total size (approx. bytes) of cache&quot;</span><span class="p">,</span> <span class="n">humanize_bytes</span><span class="p">),</span>
 
+        <span class="p">(</span><span class="s2">&quot;domains&quot;</span><span class="p">,</span> <span class="s2">&quot;total number of domains in cache&quot;</span><span class="p">,</span> <span class="n">humanize_number</span><span class="p">),</span>
 
+        <span class="p">(</span><span class="s2">&quot;resolvers&quot;</span><span class="p">,</span> <span class="s2">&quot;number of resolvers&quot;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__sub__</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="o">-&gt;</span> <span class="n">FaviconCacheStats</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">):</span>
 
+            <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;unsupported operand type(s) for +: &#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="si">}</span><span class="s2">&#39; and &#39;</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">other</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
 
+        <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
 
+        <span class="k">for</span> <span class="n">field</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">field_descr</span><span class="p">:</span>
 
+            <span class="n">self_val</span><span class="p">,</span> <span class="n">other_val</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">),</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">field</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="kc">None</span> <span class="ow">in</span> <span class="p">(</span><span class="n">self_val</span><span class="p">,</span> <span class="n">other_val</span><span class="p">):</span>
 
+                <span class="k">continue</span>
 
+            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">self_val</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
 
+                <span class="n">kwargs</span><span class="p">[</span><span class="n">field</span><span class="p">]</span> <span class="o">=</span> <span class="n">self_val</span> <span class="o">-</span> <span class="n">other_val</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">kwargs</span><span class="p">[</span><span class="n">field</span><span class="p">]</span> <span class="o">=</span> <span class="n">self_val</span>
 
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">report</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fmt</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{descr}</span><span class="s2">: </span><span class="si">{val}</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">):</span>
 
+        <span class="n">s</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="k">for</span> <span class="n">field</span><span class="p">,</span> <span class="n">descr</span><span class="p">,</span> <span class="n">cast</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">field_descr</span><span class="p">:</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="n">val</span> <span class="o">=</span> <span class="s2">&quot;--&quot;</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">val</span> <span class="o">=</span> <span class="n">cast</span><span class="p">(</span><span class="n">val</span><span class="p">)</span>
 
+            <span class="n">s</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fmt</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">descr</span><span class="o">=</span><span class="n">descr</span><span class="p">,</span> <span class="n">val</span><span class="o">=</span><span class="n">val</span><span class="p">))</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCache">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCache">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FaviconCache</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Abstract base class for the implementation of a favicon cache.&quot;&quot;&quot;</span>
 
+
 
+    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</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">cfg</span><span class="p">:</span> <span class="n">FaviconCacheConfig</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;An instance of the favicon cache is build up from the configuration.&quot;&quot;&quot;</span>
 
+
 
+    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns ``None`` or the tuple of ``(data, mime)`` that has been</span>
 
+<span class="sd">        registered in the cache.  The ``None`` indicates that there was no entry</span>
 
+<span class="sd">        in the cache.&quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="FaviconCache.set">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCache.set">[docs]</a>
 
+    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mime</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="n">data</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Set data and mime-type in the cache.  If data is None, the</span>
 
+<span class="sd">        :py:obj:`FALLBACK_ICON` is registered. in the cache.&quot;&quot;&quot;</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCache.state">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCache.state">[docs]</a>
 
+    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FaviconCacheStats</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a :py:obj:`FaviconCacheStats` (key/values) with information</span>
 
+<span class="sd">        on the state of the cache.&quot;&quot;&quot;</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCache.maintenance">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCache.maintenance">[docs]</a>
 
+    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Performs maintenance on the cache&quot;&quot;&quot;</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheNull">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheNull">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheNull</span><span class="p">(</span><span class="n">FaviconCache</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A dummy favicon cache that caches nothing / a fallback solution. The</span>
 
+<span class="sd">    NullCache is used when more efficient caches such as the</span>
 
+<span class="sd">    :py:obj:`FaviconCacheSQLite` cannot be used because, for example, the SQLite</span>
 
+<span class="sd">    library is only available in an old version and does not meet the</span>
 
+<span class="sd">    requirements.&quot;&quot;&quot;</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">cfg</span><span class="p">:</span> <span class="n">FaviconCacheConfig</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+<div class="viewcode-block" id="FaviconCacheNull.set">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheNull.set">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mime</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="n">data</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">False</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheNull.state">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheNull.state">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">FaviconCacheStats</span><span class="p">(</span><span class="n">favicons</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheNull.maintenance">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheNull.maintenance">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 
+        <span class="k">pass</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheSQLite">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheSQLite">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheSQLite</span><span class="p">(</span><span class="n">sqlitedb</span><span class="o">.</span><span class="n">SQLiteAppl</span><span class="p">,</span> <span class="n">FaviconCache</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Favicon cache that manages the favicon BLOBs in a SQLite DB.  The DB</span>
 
+<span class="sd">    model in the SQLite DB is implemented using the abstract class</span>
 
+<span class="sd">    :py:obj:`sqlitedb.SQLiteAppl`.</span>
 
+
 
+<span class="sd">    The following configurations are required / supported:</span>
 
+
 
+<span class="sd">    - :py:obj:`FaviconCacheConfig.db_url`</span>
 
+<span class="sd">    - :py:obj:`FaviconCacheConfig.HOLD_TIME`</span>
 
+<span class="sd">    - :py:obj:`FaviconCacheConfig.LIMIT_TOTAL_BYTES`</span>
 
+<span class="sd">    - :py:obj:`FaviconCacheConfig.BLOB_MAX_BYTES`</span>
 
+<span class="sd">    - :py:obj:`MAINTENANCE_PERIOD`</span>
 
+<span class="sd">    - :py:obj:`MAINTENANCE_MODE`</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">DB_SCHEMA</span> <span class="o">=</span> <span class="mi">1</span>
 
+
 
+    <span class="n">DDL_BLOBS</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
 
+<span class="s2">CREATE TABLE IF NOT EXISTS blobs (</span>
 
+<span class="s2">  sha256     TEXT,</span>
 
+<span class="s2">  bytes_c    INTEGER,</span>
 
+<span class="s2">  mime       TEXT NOT NULL,</span>
 
+<span class="s2">  data       BLOB NOT NULL,</span>
 
+<span class="s2">  PRIMARY KEY (sha256))&quot;&quot;&quot;</span>
 
+
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Table to store BLOB objects by their sha256 hash values.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">DDL_BLOB_MAP</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
 
+<span class="s2">CREATE TABLE IF NOT EXISTS blob_map (</span>
 
+<span class="s2">    m_time     INTEGER DEFAULT (strftime(&#39;</span><span class="si">%s</span><span class="s2">&#39;, &#39;now&#39;)),  -- last modified (unix epoch) time in sec.</span>
 
+<span class="s2">    sha256     TEXT,</span>
 
+<span class="s2">    resolver   TEXT,</span>
 
+<span class="s2">    authority  TEXT,</span>
 
+<span class="s2">    PRIMARY KEY (resolver, authority))&quot;&quot;&quot;</span>
 
+
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Table to map from (resolver, authority) to sha256 hash values.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">DDL_CREATE_TABLES</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="s2">&quot;blobs&quot;</span><span class="p">:</span> <span class="n">DDL_BLOBS</span><span class="p">,</span>
 
+        <span class="s2">&quot;blob_map&quot;</span><span class="p">:</span> <span class="n">DDL_BLOB_MAP</span><span class="p">,</span>
 
+    <span class="p">}</span>
 
+
 
+    <span class="n">SQL_DROP_LEFTOVER_BLOBS</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s2">&quot;DELETE FROM blobs WHERE sha256 IN (&quot;</span>
 
+        <span class="s2">&quot; SELECT b.sha256&quot;</span>
 
+        <span class="s2">&quot;   FROM blobs b&quot;</span>
 
+        <span class="s2">&quot;   LEFT JOIN blob_map bm&quot;</span>
 
+        <span class="s2">&quot;     ON b.sha256 = bm.sha256&quot;</span>
 
+        <span class="s2">&quot;  WHERE bm.sha256 IS NULL)&quot;</span>
 
+    <span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Delete blobs.sha256 (BLOBs) no longer in blob_map.sha256.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">SQL_ITER_BLOBS_SHA256_BYTES_C</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s2">&quot;SELECT b.sha256, b.bytes_c FROM blobs b&quot;</span>
 
+        <span class="s2">&quot;  JOIN blob_map bm &quot;</span>
 
+        <span class="s2">&quot;    ON b.sha256 = bm.sha256&quot;</span>
 
+        <span class="s2">&quot; ORDER BY bm.m_time ASC&quot;</span>
 
+    <span class="p">)</span>
 
+
 
+    <span class="n">SQL_INSERT_BLOBS</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s2">&quot;INSERT INTO blobs (sha256, bytes_c, mime, data) VALUES (?, ?, ?, ?)&quot;</span>
 
+        <span class="s2">&quot;    ON CONFLICT (sha256) DO NOTHING&quot;</span>
 
+    <span class="p">)</span>  <span class="c1"># fmt: skip</span>
 
+
 
+    <span class="n">SQL_INSERT_BLOB_MAP</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s2">&quot;INSERT INTO blob_map (sha256, resolver, authority) VALUES (?, ?, ?)&quot;</span>
 
+        <span class="s2">&quot;    ON CONFLICT DO UPDATE &quot;</span>
 
+        <span class="s2">&quot;   SET sha256=excluded.sha256, m_time=strftime(&#39;</span><span class="si">%s</span><span class="s2">&#39;, &#39;now&#39;)&quot;</span>
 
+    <span class="p">)</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">cfg</span><span class="p">:</span> <span class="n">FaviconCacheConfig</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;An instance of the favicon cache is build up from the configuration.&quot;&quot;&quot;</span>  <span class="c1">#</span>
 
+
 
+        <span class="k">if</span> <span class="n">cfg</span><span class="o">.</span><span class="n">db_url</span> <span class="o">==</span> <span class="s2">&quot;:memory:&quot;</span><span class="p">:</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="s2">&quot;don&#39;t use SQLite DB in :memory: in production!!&quot;</span><span class="p">)</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">db_url</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
 
+
 
+        <span class="n">sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT sha256 FROM blob_map WHERE resolver = ? AND authority = ?&quot;</span>
 
+        <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">))</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">res</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">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="n">sha256</span> <span class="o">=</span> <span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="n">sha256</span> <span class="o">==</span> <span class="n">FALLBACK_ICON</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span>
 
+
 
+        <span class="n">sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT data, mime FROM blobs WHERE sha256 = ?&quot;</span>
 
+        <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="p">(</span><span class="n">sha256</span><span class="p">,))</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="n">res</span>
 
+        <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span>
 
+
 
+<div class="viewcode-block" id="FaviconCacheSQLite.set">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheSQLite.set">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mime</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="n">data</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</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">cfg</span><span class="o">.</span><span class="n">MAINTENANCE_MODE</span> <span class="o">==</span> <span class="s2">&quot;auto&quot;</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">next_maintenance_time</span><span class="p">:</span>
 
+            <span class="c1"># Should automatic maintenance be moved to a new thread?</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">maintenance</span><span class="p">()</span>
 
+
 
+        <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">mime</span> <span class="ow">is</span> <span class="kc">None</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">&quot;favicon resolver </span><span class="si">%s</span><span class="s2"> tries to cache mime-type None for authority </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span>
 
+                <span class="n">resolver</span><span class="p">,</span>
 
+                <span class="n">authority</span><span class="p">,</span>
 
+            <span class="p">)</span>
 
+            <span class="k">return</span> <span class="kc">False</span>
 
+
 
+        <span class="n">bytes_c</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span> <span class="ow">or</span> <span class="sa">b</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">bytes_c</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">BLOB_MAX_BYTES</span><span class="p">:</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
 
+                <span class="s2">&quot;favicon of resolver: </span><span class="si">%s</span><span class="s2"> / authority: </span><span class="si">%s</span><span class="s2"> to big to cache (bytes: </span><span class="si">%s</span><span class="s2">) &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">,</span> <span class="n">bytes_c</span><span class="p">)</span>
 
+            <span class="p">)</span>
 
+            <span class="k">return</span> <span class="kc">False</span>
 
+
 
+        <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">sha256</span> <span class="o">=</span> <span class="n">FALLBACK_ICON</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">sha256</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">data</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
 
+
 
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">sha256</span> <span class="o">!=</span> <span class="n">FALLBACK_ICON</span><span class="p">:</span>
 
+                <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_INSERT_BLOBS</span><span class="p">,</span> <span class="p">(</span><span class="n">sha256</span><span class="p">,</span> <span class="n">bytes_c</span><span class="p">,</span> <span class="n">mime</span><span class="p">,</span> <span class="n">data</span><span class="p">))</span>
 
+            <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_INSERT_BLOB_MAP</span><span class="p">,</span> <span class="p">(</span><span class="n">sha256</span><span class="p">,</span> <span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">))</span>
 
+
 
+        <span class="k">return</span> <span class="kc">True</span></div>
 
+
 
+
 
+    <span class="nd">@property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">next_maintenance_time</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns (unix epoch) time of the next maintenance.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">MAINTENANCE_PERIOD</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">m_time</span><span class="p">(</span><span class="s2">&quot;LAST_MAINTENANCE&quot;</span><span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="FaviconCacheSQLite.maintenance">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheSQLite.maintenance">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 
+
 
+        <span class="c1"># Prevent parallel DB maintenance cycles from other DB connections</span>
 
+        <span class="c1"># (e.g. in multi thread or process environments).</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">force</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">next_maintenance_time</span><span class="p">:</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;no maintenance required yet, next maintenance interval is in the future&quot;</span><span class="p">)</span>
 
+            <span class="k">return</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;LAST_MAINTENANCE&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>  <span class="c1"># hint: this (also) sets the m_time of the property!</span>
 
+
 
+        <span class="c1"># do maintenance tasks</span>
 
+
 
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
 
+
 
+            <span class="c1"># drop items not in HOLD time</span>
 
+            <span class="n">res</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
 
+                <span class="sa">f</span><span class="s2">&quot;DELETE FROM blob_map&quot;</span>
 
+                <span class="sa">f</span><span class="s2">&quot; WHERE cast(m_time as integer) &lt; cast(strftime(&#39;%s&#39;, &#39;now&#39;) as integer) - </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">HOLD_TIME</span><span class="si">}</span><span class="s2">&quot;</span>
 
+            <span class="p">)</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;dropped </span><span class="si">%s</span><span class="s2"> obsolete blob_map items from db&quot;</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">rowcount</span><span class="p">)</span>
 
+            <span class="n">res</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_DROP_LEFTOVER_BLOBS</span><span class="p">)</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;dropped </span><span class="si">%s</span><span class="s2"> obsolete BLOBS from db&quot;</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">rowcount</span><span class="p">)</span>
 
+
 
+            <span class="c1"># drop old items to be in LIMIT_TOTAL_BYTES</span>
 
+            <span class="n">total_bytes</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;SELECT SUM(bytes_c) FROM blobs&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">or</span> <span class="mi">0</span>
 
+            <span class="k">if</span> <span class="n">total_bytes</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">LIMIT_TOTAL_BYTES</span><span class="p">:</span>
 
+
 
+                <span class="n">x</span> <span class="o">=</span> <span class="n">total_bytes</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">LIMIT_TOTAL_BYTES</span>
 
+                <span class="n">c</span> <span class="o">=</span> <span class="mi">0</span>
 
+                <span class="n">sha_list</span> <span class="o">=</span> <span class="p">[]</span>
 
+                <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_ITER_BLOBS_SHA256_BYTES_C</span><span class="p">):</span>
 
+                    <span class="n">sha256</span><span class="p">,</span> <span class="n">bytes_c</span> <span class="o">=</span> <span class="n">row</span>
 
+                    <span class="n">sha_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sha256</span><span class="p">)</span>
 
+                    <span class="n">c</span> <span class="o">+=</span> <span class="n">bytes_c</span>
 
+                    <span class="k">if</span> <span class="n">c</span> <span class="o">&gt;</span> <span class="n">x</span><span class="p">:</span>
 
+                        <span class="k">break</span>
 
+                <span class="k">if</span> <span class="n">sha_list</span><span class="p">:</span>
 
+                    <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;DELETE FROM blobs WHERE sha256 IN (&#39;</span><span class="si">%s</span><span class="s2">&#39;)&quot;</span> <span class="o">%</span> <span class="s2">&quot;&#39;,&#39;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sha_list</span><span class="p">))</span>
 
+                    <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;DELETE FROM blob_map WHERE sha256 IN (&#39;</span><span class="si">%s</span><span class="s2">&#39;)&quot;</span> <span class="o">%</span> <span class="s2">&quot;&#39;,&#39;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sha_list</span><span class="p">))</span>
 
+                    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;dropped </span><span class="si">%s</span><span class="s2"> blobs with total size of </span><span class="si">%s</span><span class="s2"> bytes&quot;</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">sha_list</span><span class="p">),</span> <span class="n">c</span><span class="p">)</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_query_val</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+        <span class="n">val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="n">val</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="n">default</span>
 
+        <span class="k">return</span> <span class="n">val</span>
 
+
 
+<div class="viewcode-block" id="FaviconCacheSQLite.state">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheSQLite.state">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FaviconCacheStats</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">FaviconCacheStats</span><span class="p">(</span>
 
+            <span class="n">favicons</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_val</span><span class="p">(</span><span class="s2">&quot;SELECT count(*) FROM blobs&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
 
+            <span class="nb">bytes</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_val</span><span class="p">(</span><span class="s2">&quot;SELECT SUM(bytes_c) FROM blobs&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
 
+            <span class="n">domains</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_val</span><span class="p">(</span><span class="s2">&quot;SELECT count(*) FROM (SELECT authority FROM blob_map GROUP BY authority)&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
 
+            <span class="n">resolvers</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_query_val</span><span class="p">(</span><span class="s2">&quot;SELECT count(*) FROM (SELECT resolver FROM blob_map GROUP BY resolver)&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
 
+        <span class="p">)</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheMEM">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheMEM">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FaviconCacheMEM</span><span class="p">(</span><span class="n">FaviconCache</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Favicon cache in process&#39; memory.  Its just a POC that stores the</span>
 
+<span class="sd">    favicons in the memory of the process.</span>
 
+
 
+<span class="sd">    .. attention::</span>
 
+
 
+<span class="sd">       Don&#39;t use it in production, it will blow up your memory!!</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</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">cfg</span><span class="p">):</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_data</span> <span class="o">=</span> <span class="p">{}</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_sha_mime</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</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="n">sha</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sha_mime</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">resolver</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">authority</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="n">sha</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">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sha</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">data</span> <span class="o">==</span> <span class="n">FALLBACK_ICON</span><span class="p">:</span>
 
+            <span class="n">data</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span>
 
+
 
+<div class="viewcode-block" id="FaviconCacheMEM.set">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheMEM.set">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mime</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="n">data</span><span class="p">:</span> <span class="nb">bytes</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+
 
+        <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">data</span> <span class="o">=</span> <span class="n">FALLBACK_ICON</span>
 
+            <span class="n">mime</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+        <span class="k">elif</span> <span class="n">mime</span> <span class="ow">is</span> <span class="kc">None</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">&quot;favicon resolver </span><span class="si">%s</span><span class="s2"> tries to cache mime-type None for authority </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span>
 
+                <span class="n">resolver</span><span class="p">,</span>
 
+                <span class="n">authority</span><span class="p">,</span>
 
+            <span class="p">)</span>
 
+            <span class="k">return</span> <span class="kc">False</span>
 
+
 
+        <span class="n">digest</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">data</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="p">[</span><span class="n">digest</span><span class="p">]</span> <span class="o">=</span> <span class="n">data</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_sha_mime</span><span class="p">[</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">resolver</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">authority</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">digest</span><span class="p">,</span> <span class="n">mime</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="kc">True</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheMEM.state">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheMEM.state">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">FaviconCacheStats</span><span class="p">(</span><span class="n">favicons</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_data</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconCacheMEM.maintenance">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.cache.FaviconCacheMEM.maintenance">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">maintenance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 
+        <span class="k">pass</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 175 - 0
_modules/searx/favicons/config.html
View File 

@@ -0,0 +1,175 @@
 
+<!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.favicons.config &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.favicons.config</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.favicons.config</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">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">pathlib</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">msgspec</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.cache</span><span class="w"> </span><span class="kn">import</span> <span class="n">FaviconCacheConfig</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.proxy</span><span class="w"> </span><span class="kn">import</span> <span class="n">FaviconProxyConfig</span>
 
+
 
+<span class="n">CONFIG_SCHEMA</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span>
 
+<span class="sd">&quot;&quot;&quot;Version of the configuration schema.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">TOML_CACHE_CFG</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="s2">&quot;FaviconConfig&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="sd">&quot;&quot;&quot;Cache config objects by TOML&#39;s filename.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">DEFAULT_CFG_TOML_PATH</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="s2">&quot;favicons.toml&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconConfig">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.config.FaviconConfig">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FaviconConfig</span><span class="p">(</span><span class="n">msgspec</span><span class="o">.</span><span class="n">Struct</span><span class="p">):</span>  <span class="c1"># pylint: disable=too-few-public-methods</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The class aggregates configurations of the favicon tools&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">cfg_schema</span><span class="p">:</span> <span class="nb">int</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Config&#39;s schema version.  The specification of the version of the schema</span>
 
+<span class="sd">    is mandatory, currently only version :py:obj:`CONFIG_SCHEMA` is supported.</span>
 
+<span class="sd">    By specifying a version, it is possible to ensure downward compatibility in</span>
 
+<span class="sd">    the event of future changes to the configuration schema&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">cache</span><span class="p">:</span> <span class="n">FaviconCacheConfig</span> <span class="o">=</span> <span class="n">msgspec</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="n">FaviconCacheConfig</span><span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Setup of the :py:obj:`.cache.FaviconCacheConfig`.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">proxy</span><span class="p">:</span> <span class="n">FaviconProxyConfig</span> <span class="o">=</span> <span class="n">msgspec</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="n">FaviconProxyConfig</span><span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Setup of the :py:obj:`.proxy.FaviconProxyConfig`.&quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="FaviconConfig.from_toml_file">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.config.FaviconConfig.from_toml_file">[docs]</a>
 
+    <span class="nd">@classmethod</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">from_toml_file</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">use_cache</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;FaviconConfig&quot;</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Create a config object from a TOML file, the ``use_cache`` argument</span>
 
+<span class="sd">        specifies whether a cache should be used.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="n">cached</span> <span class="o">=</span> <span class="n">TOML_CACHE_CFG</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">cfg_file</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="n">use_cache</span> <span class="ow">and</span> <span class="n">cached</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">cached</span>
 
+
 
+        <span class="k">with</span> <span class="n">cfg_file</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;rb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
 
+            <span class="n">data</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
 
+
 
+        <span class="n">cfg</span> <span class="o">=</span> <span class="n">msgspec</span><span class="o">.</span><span class="n">toml</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="n">_FaviconConfig</span><span class="p">)</span>
 
+        <span class="n">schema</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">favicons</span><span class="o">.</span><span class="n">cfg_schema</span>
 
+        <span class="k">if</span> <span class="n">schema</span> <span class="o">!=</span> <span class="n">CONFIG_SCHEMA</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
 
+                <span class="sa">f</span><span class="s2">&quot;config schema version </span><span class="si">{</span><span class="n">CONFIG_SCHEMA</span><span class="si">}</span><span class="s2"> is needed, version </span><span class="si">{</span><span class="n">schema</span><span class="si">}</span><span class="s2"> is given in </span><span class="si">{</span><span class="n">cfg_file</span><span class="si">}</span><span class="s2">&quot;</span>
 
+            <span class="p">)</span>
 
+
 
+        <span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">favicons</span>
 
+        <span class="k">if</span> <span class="n">use_cache</span> <span class="ow">and</span> <span class="n">cached</span><span class="p">:</span>
 
+            <span class="n">TOML_CACHE_CFG</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">cfg_file</span><span class="o">.</span><span class="n">resolve</span><span class="p">())]</span> <span class="o">=</span> <span class="n">cfg</span>
 
+
 
+        <span class="k">return</span> <span class="n">cfg</span></div>
 
+</div>
 
+
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">_FaviconConfig</span><span class="p">(</span><span class="n">msgspec</span><span class="o">.</span><span class="n">Struct</span><span class="p">):</span>  <span class="c1"># pylint: disable=too-few-public-methods</span>
 
+    <span class="c1"># wrapper struct for root object &quot;favicons.&quot;</span>
 
+    <span class="n">favicons</span><span class="p">:</span> <span class="n">FaviconConfig</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 363 - 0
_modules/searx/favicons/proxy.html
View File 

@@ -0,0 +1,363 @@
 
+<!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.favicons.proxy &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.favicons.proxy</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.favicons.proxy</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Implementations for a favicon proxy&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Callable</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">importlib</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">base64</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">pathlib</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">urllib.parse</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">httpx</span><span class="w"> </span><span class="kn">import</span> <span class="n">HTTPError</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">msgspec</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.webutils</span><span class="w"> </span><span class="kn">import</span> <span class="n">new_hmac</span><span class="p">,</span> <span class="n">is_hmac_of</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">SearxEngineResponseException</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">sxng_request</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.resolvers</span><span class="w"> </span><span class="kn">import</span> <span class="n">DEFAULT_RESOLVER_MAP</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">cache</span>
 
+
 
+<span class="n">DEFAULT_FAVICON_URL</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="n">CFG</span><span class="p">:</span> <span class="n">FaviconProxyConfig</span> <span class="o">=</span> <span class="kc">None</span>  <span class="c1"># type: ignore</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">cfg</span><span class="p">:</span> <span class="n">FaviconProxyConfig</span><span class="p">):</span>
 
+    <span class="k">global</span> <span class="n">CFG</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+    <span class="n">CFG</span> <span class="o">=</span> <span class="n">cfg</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_initial_resolver_map</span><span class="p">():</span>
 
+    <span class="n">d</span> <span class="o">=</span> <span class="p">{}</span>
 
+    <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">&quot;search.favicon_resolver&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="k">if</span> <span class="n">name</span><span class="p">:</span>
 
+        <span class="n">func</span> <span class="o">=</span> <span class="n">DEFAULT_RESOLVER_MAP</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">func</span><span class="p">:</span>
 
+            <span class="n">d</span> <span class="o">=</span> <span class="p">{</span><span class="n">name</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;searx.favicons.resolvers.</span><span class="si">{</span><span class="n">func</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">}</span>
 
+    <span class="k">return</span> <span class="n">d</span>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconProxyConfig">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.FaviconProxyConfig">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">FaviconProxyConfig</span><span class="p">(</span><span class="n">msgspec</span><span class="o">.</span><span class="n">Struct</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Configuration of the favicon proxy.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">max_age</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">7</span>  <span class="c1"># seven days</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;HTTP header Cache-Control_ ``max-age``</span>
 
+
 
+<span class="sd">    .. _Cache-Control: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">secret_key</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">&quot;server.secret_key&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;By default, the value from :ref:`server.secret_key &lt;settings server&gt;`</span>
 
+<span class="sd">    setting is used.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">resolver_timeout</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">&quot;outgoing.request_timeout&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Timeout which the resolvers should not exceed, is usually passed to the</span>
 
+<span class="sd">    outgoing request of the resolver.  By default, the value from</span>
 
+<span class="sd">    :ref:`outgoing.request_timeout &lt;settings outgoing&gt;` setting is used.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">resolver_map</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="n">msgspec</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="n">_initial_resolver_map</span><span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The resolver_map is a key / value dictionary where the key is the name of</span>
 
+<span class="sd">    the resolver and the value is the fully qualifying name (fqn) of resolver&#39;s</span>
 
+<span class="sd">    function (the callable).  The resolvers from the python module</span>
 
+<span class="sd">    :py:obj:`searx.favicons.resolver` are available by default.&quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="FaviconProxyConfig.get_resolver">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.FaviconProxyConfig.get_resolver">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_resolver</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="o">-&gt;</span> <span class="n">Callable</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the callable object (function) of the resolver with the</span>
 
+<span class="sd">        ``name``.  If no resolver is registered for the ``name``, ``None`` is</span>
 
+<span class="sd">        returned.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="n">fqn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">resolver_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">fqn</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">mod_name</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">func_name</span> <span class="o">=</span> <span class="n">fqn</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)</span>
 
+        <span class="n">mod</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="n">mod_name</span><span class="p">)</span>
 
+        <span class="n">func</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">func_name</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">func</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;resolver </span><span class="si">{</span><span class="n">fqn</span><span class="si">}</span><span class="s2"> is not implemented&quot;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">func</span></div>
 
+
 
+
 
+    <span class="n">favicon_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">&quot;ui.static_path&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;/themes/</span><span class="si">{theme}</span><span class="s2">/img/empty_favicon.svg&quot;</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">favicon_mime_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;image/svg+xml&quot;</span>
 
+
 
+<div class="viewcode-block" id="FaviconProxyConfig.favicon">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.FaviconProxyConfig.favicon">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">favicon</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">replacements</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns pathname and mimetype of the default favicon.&quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="p">(</span>
 
+            <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">favicon_path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">replacements</span><span class="p">)),</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">favicon_mime_type</span><span class="p">,</span>
 
+        <span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="FaviconProxyConfig.favicon_data_url">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.FaviconProxyConfig.favicon_data_url">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">favicon_data_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">replacements</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns data image URL of the default favicon.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">cache_key</span> <span class="o">=</span> <span class="s2">&quot;, &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">x</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">replacements</span><span class="p">[</span><span class="n">x</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">replacements</span><span class="o">.</span><span class="n">keys</span><span class="p">()),</span> <span class="n">key</span><span class="o">=</span><span class="nb">str</span><span class="p">))</span>
 
+        <span class="n">data_url</span> <span class="o">=</span> <span class="n">DEFAULT_FAVICON_URL</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">cache_key</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">data_url</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">data_url</span>
 
+
 
+        <span class="n">fav</span><span class="p">,</span> <span class="n">mimetype</span> <span class="o">=</span> <span class="n">CFG</span><span class="o">.</span><span class="n">favicon</span><span class="p">(</span><span class="o">**</span><span class="n">replacements</span><span class="p">)</span>
 
+        <span class="c1"># hint: encoding utf-8 limits favicons to be a SVG image</span>
 
+        <span class="k">with</span> <span class="n">fav</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
 
+            <span class="n">data_url</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
 
+
 
+        <span class="n">data_url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">quote</span><span class="p">(</span><span class="n">data_url</span><span class="p">)</span>
 
+        <span class="n">data_url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;data:</span><span class="si">{</span><span class="n">mimetype</span><span class="si">}</span><span class="s2">;utf8,</span><span class="si">{</span><span class="n">data_url</span><span class="si">}</span><span class="s2">&quot;</span>
 
+        <span class="n">DEFAULT_FAVICON_URL</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">data_url</span>
 
+        <span class="k">return</span> <span class="n">data_url</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="favicon_proxy">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.favicon_proxy">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">favicon_proxy</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;REST API of SearXNG&#39;s favicon proxy service</span>
 
+
 
+<span class="sd">    ::</span>
 
+
 
+<span class="sd">        /favicon_proxy?authority=&lt;...&gt;&amp;h=&lt;...&gt;</span>
 
+
 
+<span class="sd">    ``authority``:</span>
 
+<span class="sd">      Domain name :rfc:`3986` / see :py:obj:`favicon_url`</span>
 
+
 
+<span class="sd">    ``h``:</span>
 
+<span class="sd">      HMAC :rfc:`2104`, build up from the :ref:`server.secret_key &lt;settings</span>
 
+<span class="sd">      server&gt;` setting.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">authority</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;authority&#39;</span><span class="p">)</span>
 
+
 
+    <span class="c1"># malformed request or RFC 3986 authority</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">authority</span> <span class="ow">or</span> <span class="s2">&quot;/&quot;</span> <span class="ow">in</span> <span class="n">authority</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">400</span>
 
+
 
+    <span class="c1"># malformed request / does not have authorisation</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">is_hmac_of</span><span class="p">(</span>
 
+        <span class="n">CFG</span><span class="o">.</span><span class="n">secret_key</span><span class="p">,</span>
 
+        <span class="n">authority</span><span class="o">.</span><span class="n">encode</span><span class="p">(),</span>
 
+        <span class="n">sxng_request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;h&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
 
+    <span class="p">):</span>
 
+        <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">400</span>
 
+
 
+    <span class="n">resolver</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s1">&#39;favicon_resolver&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="c1"># if resolver is empty or not valid, just return HTTP 400.</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resolver</span> <span class="ow">or</span> <span class="n">resolver</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">CFG</span><span class="o">.</span><span class="n">resolver_map</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="mi">400</span>
 
+
 
+    <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="n">search_favicon</span><span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">mime</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">resp</span> <span class="o">=</span> <span class="n">flask</span><span class="o">.</span><span class="n">Response</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">mimetype</span><span class="o">=</span><span class="n">mime</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">resp</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Cache-Control&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;max-age=</span><span class="si">{</span><span class="n">CFG</span><span class="o">.</span><span class="n">max_age</span><span class="si">}</span><span class="s2">&quot;</span>
 
+        <span class="k">return</span> <span class="n">resp</span>
 
+
 
+    <span class="c1"># return default favicon from static path</span>
 
+    <span class="n">theme</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s2">&quot;theme&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="n">fav</span><span class="p">,</span> <span class="n">mimetype</span> <span class="o">=</span> <span class="n">CFG</span><span class="o">.</span><span class="n">favicon</span><span class="p">(</span><span class="n">theme</span><span class="o">=</span><span class="n">theme</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">flask</span><span class="o">.</span><span class="n">send_from_directory</span><span class="p">(</span><span class="n">fav</span><span class="o">.</span><span class="n">parent</span><span class="p">,</span> <span class="n">fav</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">mimetype</span><span class="o">=</span><span class="n">mimetype</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="search_favicon">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.search_favicon">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">search_favicon</span><span class="p">(</span><span class="n">resolver</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Sends the request to the favicon resolver and returns a tuple for the</span>
 
+<span class="sd">    favicon.  The tuple consists of ``(data, mime)``, if the resolver has not</span>
 
+<span class="sd">    determined a favicon, both values are ``None``.</span>
 
+
 
+<span class="sd">    ``data``:</span>
 
+<span class="sd">      Binary data of the favicon.</span>
 
+
 
+<span class="sd">    ``mime``:</span>
 
+<span class="sd">      Mime type of the favicon.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+    <span class="n">func</span> <span class="o">=</span> <span class="n">CFG</span><span class="o">.</span><span class="n">get_resolver</span><span class="p">(</span><span class="n">resolver</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">func</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span>
 
+
 
+    <span class="c1"># to avoid superfluous requests to the resolver, first look in the cache</span>
 
+    <span class="n">data_mime</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">CACHE</span><span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">data_mime</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">data_mime</span>
 
+
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">authority</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">CFG</span><span class="o">.</span><span class="n">resolver_timeout</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">mime</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+    <span class="k">except</span> <span class="p">(</span><span class="n">HTTPError</span><span class="p">,</span> <span class="n">SearxEngineResponseException</span><span class="p">):</span>
 
+        <span class="k">pass</span>
 
+
 
+    <span class="n">cache</span><span class="o">.</span><span class="n">CACHE</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">,</span> <span class="n">mime</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="favicon_url">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.favicon_url">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">favicon_url</span><span class="p">(</span><span class="n">authority</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Function to generate the image URL used for favicons in SearXNG&#39;s result</span>
 
+<span class="sd">    lists.  The ``authority`` argument (aka netloc / :rfc:`3986`) is usually a</span>
 
+<span class="sd">    (sub-) domain name.  This function is used in the HTML (jinja) templates.</span>
 
+
 
+<span class="sd">    .. code:: html</span>
 
+
 
+<span class="sd">       &lt;div class=&quot;favicon&quot;&gt;</span>
 
+<span class="sd">          &lt;img src=&quot;{{ favicon_url(result.parsed_url.netloc) }}&quot;&gt;</span>
 
+<span class="sd">       &lt;/div&gt;</span>
 
+
 
+<span class="sd">    The returned URL is a route to :py:obj:`favicon_proxy` REST API.</span>
 
+
 
+<span class="sd">    If the favicon is already in the cache, the returned URL is a `data URL`_</span>
 
+<span class="sd">    (something like ``data:image/png;base64,...``).  By generating a data url from</span>
 
+<span class="sd">    the :py:obj:`.cache.FaviconCache`, additional HTTP roundtripps via the</span>
 
+<span class="sd">    :py:obj:`favicon_proxy` are saved.  However, it must also be borne in mind</span>
 
+<span class="sd">    that data urls are not cached in the client (web browser).</span>
 
+
 
+<span class="sd">    .. _data URL: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">resolver</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s1">&#39;favicon_resolver&#39;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+    <span class="c1"># if resolver is empty or not valid, just return nothing.</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">resolver</span> <span class="ow">or</span> <span class="n">resolver</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">CFG</span><span class="o">.</span><span class="n">resolver_map</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;</span>
 
+
 
+    <span class="n">data_mime</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">CACHE</span><span class="p">(</span><span class="n">resolver</span><span class="p">,</span> <span class="n">authority</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">data_mime</span> <span class="o">==</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
 
+        <span class="c1"># we have already checked, the resolver does not have a favicon</span>
 
+        <span class="n">theme</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s2">&quot;theme&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+        <span class="k">return</span> <span class="n">CFG</span><span class="o">.</span><span class="n">favicon_data_url</span><span class="p">(</span><span class="n">theme</span><span class="o">=</span><span class="n">theme</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">data_mime</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="n">data_mime</span>
 
+        <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;data:</span><span class="si">{</span><span class="n">mime</span><span class="si">}</span><span class="s2">;base64,</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">data</span><span class="p">),</span><span class="w"> </span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>  <span class="c1"># type: ignore</span>
 
+
 
+    <span class="n">h</span> <span class="o">=</span> <span class="n">new_hmac</span><span class="p">(</span><span class="n">CFG</span><span class="o">.</span><span class="n">secret_key</span><span class="p">,</span> <span class="n">authority</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
 
+    <span class="n">proxy_url</span> <span class="o">=</span> <span class="n">flask</span><span class="o">.</span><span class="n">url_for</span><span class="p">(</span><span class="s1">&#39;favicon_proxy&#39;</span><span class="p">)</span>
 
+    <span class="n">query</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlencode</span><span class="p">({</span><span class="s2">&quot;authority&quot;</span><span class="p">:</span> <span class="n">authority</span><span class="p">,</span> <span class="s2">&quot;h&quot;</span><span class="p">:</span> <span class="n">h</span><span class="p">})</span>
 
+    <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">proxy_url</span><span class="si">}</span><span class="s2">?</span><span class="si">{</span><span class="n">query</span><span class="si">}</span><span class="s2">&quot;</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 216 - 0
_modules/searx/favicons/resolvers.html
View File 

@@ -0,0 +1,216 @@
 
+<!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.favicons.resolvers &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.favicons.resolvers</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.favicons.resolvers</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Implementations of the favicon *resolvers* that are available in the favicon</span>
 
+<span class="sd">proxy by default.  A *resolver* is a function that obtains the favicon from an</span>
 
+<span class="sd">external source.  The *resolver* function receives two arguments (``domain,</span>
 
+<span class="sd">timeout``) and returns a tuple ``(data, mime)``.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;DEFAULT_RESOLVER_MAP&quot;</span><span class="p">,</span> <span class="s2">&quot;allesedv&quot;</span><span class="p">,</span> <span class="s2">&quot;duckduckgo&quot;</span><span class="p">,</span> <span class="s2">&quot;google&quot;</span><span class="p">,</span> <span class="s2">&quot;yandex&quot;</span><span class="p">]</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Callable</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">network</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="n">DEFAULT_RESOLVER_MAP</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">Callable</span><span class="p">]</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="s1">&#39;favicons.resolvers&#39;</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_req_args</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 
+    <span class="c1"># add the request arguments from the searx.network</span>
 
+    <span class="n">d</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;raise_for_httperror&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span>
 
+    <span class="n">d</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">d</span>
 
+
 
+
 
+<div class="viewcode-block" id="allesedv">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.resolvers.allesedv">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">allesedv</span><span class="p">(</span><span class="n">domain</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Favicon Resolver from allesedv.com / https://favicon.allesedv.com/&quot;&quot;&quot;</span>
 
+    <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://f1.allesedv.com/32/</span><span class="si">{</span><span class="n">domain</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;fetch favicon from: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="c1"># will just return a 200 regardless of the favicon existing or not</span>
 
+    <span class="c1"># sometimes will be correct size, sometimes not</span>
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">_req_args</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">response</span> <span class="ow">and</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
 
+        <span class="n">mime</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Content-Type&#39;</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="n">mime</span> <span class="o">!=</span> <span class="s1">&#39;image/gif&#39;</span><span class="p">:</span>
 
+            <span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">content</span>
 
+    <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="duckduckgo">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.resolvers.duckduckgo">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">duckduckgo</span><span class="p">(</span><span class="n">domain</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Favicon Resolver from duckduckgo.com / https://blog.jim-nielsen.com/2021/displaying-favicons-for-any-domain/&quot;&quot;&quot;</span>
 
+    <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://icons.duckduckgo.com/ip2/</span><span class="si">{</span><span class="n">domain</span><span class="si">}</span><span class="s2">.ico&quot;</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;fetch favicon from: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="c1"># will return a 404 if the favicon does not exist and a 200 if it does,</span>
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">_req_args</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">response</span> <span class="ow">and</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
 
+        <span class="c1"># api will respond with a 32x32 png image</span>
 
+        <span class="n">mime</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Content-Type&#39;</span><span class="p">]</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">content</span>
 
+    <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="google">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.resolvers.google">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">google</span><span class="p">(</span><span class="n">domain</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Favicon Resolver from google.com&quot;&quot;&quot;</span>
 
+    <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+    <span class="c1"># URL https://www.google.com/s2/favicons?sz=32&amp;domain={domain}&quot; will be</span>
 
+    <span class="c1"># redirected (HTTP 301 Moved Permanently) to t1.gstatic.com/faviconV2:</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="sa">f</span><span class="s2">&quot;https://t1.gstatic.com/faviconV2?client=SOCIAL&amp;type=FAVICON&amp;fallback_opts=TYPE,SIZE,URL&quot;</span>
 
+        <span class="sa">f</span><span class="s2">&quot;&amp;url=https://</span><span class="si">{</span><span class="n">domain</span><span class="si">}</span><span class="s2">&amp;size=32&quot;</span>
 
+    <span class="p">)</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;fetch favicon from: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="c1"># will return a 404 if the favicon does not exist and a 200 if it does,</span>
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">_req_args</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">response</span> <span class="ow">and</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
 
+        <span class="c1"># api will respond with a 32x32 png image</span>
 
+        <span class="n">mime</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Content-Type&#39;</span><span class="p">]</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">content</span>
 
+    <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="yandex">
 
+<a class="viewcode-back" href="../../../src/searx.favicons.html#searx.favicons.resolvers.yandex">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">yandex</span><span class="p">(</span><span class="n">domain</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="kc">None</span> <span class="o">|</span> <span class="nb">bytes</span><span class="p">,</span> <span class="kc">None</span> <span class="o">|</span> <span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Favicon Resolver from yandex.com&quot;&quot;&quot;</span>
 
+    <span class="n">data</span><span class="p">,</span> <span class="n">mime</span> <span class="o">=</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+    <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://favicon.yandex.net/favicon/</span><span class="si">{</span><span class="n">domain</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;fetch favicon from: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="c1"># api will respond with a 16x16 png image, if it doesn&#39;t exist, it will be a</span>
 
+    <span class="c1"># 1x1 png image (70 bytes)</span>
 
+    <span class="n">response</span> <span class="o">=</span> <span class="n">network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">_req_args</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">))</span>
 
+    <span class="k">if</span> <span class="n">response</span> <span class="ow">and</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">70</span><span class="p">:</span>
 
+        <span class="n">mime</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Content-Type&#39;</span><span class="p">]</span>
 
+        <span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">content</span>
 
+    <span class="k">return</span> <span class="n">data</span><span class="p">,</span> <span class="n">mime</span></div>
 
+
 
+
 
+
 
+<span class="n">DEFAULT_RESOLVER_MAP</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;allesedv&quot;</span><span class="p">:</span> <span class="n">allesedv</span><span class="p">,</span>
 
+    <span class="s2">&quot;duckduckgo&quot;</span><span class="p">:</span> <span class="n">duckduckgo</span><span class="p">,</span>
 
+    <span class="s2">&quot;google&quot;</span><span class="p">:</span> <span class="n">google</span><span class="p">,</span>
 
+    <span class="s2">&quot;yandex&quot;</span><span class="p">:</span> <span class="n">yandex</span><span class="p">,</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 317 - 0
_modules/searx/infopage.html
View File 

@@ -0,0 +1,317 @@
 
+<!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.infopage &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.infopage</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.infopage</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Render SearXNG instance documentation.</span>
 
+
 
+<span class="sd">Usage in a Flask app route:</span>
 
+
 
+<span class="sd">.. code:: python</span>
 
+
 
+<span class="sd">  from searx import infopage</span>
 
+<span class="sd">  from searx.extended_types import sxng_request</span>
 
+
 
+<span class="sd">  _INFO_PAGES = infopage.InfoPageSet(infopage.MistletoePage)</span>
 
+
 
+<span class="sd">  @app.route(&#39;/info/&lt;pagename&gt;&#39;, methods=[&#39;GET&#39;])</span>
 
+<span class="sd">  def info(pagename):</span>
 
+
 
+<span class="sd">      locale = sxng_request.preferences.get_value(&#39;locale&#39;)</span>
 
+<span class="sd">      page = _INFO_PAGES.get_page(pagename, locale)</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;InfoPage&#39;</span><span class="p">,</span> <span class="s1">&#39;InfoPageSet&#39;</span><span class="p">]</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">os.path</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">typing</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">urllib.parse</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">cached_property</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">jinja2</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask.helpers</span><span class="w"> </span><span class="kn">import</span> <span class="n">url_for</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">markdown_it</span><span class="w"> </span><span class="kn">import</span> <span class="n">MarkdownIt</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">..</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">..version</span><span class="w"> </span><span class="kn">import</span> <span class="n">GIT_URL</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">..locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">LOCALE_NAMES</span>
 
+
 
+
 
+<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">&#39;searx.infopage&#39;</span><span class="p">)</span>
 
+<span class="n">_INFO_FOLDER</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
 
+<span class="n">INFO_PAGES</span><span class="p">:</span> <span class="s1">&#39;InfoPageSet&#39;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="fm">__getattr__</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="s1">&#39;INFO_PAGES&#39;</span><span class="p">:</span>
 
+        <span class="k">global</span> <span class="n">INFO_PAGES</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+        <span class="n">INFO_PAGES</span> <span class="o">=</span> <span class="n">InfoPageSet</span><span class="p">()</span>
 
+        <span class="k">return</span> <span class="n">INFO_PAGES</span>
 
+
 
+    <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;module </span><span class="si">{</span><span class="vm">__name__</span><span class="si">!r}</span><span class="s2"> has no attribute </span><span class="si">{</span><span class="n">name</span><span class="si">!r}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="InfoPage">
 
+<a class="viewcode-back" href="../../src/searx.infopage.html#searx.infopage.InfoPage">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">InfoPage</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A page of the :py:obj:`online documentation &lt;InfoPageSet&gt;`.&quot;&quot;&quot;</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">fname</span><span class="p">):</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">fname</span> <span class="o">=</span> <span class="n">fname</span>
 
+
 
+    <span class="nd">@cached_property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">raw_content</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Raw content of the page (without any jinja rendering)&quot;&quot;&quot;</span>
 
+        <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fname</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
 
+
 
+    <span class="nd">@cached_property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">content</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Content of the page (rendered in a Jinja context)&quot;&quot;&quot;</span>
 
+        <span class="n">ctx</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_ctx</span><span class="p">()</span>
 
+        <span class="n">template</span> <span class="o">=</span> <span class="n">jinja2</span><span class="o">.</span><span class="n">Environment</span><span class="p">()</span><span class="o">.</span><span class="n">from_string</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">raw_content</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="o">**</span><span class="n">ctx</span><span class="p">)</span>
 
+
 
+    <span class="nd">@cached_property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">title</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Title of the content (without any markup)&quot;&quot;&quot;</span>
 
+        <span class="n">t</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+        <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">raw_content</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">):</span>
 
+            <span class="k">if</span> <span class="n">l</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;# &#39;</span><span class="p">):</span>
 
+                <span class="n">t</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">&#39;# &#39;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">t</span>
 
+
 
+    <span class="nd">@cached_property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">html</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Render Markdown (CommonMark_) to HTML by using markdown-it-py_.</span>
 
+
 
+<span class="sd">        .. _CommonMark: https://commonmark.org/</span>
 
+<span class="sd">        .. _markdown-it-py: https://github.com/executablebooks/markdown-it-py</span>
 
+
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="p">(</span>
 
+            <span class="n">MarkdownIt</span><span class="p">(</span><span class="s2">&quot;commonmark&quot;</span><span class="p">,</span> <span class="p">{</span><span class="s2">&quot;typographer&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">})</span><span class="o">.</span><span class="n">enable</span><span class="p">([</span><span class="s2">&quot;replacements&quot;</span><span class="p">,</span> <span class="s2">&quot;smartquotes&quot;</span><span class="p">])</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content</span><span class="p">)</span>
 
+        <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="InfoPage.get_ctx">
 
+<a class="viewcode-back" href="../../src/searx.infopage.html#searx.infopage.InfoPage.get_ctx">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_ctx</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Jinja context to render :py:obj:`InfoPage.content`&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">def</span><span class="w"> </span><span class="nf">_md_link</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">url</span><span class="p">):</span>
 
+            <span class="n">url</span> <span class="o">=</span> <span class="n">url_for</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">_external</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="s2">&quot;[</span><span class="si">%s</span><span class="s2">](</span><span class="si">%s</span><span class="s2">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+
 
+        <span class="k">def</span><span class="w"> </span><span class="nf">_md_search</span><span class="p">(</span><span class="n">query</span><span class="p">):</span>
 
+            <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">?q=</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">url_for</span><span class="p">(</span><span class="s1">&#39;search&#39;</span><span class="p">,</span> <span class="n">_external</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">quote</span><span class="p">(</span><span class="n">query</span><span class="p">))</span>
 
+            <span class="k">return</span> <span class="s1">&#39;[</span><span class="si">%s</span><span class="s1">](</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+
 
+        <span class="n">ctx</span> <span class="o">=</span> <span class="p">{}</span>
 
+        <span class="n">ctx</span><span class="p">[</span><span class="s1">&#39;GIT_URL&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">GIT_URL</span>
 
+        <span class="n">ctx</span><span class="p">[</span><span class="s1">&#39;get_setting&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">get_setting</span>
 
+        <span class="n">ctx</span><span class="p">[</span><span class="s1">&#39;link&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_md_link</span>
 
+        <span class="n">ctx</span><span class="p">[</span><span class="s1">&#39;search&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_md_search</span>
 
+
 
+        <span class="k">return</span> <span class="n">ctx</span></div>
 
+
 
+
 
+    <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="sa">f</span><span class="s1">&#39;&lt;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s1"> fname=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">fname</span><span class="si">!r}</span><span class="s1">&gt;&#39;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="InfoPageSet">
 
+<a class="viewcode-back" href="../../src/searx.infopage.html#searx.infopage.InfoPageSet">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">InfoPageSet</span><span class="p">:</span>  <span class="c1"># pylint: disable=too-few-public-methods</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Cached rendering of the online documentation a SearXNG instance has.</span>
 
+
 
+<span class="sd">    :param page_class: render online documentation by :py:obj:`InfoPage` parser.</span>
 
+<span class="sd">    :type page_class: :py:obj:`InfoPage`</span>
 
+
 
+<span class="sd">    :param info_folder: information directory</span>
 
+<span class="sd">    :type info_folder: str</span>
 
+<span class="sd">    &quot;&quot;&quot;</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">page_class</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">typing</span><span class="o">.</span><span class="n">Type</span><span class="p">[</span><span class="n">InfoPage</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">info_folder</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</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="p">):</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">page_class</span> <span class="o">=</span> <span class="n">page_class</span> <span class="ow">or</span> <span class="n">InfoPage</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">folder</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">info_folder</span> <span class="ow">or</span> <span class="n">_INFO_FOLDER</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;location of the Markdown files&quot;&quot;&quot;</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">CACHE</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="nb">tuple</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">InfoPage</span><span class="p">]]</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">locale_default</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;default language&quot;&quot;&quot;</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">locales</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
 
+            <span class="n">locale</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">,</span> <span class="s1">&#39;-&#39;</span><span class="p">)</span> <span class="k">for</span> <span class="n">locale</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">_INFO_FOLDER</span><span class="p">)</span> <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">,</span> <span class="s1">&#39;-&#39;</span><span class="p">)</span> <span class="ow">in</span> <span class="n">LOCALE_NAMES</span>
 
+        <span class="p">]</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;list of supported languages (aka locales)&quot;&quot;&quot;</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">toc</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
 
+            <span class="s1">&#39;search-syntax&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;about&#39;</span><span class="p">,</span>
 
+            <span class="s1">&#39;donate&#39;</span><span class="p">,</span>
 
+        <span class="p">]</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;list of articles in the online documentation&quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="InfoPageSet.get_page">
 
+<a class="viewcode-back" href="../../src/searx.infopage.html#searx.infopage.InfoPageSet.get_page">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_page</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pagename</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">locale</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</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="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Return ``pagename`` instance of :py:obj:`InfoPage`</span>
 
+
 
+<span class="sd">        :param pagename: name of the page, a value from :py:obj:`InfoPageSet.toc`</span>
 
+<span class="sd">        :type pagename: str</span>
 
+
 
+<span class="sd">        :param locale: language of the page, e.g. ``en``, ``zh_Hans_CN``</span>
 
+<span class="sd">                       (default: :py:obj:`InfoPageSet.i18n_origin`)</span>
 
+<span class="sd">        :type locale: str</span>
 
+
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">locale_default</span>
 
+
 
+        <span class="k">if</span> <span class="n">pagename</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">toc</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="kc">None</span>
 
+        <span class="k">if</span> <span class="n">locale</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">locales</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="kc">None</span>
 
+
 
+        <span class="n">cache_key</span> <span class="o">=</span> <span class="p">(</span><span class="n">pagename</span><span class="p">,</span> <span class="n">locale</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="n">cache_key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">CACHE</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">CACHE</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span>
 
+
 
+        <span class="c1"># not yet instantiated</span>
 
+
 
+        <span class="n">fname</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">folder</span><span class="p">,</span> <span class="n">locale</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">,</span> <span class="s1">&#39;_&#39;</span><span class="p">),</span> <span class="n">pagename</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39;.md&#39;</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">fname</span><span class="p">):</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;file </span><span class="si">%s</span><span class="s1"> does not exists&#39;</span><span class="p">,</span> <span class="n">fname</span><span class="p">)</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">CACHE</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
 
+            <span class="k">return</span> <span class="kc">None</span>
 
+
 
+        <span class="n">page</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">page_class</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">CACHE</span><span class="p">[</span><span class="n">cache_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">page</span>
 
+        <span class="k">return</span> <span class="n">page</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="InfoPageSet.iter_pages">
 
+<a class="viewcode-back" href="../../src/searx.infopage.html#searx.infopage.InfoPageSet.iter_pages">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">iter_pages</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">locale</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</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="p">,</span> <span class="n">fallback_to_default</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Iterate over all pages of the TOC&quot;&quot;&quot;</span>
 
+        <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">locale_default</span>
 
+        <span class="k">for</span> <span class="n">page_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">toc</span><span class="p">:</span>
 
+            <span class="n">page_locale</span> <span class="o">=</span> <span class="n">locale</span>
 
+            <span class="n">page</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_page</span><span class="p">(</span><span class="n">page_name</span><span class="p">,</span> <span class="n">locale</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">fallback_to_default</span> <span class="ow">and</span> <span class="n">page</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="n">page_locale</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">locale_default</span>
 
+                <span class="n">page</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_page</span><span class="p">(</span><span class="n">page_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">locale_default</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">page</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="c1"># page is None if the page was deleted by the administrator</span>
 
+                <span class="k">yield</span> <span class="n">page_name</span><span class="p">,</span> <span class="n">page_locale</span><span class="p">,</span> <span class="n">page</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 361 - 0
_modules/searx/limiter.html
View File 

@@ -0,0 +1,361 @@
 
+<!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.limiter &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.limiter</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.limiter</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Bot protection / IP rate limitation.  The intention of rate limitation is to</span>
 
+<span class="sd">limit suspicious requests from an IP.  The motivation behind this is the fact</span>
 
+<span class="sd">that SearXNG passes through requests from bots and is thus classified as a bot</span>
 
+<span class="sd">itself.  As a result, the SearXNG engine then receives a CAPTCHA or is blocked</span>
 
+<span class="sd">by the search engine (the origin) in some other way.</span>
 
+
 
+<span class="sd">To avoid blocking, the requests from bots to SearXNG must also be blocked, this</span>
 
+<span class="sd">is the task of the limiter.  To perform this task, the limiter uses the methods</span>
 
+<span class="sd">from the :ref:`botdetection`:</span>
 
+
 
+<span class="sd">- Analysis of the HTTP header in the request / :ref:`botdetection probe headers`</span>
 
+<span class="sd">  can be easily bypassed.</span>
 
+
 
+<span class="sd">- Block and pass lists in which IPs are listed / :ref:`botdetection ip_lists`</span>
 
+<span class="sd">  are hard to maintain, since the IPs of bots are not all known and change over</span>
 
+<span class="sd">  the time.</span>
 
+
 
+<span class="sd">- Detection &amp; dynamically :ref:`botdetection rate limit` of bots based on the</span>
 
+<span class="sd">  behavior of the requests.  For dynamically changeable IP lists a Redis</span>
 
+<span class="sd">  database is needed.</span>
 
+
 
+<span class="sd">The prerequisite for IP based methods is the correct determination of the IP of</span>
 
+<span class="sd">the client. The IP of the client is determined via the X-Forwarded-For_ HTTP</span>
 
+<span class="sd">header.</span>
 
+
 
+<span class="sd">.. attention::</span>
 
+
 
+<span class="sd">   A correct setup of the HTTP request headers ``X-Forwarded-For`` and</span>
 
+<span class="sd">   ``X-Real-IP`` is essential to be able to assign a request to an IP correctly:</span>
 
+
 
+<span class="sd">   - `NGINX RequestHeader`_</span>
 
+<span class="sd">   - `Apache RequestHeader`_</span>
 
+
 
+<span class="sd">.. _X-Forwarded-For:</span>
 
+<span class="sd">    https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For</span>
 
+<span class="sd">.. _NGINX RequestHeader:</span>
 
+<span class="sd">    https://docs.searxng.org/admin/installation-nginx.html#nginx-s-searxng-site</span>
 
+<span class="sd">.. _Apache RequestHeader:</span>
 
+<span class="sd">    https://docs.searxng.org/admin/installation-apache.html#apache-s-searxng-site</span>
 
+
 
+<span class="sd">Enable Limiter</span>
 
+<span class="sd">==============</span>
 
+
 
+<span class="sd">To enable the limiter activate:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">   server:</span>
 
+<span class="sd">     ...</span>
 
+<span class="sd">     limiter: true  # rate limit the number of request on the instance, block some bots</span>
 
+
 
+<span class="sd">and set the redis-url connection. Check the value, it depends on your redis DB</span>
 
+<span class="sd">(see :ref:`settings redis`), by example:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">   redis:</span>
 
+<span class="sd">     url: unix:///usr/local/searxng-redis/run/redis.sock?db=0</span>
 
+
 
+
 
+<span class="sd">Configure Limiter</span>
 
+<span class="sd">=================</span>
 
+
 
+<span class="sd">The methods of :ref:`botdetection` the limiter uses are configured in a local</span>
 
+<span class="sd">file ``/etc/searxng/limiter.toml``.  The defaults are shown in limiter.toml_ /</span>
 
+<span class="sd">Don&#39;t copy all values to your local configuration, just enable what you need by</span>
 
+<span class="sd">overwriting the defaults.  For instance to activate the ``link_token`` method in</span>
 
+<span class="sd">the :ref:`botdetection.ip_limit` you only need to set this option to ``true``:</span>
 
+
 
+<span class="sd">.. code:: toml</span>
 
+
 
+<span class="sd">   [botdetection.ip_limit]</span>
 
+<span class="sd">   link_token = true</span>
 
+
 
+<span class="sd">.. _limiter.toml:</span>
 
+
 
+<span class="sd">``limiter.toml``</span>
 
+<span class="sd">================</span>
 
+
 
+<span class="sd">In this file the limiter finds the configuration of the :ref:`botdetection`:</span>
 
+
 
+<span class="sd">- :ref:`botdetection ip_lists`</span>
 
+<span class="sd">- :ref:`botdetection rate limit`</span>
 
+<span class="sd">- :ref:`botdetection probe headers`</span>
 
+
 
+<span class="sd">.. kernel-include:: $SOURCEDIR/limiter.toml</span>
 
+<span class="sd">   :code: toml</span>
 
+
 
+<span class="sd">Implementation</span>
 
+<span class="sd">==============</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">ipaddress</span><span class="w"> </span><span class="kn">import</span> <span class="n">ip_address</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">werkzeug</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="p">(</span>
 
+    <span class="n">logger</span><span class="p">,</span>
 
+    <span class="n">redisdb</span><span class="p">,</span>
 
+<span class="p">)</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">botdetection</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">sxng_request</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.botdetection</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
 
+    <span class="n">config</span><span class="p">,</span>
 
+    <span class="n">http_accept</span><span class="p">,</span>
 
+    <span class="n">http_accept_encoding</span><span class="p">,</span>
 
+    <span class="n">http_accept_language</span><span class="p">,</span>
 
+    <span class="n">http_user_agent</span><span class="p">,</span>
 
+    <span class="n">ip_limit</span><span class="p">,</span>
 
+    <span class="n">ip_lists</span><span class="p">,</span>
 
+    <span class="n">get_network</span><span class="p">,</span>
 
+    <span class="n">get_real_ip</span><span class="p">,</span>
 
+    <span class="n">dump_request</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+
 
+<span class="c1"># the configuration are limiter.toml and &quot;limiter&quot; in settings.yml so, for</span>
 
+<span class="c1"># coherency, the logger is &quot;limiter&quot;</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="s1">&#39;limiter&#39;</span><span class="p">)</span>
 
+
 
+<span class="n">CFG</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span> <span class="o">=</span> <span class="kc">None</span>  <span class="c1"># type: ignore</span>
 
+<span class="n">_INSTALLED</span> <span class="o">=</span> <span class="kc">False</span>
 
+
 
+<span class="n">LIMITER_CFG_SCHEMA</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="s2">&quot;limiter.toml&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;Base configuration (schema) of the botdetection.&quot;&quot;&quot;</span>
 
+
 
+<span class="n">CFG_DEPRECATED</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="c1"># &quot;dummy.old.foo&quot;: &quot;config &#39;dummy.old.foo&#39; exists only for tests.  Don&#39;t use it in your real project config.&quot;</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_cfg</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">:</span>
 
+    <span class="k">global</span> <span class="n">CFG</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+
 
+    <span class="k">if</span> <span class="n">CFG</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">settings_loader</span>  <span class="c1"># pylint: disable=import-outside-toplevel</span>
 
+
 
+        <span class="n">cfg_file</span> <span class="o">=</span> <span class="p">(</span><span class="n">settings_loader</span><span class="o">.</span><span class="n">get_user_cfg_folder</span><span class="p">()</span> <span class="ow">or</span> <span class="n">Path</span><span class="p">(</span><span class="s2">&quot;/etc/searxng&quot;</span><span class="p">))</span> <span class="o">/</span> <span class="s2">&quot;limiter.toml&quot;</span>
 
+        <span class="n">CFG</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="o">.</span><span class="n">from_toml</span><span class="p">(</span><span class="n">LIMITER_CFG_SCHEMA</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">,</span> <span class="n">CFG_DEPRECATED</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">CFG</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">filter_request</span><span class="p">(</span><span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">werkzeug</span><span class="o">.</span><span class="n">Response</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+    <span class="c1"># pylint: disable=too-many-return-statements</span>
 
+
 
+    <span class="n">cfg</span> <span class="o">=</span> <span class="n">get_cfg</span><span class="p">()</span>
 
+    <span class="n">real_ip</span> <span class="o">=</span> <span class="n">ip_address</span><span class="p">(</span><span class="n">get_real_ip</span><span class="p">(</span><span class="n">request</span><span class="p">))</span>
 
+    <span class="n">network</span> <span class="o">=</span> <span class="n">get_network</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">path</span> <span class="o">==</span> <span class="s1">&#39;/healthz&#39;</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="c1"># link-local</span>
 
+
 
+    <span class="k">if</span> <span class="n">network</span><span class="o">.</span><span class="n">is_link_local</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="c1"># block- &amp; pass- lists</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># 1. The IP of the request is first checked against the pass-list; if the IP</span>
 
+    <span class="c1">#    matches an entry in the list, the request is not blocked.</span>
 
+    <span class="c1"># 2. If no matching entry is found in the pass-list, then a check is made against</span>
 
+    <span class="c1">#    the block list; if the IP matches an entry in the list, the request is</span>
 
+    <span class="c1">#    blocked.</span>
 
+    <span class="c1"># 3. If the IP is not in either list, the request is not blocked.</span>
 
+
 
+    <span class="n">match</span><span class="p">,</span> <span class="n">msg</span> <span class="o">=</span> <span class="n">ip_lists</span><span class="o">.</span><span class="n">pass_ip</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">match</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;PASS </span><span class="si">%s</span><span class="s2">: matched PASSLIST - </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="n">match</span><span class="p">,</span> <span class="n">msg</span> <span class="o">=</span> <span class="n">ip_lists</span><span class="o">.</span><span class="n">block_ip</span><span class="p">(</span><span class="n">real_ip</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">match</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">&quot;BLOCK </span><span class="si">%s</span><span class="s2">: matched BLOCKLIST - </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">network</span><span class="o">.</span><span class="n">compressed</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">flask</span><span class="o">.</span><span class="n">make_response</span><span class="p">((</span><span class="s1">&#39;IP is on BLOCKLIST - </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">msg</span><span class="p">,</span> <span class="mi">429</span><span class="p">))</span>
 
+
 
+    <span class="c1"># methods applied on /</span>
 
+
 
+    <span class="k">for</span> <span class="n">func</span> <span class="ow">in</span> <span class="p">[</span>
 
+        <span class="n">http_user_agent</span><span class="p">,</span>
 
+    <span class="p">]:</span>
 
+        <span class="n">val</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="n">filter_request</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">val</span>
 
+
 
+    <span class="c1"># methods applied on /search</span>
 
+
 
+    <span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">path</span> <span class="o">==</span> <span class="s1">&#39;/search&#39;</span><span class="p">:</span>
 
+
 
+        <span class="k">for</span> <span class="n">func</span> <span class="ow">in</span> <span class="p">[</span>
 
+            <span class="n">http_accept</span><span class="p">,</span>
 
+            <span class="n">http_accept_encoding</span><span class="p">,</span>
 
+            <span class="n">http_accept_language</span><span class="p">,</span>
 
+            <span class="n">http_user_agent</span><span class="p">,</span>
 
+            <span class="n">ip_limit</span><span class="p">,</span>
 
+        <span class="p">]:</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="n">filter_request</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">cfg</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="k">return</span> <span class="n">val</span>
 
+    <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;OK </span><span class="si">{</span><span class="n">network</span><span class="si">}</span><span class="s2">: %s&quot;</span><span class="p">,</span> <span class="n">dump_request</span><span class="p">(</span><span class="n">sxng_request</span><span class="p">))</span>
 
+    <span class="k">return</span> <span class="kc">None</span>
 
+
 
+
 
+<div class="viewcode-block" id="pre_request">
 
+<a class="viewcode-back" href="../../admin/searx.limiter.html#searx.limiter.pre_request">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">pre_request</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;See :py:obj:`flask.Flask.before_request`&quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="n">filter_request</span><span class="p">(</span><span class="n">sxng_request</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="is_installed">
 
+<a class="viewcode-back" href="../../admin/searx.limiter.html#searx.limiter.is_installed">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">is_installed</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns ``True`` if limiter is active and a redis DB is available.&quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="n">_INSTALLED</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="initialize">
 
+<a class="viewcode-back" href="../../admin/searx.limiter.html#searx.limiter.initialize">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">app</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Flask</span><span class="p">,</span> <span class="n">settings</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Install the limiter&quot;&quot;&quot;</span>
 
+    <span class="k">global</span> <span class="n">_INSTALLED</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+
 
+    <span class="c1"># even if the limiter is not activated, the botdetection must be activated</span>
 
+    <span class="c1"># (e.g. the self_info plugin uses the botdetection to get client IP)</span>
 
+
 
+    <span class="n">cfg</span> <span class="o">=</span> <span class="n">get_cfg</span><span class="p">()</span>
 
+    <span class="n">redis_client</span> <span class="o">=</span> <span class="n">redisdb</span><span class="o">.</span><span class="n">client</span><span class="p">()</span>
 
+    <span class="n">botdetection</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">redis_client</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">settings</span><span class="p">[</span><span class="s1">&#39;server&#39;</span><span class="p">][</span><span class="s1">&#39;limiter&#39;</span><span class="p">]</span> <span class="ow">or</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;server&#39;</span><span class="p">][</span><span class="s1">&#39;public_instance&#39;</span><span class="p">]):</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">redis_client</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">&quot;The limiter requires Redis, please consult the documentation: &quot;</span>
 
+            <span class="s2">&quot;https://docs.searxng.org/admin/searx.limiter.html&quot;</span>
 
+        <span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;server&#39;</span><span class="p">][</span><span class="s1">&#39;public_instance&#39;</span><span class="p">]:</span>
 
+            <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
 
+        <span class="k">return</span>
 
+
 
+    <span class="n">_INSTALLED</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+    <span class="k">if</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;server&#39;</span><span class="p">][</span><span class="s1">&#39;public_instance&#39;</span><span class="p">]:</span>
 
+        <span class="c1"># overwrite limiter.toml setting</span>
 
+        <span class="n">cfg</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">&#39;botdetection.ip_limit.link_token&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
 
+
 
+    <span class="n">app</span><span class="o">.</span><span class="n">before_request</span><span class="p">(</span><span class="n">pre_request</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 595 - 0
_modules/searx/locales.html
View File 

@@ -0,0 +1,595 @@
 
+<!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.locales &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.locales</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.locales</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">SearXNG’s locale data</span>
 
+<span class="sd">=====================</span>
 
+
 
+<span class="sd">The variables :py:obj:`RTL_LOCALES` and :py:obj:`LOCALE_NAMES` are loaded from</span>
 
+<span class="sd">:origin:`searx/data/locales.json` / see :py:obj:`locales_initialize` and</span>
 
+<span class="sd">:ref:`update_locales.py`.</span>
 
+
 
+<span class="sd">.. hint::</span>
 
+
 
+<span class="sd">   Whenever the value of :py:obj:`ADDITIONAL_TRANSLATIONS` or</span>
 
+<span class="sd">   :py:obj:`LOCALE_BEST_MATCH` is modified, the</span>
 
+<span class="sd">   :origin:`searx/data/locales.json` needs to be rebuild::</span>
 
+
 
+<span class="sd">     ./manage data.locales</span>
 
+
 
+<span class="sd">SearXNG&#39;s locale codes</span>
 
+<span class="sd">======================</span>
 
+
 
+<span class="sd">.. automodule:: searx.sxng_locales</span>
 
+<span class="sd">   :members:</span>
 
+
 
+
 
+<span class="sd">SearXNG’s locale implementations</span>
 
+<span class="sd">================================</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</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">babel.support</span><span class="w"> </span><span class="kn">import</span> <span class="n">Translations</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.languages</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.core</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">flask_babel</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask.ctx</span><span class="w"> </span><span class="kn">import</span> <span class="n">has_request_context</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="p">(</span>
 
+    <span class="n">data</span><span class="p">,</span>
 
+    <span class="n">logger</span><span class="p">,</span>
 
+    <span class="n">searx_dir</span><span class="p">,</span>
 
+<span class="p">)</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">sxng_request</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="s1">&#39;locales&#39;</span><span class="p">)</span>
 
+
 
+
 
+<span class="c1"># safe before monkey patching flask_babel.get_translations</span>
 
+<span class="n">_flask_babel_get_translations</span> <span class="o">=</span> <span class="n">flask_babel</span><span class="o">.</span><span class="n">get_translations</span>
 
+
 
+<span class="n">LOCALE_NAMES</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="sd">&quot;&quot;&quot;Mapping of locales and their description.  Locales e.g. &#39;fr&#39; or &#39;pt-BR&#39; (see</span>
 
+<span class="sd">:py:obj:`locales_initialize`).</span>
 
+
 
+<span class="sd">:meta hide-value:</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="n">RTL_LOCALES</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+<span class="sd">&quot;&quot;&quot;List of *Right-To-Left* locales e.g. &#39;he&#39; or &#39;fa-IR&#39; (see</span>
 
+<span class="sd">:py:obj:`locales_initialize`).&quot;&quot;&quot;</span>
 
+
 
+<span class="n">ADDITIONAL_TRANSLATIONS</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;dv&quot;</span><span class="p">:</span> <span class="s2">&quot;ދިވެހި (Dhivehi)&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;oc&quot;</span><span class="p">:</span> <span class="s2">&quot;Occitan&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;szl&quot;</span><span class="p">:</span> <span class="s2">&quot;Ślōnski (Silesian)&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;pap&quot;</span><span class="p">:</span> <span class="s2">&quot;Papiamento&quot;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="sd">&quot;&quot;&quot;Additional languages SearXNG has translations for but not supported by</span>
 
+<span class="sd">python-babel (see :py:obj:`locales_initialize`).&quot;&quot;&quot;</span>
 
+
 
+<span class="n">LOCALE_BEST_MATCH</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s2">&quot;dv&quot;</span><span class="p">:</span> <span class="s2">&quot;si&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;oc&quot;</span><span class="p">:</span> <span class="s1">&#39;fr-FR&#39;</span><span class="p">,</span>
 
+    <span class="s2">&quot;szl&quot;</span><span class="p">:</span> <span class="s2">&quot;pl&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;nl-BE&quot;</span><span class="p">:</span> <span class="s2">&quot;nl&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;zh-HK&quot;</span><span class="p">:</span> <span class="s2">&quot;zh-Hant-TW&quot;</span><span class="p">,</span>
 
+    <span class="s2">&quot;pap&quot;</span><span class="p">:</span> <span class="s2">&quot;pt-BR&quot;</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+<span class="sd">&quot;&quot;&quot;Map a locale we do not have a translations for to a locale we have a</span>
 
+<span class="sd">translation for.  By example: use Taiwan version of the translation for Hong</span>
 
+<span class="sd">Kong.&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">localeselector</span><span class="p">():</span>
 
+    <span class="n">locale</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
 
+    <span class="k">if</span> <span class="n">has_request_context</span><span class="p">():</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s1">&#39;locale&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">value</span><span class="p">:</span>
 
+            <span class="n">locale</span> <span class="o">=</span> <span class="n">value</span>
 
+
 
+    <span class="c1"># first, set the language that is not supported by babel</span>
 
+    <span class="k">if</span> <span class="n">locale</span> <span class="ow">in</span> <span class="n">ADDITIONAL_TRANSLATIONS</span><span class="p">:</span>
 
+        <span class="n">sxng_request</span><span class="o">.</span><span class="n">form</span><span class="p">[</span><span class="s1">&#39;use-translation&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">locale</span>
 
+
 
+    <span class="c1"># second, map locale to a value python-babel supports</span>
 
+    <span class="n">locale</span> <span class="o">=</span> <span class="n">LOCALE_BEST_MATCH</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">locale</span><span class="p">,</span> <span class="n">locale</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">locale</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
 
+        <span class="c1"># if there is an error loading the preferences</span>
 
+        <span class="c1"># the locale is going to be &#39;&#39;</span>
 
+        <span class="n">locale</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
 
+
 
+    <span class="c1"># babel uses underscore instead of hyphen.</span>
 
+    <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">,</span> <span class="s1">&#39;_&#39;</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">locale</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_translations">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_translations">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_translations</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Monkey patch of :py:obj:`flask_babel.get_translations`&quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="n">has_request_context</span><span class="p">():</span>
 
+        <span class="n">use_translation</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;use-translation&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">use_translation</span> <span class="ow">in</span> <span class="n">ADDITIONAL_TRANSLATIONS</span><span class="p">:</span>
 
+            <span class="n">babel_ext</span> <span class="o">=</span> <span class="n">flask_babel</span><span class="o">.</span><span class="n">current_app</span><span class="o">.</span><span class="n">extensions</span><span class="p">[</span><span class="s1">&#39;babel&#39;</span><span class="p">]</span>
 
+            <span class="k">return</span> <span class="n">Translations</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">babel_ext</span><span class="o">.</span><span class="n">translation_directories</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">use_translation</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">_flask_babel_get_translations</span><span class="p">()</span></div>
 
+
 
+
 
+
 
+<span class="n">_TR_LOCALES</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_translation_locales">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_translation_locales">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_translation_locales</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns the list of translation locales (*underscore*).  The list is</span>
 
+<span class="sd">    generated from the translation folders in :origin:`searx/translations`&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">global</span> <span class="n">_TR_LOCALES</span>  <span class="c1"># pylint:disable=global-statement</span>
 
+    <span class="k">if</span> <span class="n">_TR_LOCALES</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">_TR_LOCALES</span>
 
+
 
+    <span class="n">tr_locales</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">folder</span> <span class="ow">in</span> <span class="p">(</span><span class="n">Path</span><span class="p">(</span><span class="n">searx_dir</span><span class="p">)</span> <span class="o">/</span> <span class="s1">&#39;translations&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">iterdir</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">folder</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">folder</span> <span class="o">/</span> <span class="s1">&#39;LC_MESSAGES&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">tr_locales</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">folder</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
 
+    <span class="n">_TR_LOCALES</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">tr_locales</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">_TR_LOCALES</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="locales_initialize">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.locales_initialize">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">locales_initialize</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialize locales environment of the SearXNG session.</span>
 
+
 
+<span class="sd">    - monkey patch :py:obj:`flask_babel.get_translations` by :py:obj:`get_translations`</span>
 
+<span class="sd">    - init global names :py:obj:`LOCALE_NAMES`, :py:obj:`RTL_LOCALES`</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">flask_babel</span><span class="o">.</span><span class="n">get_translations</span> <span class="o">=</span> <span class="n">get_translations</span>
 
+    <span class="n">LOCALE_NAMES</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">data</span><span class="o">.</span><span class="n">LOCALES</span><span class="p">[</span><span class="s2">&quot;LOCALE_NAMES&quot;</span><span class="p">])</span>
 
+    <span class="n">RTL_LOCALES</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">data</span><span class="o">.</span><span class="n">LOCALES</span><span class="p">[</span><span class="s2">&quot;RTL_LOCALES&quot;</span><span class="p">])</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="region_tag">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.region_tag">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">:</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns SearXNG&#39;s region tag from the locale (e.g. zh-TW , en-US).&quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;babel.Locale </span><span class="si">%s</span><span class="s1">: missed a territory&#39;</span> <span class="o">%</span> <span class="n">locale</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="language_tag">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.language_tag">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">:</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns SearXNG&#39;s language tag from the locale and if exits, the tag</span>
 
+<span class="sd">    includes the script name (e.g. en, zh_Hant).</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">sxng_lang</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">locale</span><span class="o">.</span><span class="n">script</span><span class="p">:</span>
 
+        <span class="n">sxng_lang</span> <span class="o">+=</span> <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">locale</span><span class="o">.</span><span class="n">script</span>
 
+    <span class="k">return</span> <span class="n">sxng_lang</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_locale">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_locale">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_locale</span><span class="p">(</span><span class="n">locale_tag</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a :py:obj:`babel.Locale` object parsed from argument</span>
 
+<span class="sd">    ``locale_tag``&quot;&quot;&quot;</span>
 
+    <span class="k">try</span><span class="p">:</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="n">locale_tag</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">locale</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">return</span> <span class="kc">None</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_official_locales">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_official_locales">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_official_locales</span><span class="p">(</span>
 
+    <span class="n">territory</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">languages</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">regional</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="n">de_facto</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
 
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">set</span><span class="p">[</span><span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a list of :py:obj:`babel.Locale` with languages from</span>
 
+<span class="sd">    :py:obj:`babel.languages.get_official_languages`.</span>
 
+
 
+<span class="sd">    :param territory: The territory (country or region) code.</span>
 
+
 
+<span class="sd">    :param languages: A list of language codes the languages from</span>
 
+<span class="sd">      :py:obj:`babel.languages.get_official_languages` should be in</span>
 
+<span class="sd">      (intersection).  If this argument is ``None``, all official languages in</span>
 
+<span class="sd">      this territory are used.</span>
 
+
 
+<span class="sd">    :param regional: If the regional flag is set, then languages which are</span>
 
+<span class="sd">      regionally official are also returned.</span>
 
+
 
+<span class="sd">    :param de_facto: If the de_facto flag is set to `False`, then languages</span>
 
+<span class="sd">      which are “de facto” official are not returned.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">ret_val</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+    <span class="n">o_languages</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get_official_languages</span><span class="p">(</span><span class="n">territory</span><span class="p">,</span> <span class="n">regional</span><span class="o">=</span><span class="n">regional</span><span class="p">,</span> <span class="n">de_facto</span><span class="o">=</span><span class="n">de_facto</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">languages</span><span class="p">:</span>
 
+        <span class="n">languages</span> <span class="o">=</span> <span class="p">[</span><span class="n">l</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">languages</span><span class="p">]</span>
 
+        <span class="n">o_languages</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">l</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">o_languages</span> <span class="k">if</span> <span class="n">l</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="n">languages</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">lang</span> <span class="ow">in</span> <span class="n">o_languages</span><span class="p">:</span>
 
+        <span class="k">try</span><span class="p">:</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="n">lang</span> <span class="o">+</span> <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">territory</span><span class="p">)</span>
 
+            <span class="n">ret_val</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+    <span class="k">return</span> <span class="n">ret_val</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_engine_locale">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_engine_locale">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_engine_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">,</span> <span class="n">engine_locales</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return engine&#39;s language (aka locale) string that best fits to argument</span>
 
+<span class="sd">    ``searxng_locale``.</span>
 
+
 
+<span class="sd">    Argument ``engine_locales`` is a python dict that maps *SearXNG locales* to</span>
 
+<span class="sd">    corresponding *engine locales*::</span>
 
+
 
+<span class="sd">      &lt;engine&gt;: {</span>
 
+<span class="sd">          # SearXNG string : engine-string</span>
 
+<span class="sd">          &#39;ca-ES&#39;          : &#39;ca_ES&#39;,</span>
 
+<span class="sd">          &#39;fr-BE&#39;          : &#39;fr_BE&#39;,</span>
 
+<span class="sd">          &#39;fr-CA&#39;          : &#39;fr_CA&#39;,</span>
 
+<span class="sd">          &#39;fr-CH&#39;          : &#39;fr_CH&#39;,</span>
 
+<span class="sd">          &#39;fr&#39;             : &#39;fr_FR&#39;,</span>
 
+<span class="sd">          ...</span>
 
+<span class="sd">          &#39;pl-PL&#39;          : &#39;pl_PL&#39;,</span>
 
+<span class="sd">          &#39;pt-PT&#39;          : &#39;pt_PT&#39;</span>
 
+<span class="sd">          ..</span>
 
+<span class="sd">          &#39;zh&#39;             : &#39;zh&#39;</span>
 
+<span class="sd">          &#39;zh_Hans&#39;        : &#39;zh&#39;</span>
 
+<span class="sd">          &#39;zh_Hant&#39;        : &#39;zh_TW&#39;</span>
 
+<span class="sd">      }</span>
 
+
 
+<span class="sd">    .. hint::</span>
 
+
 
+<span class="sd">       The *SearXNG locale* string has to be known by babel!</span>
 
+
 
+<span class="sd">    If there is no direct 1:1 mapping, this functions tries to narrow down</span>
 
+<span class="sd">    engine&#39;s language (locale).  If no value can be determined by these</span>
 
+<span class="sd">    approximation attempts the ``default`` value is returned.</span>
 
+
 
+<span class="sd">    Assumptions:</span>
 
+
 
+<span class="sd">    A. When user select a language the results should be optimized according to</span>
 
+<span class="sd">       the selected language.</span>
 
+
 
+<span class="sd">    B. When user select a language and a territory the results should be</span>
 
+<span class="sd">       optimized with first priority on territory and second on language.</span>
 
+
 
+<span class="sd">    First approximation rule (*by territory*):</span>
 
+
 
+<span class="sd">      When the user selects a locale with territory (and a language), the</span>
 
+<span class="sd">      territory has priority over the language.  If any of the official languages</span>
 
+<span class="sd">      in the territory is supported by the engine (``engine_locales``) it will</span>
 
+<span class="sd">      be used.</span>
 
+
 
+<span class="sd">    Second approximation rule (*by language*):</span>
 
+
 
+<span class="sd">      If &quot;First approximation rule&quot; brings no result or the user selects only a</span>
 
+<span class="sd">      language without a territory.  Check in which territories the language</span>
 
+<span class="sd">      has an official status and if one of these territories is supported by the</span>
 
+<span class="sd">      engine.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># pylint: disable=too-many-branches, too-many-return-statements</span>
 
+
 
+    <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="c1"># There was a 1:1 mapping (e.g. a region &quot;fr-BE --&gt; fr_BE&quot; or a language</span>
 
+        <span class="c1"># &quot;zh --&gt; zh&quot;), no need to narrow language-script nor territory.</span>
 
+        <span class="k">return</span> <span class="n">engine_locale</span>
 
+
 
+    <span class="k">try</span><span class="p">:</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="n">searxng_locale</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</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">try</span><span class="p">:</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="n">searxng_locale</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</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">return</span> <span class="n">default</span>
 
+
 
+    <span class="n">searxng_lang</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
 
+    <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_lang</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="c1"># There was a 1:1 mapping (e.g. &quot;zh-HK --&gt; zh_Hant&quot; or &quot;zh-CN --&gt; zh_Hans&quot;)</span>
 
+        <span class="k">return</span> <span class="n">engine_locale</span>
 
+
 
+    <span class="c1"># SearXNG&#39;s selected locale is not supported by the engine ..</span>
 
+
 
+    <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
 
+        <span class="c1"># Try to narrow by *official* languages in the territory (??-XX).</span>
 
+
 
+        <span class="k">for</span> <span class="n">official_language</span> <span class="ow">in</span> <span class="n">babel</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get_official_languages</span><span class="p">(</span><span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">,</span> <span class="n">de_facto</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+            <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">official_language</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span>
 
+            <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="k">return</span> <span class="n">engine_locale</span>
 
+
 
+    <span class="c1"># Engine does not support one of the official languages in the territory or</span>
 
+    <span class="c1"># there is only a language selected without a territory.</span>
 
+
 
+    <span class="c1"># Now lets have a look if the searxng_lang (the language selected by the</span>
 
+    <span class="c1"># user) is a official language in other territories.  If so, check if</span>
 
+    <span class="c1"># engine does support the searxng_lang in this other territory.</span>
 
+
 
+    <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span><span class="p">:</span>
 
+
 
+        <span class="n">terr_lang_dict</span> <span class="o">=</span> <span class="p">{}</span>
 
+        <span class="k">for</span> <span class="n">territory</span><span class="p">,</span> <span class="n">langs</span> <span class="ow">in</span> <span class="n">babel</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">get_global</span><span class="p">(</span><span class="s2">&quot;territory_languages&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">langs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_lang</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;official_status&#39;</span><span class="p">):</span>
 
+                <span class="k">continue</span>
 
+            <span class="n">terr_lang_dict</span><span class="p">[</span><span class="n">territory</span><span class="p">]</span> <span class="o">=</span> <span class="n">langs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_lang</span><span class="p">)</span>
 
+
 
+        <span class="c1"># first: check fr-FR, de-DE .. is supported by the engine</span>
 
+        <span class="c1"># exception: &#39;en&#39; --&gt; &#39;en-US&#39;</span>
 
+
 
+        <span class="n">territory</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">territory</span> <span class="o">==</span> <span class="s1">&#39;EN&#39;</span><span class="p">:</span>
 
+            <span class="n">territory</span> <span class="o">=</span> <span class="s1">&#39;US&#39;</span>
 
+
 
+        <span class="k">if</span> <span class="n">terr_lang_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">territory</span><span class="p">):</span>
 
+            <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">territory</span>
 
+            <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="k">return</span> <span class="n">engine_locale</span>
 
+
 
+        <span class="c1"># second: sort by population_percent and take first match</span>
 
+
 
+        <span class="c1"># drawback of &quot;population percent&quot;: if there is a territory with a</span>
 
+        <span class="c1">#   small number of people (e.g 100) but the majority speaks the</span>
 
+        <span class="c1">#   language, then the percentage might be 100% (--&gt; 100 people) but in</span>
 
+        <span class="c1">#   a different territory with more people (e.g. 10.000) where only 10%</span>
 
+        <span class="c1">#   speak the language the total amount of speaker is higher (--&gt; 200</span>
 
+        <span class="c1">#   people).</span>
 
+        <span class="c1">#</span>
 
+        <span class="c1">#   By example: The population of Saint-Martin is 33.000, of which 100%</span>
 
+        <span class="c1">#   speak French, but this is less than the 30% of the approximately 2.5</span>
 
+        <span class="c1">#   million Belgian citizens</span>
 
+        <span class="c1">#</span>
 
+        <span class="c1">#   - &#39;fr-MF&#39;, &#39;population_percent&#39;: 100.0, &#39;official_status&#39;: &#39;official&#39;</span>
 
+        <span class="c1">#   - &#39;fr-BE&#39;, &#39;population_percent&#39;: 38.0, &#39;official_status&#39;: &#39;official&#39;</span>
 
+
 
+        <span class="n">terr_lang_list</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">terr_lang_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="n">terr_lang_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">))</span>
 
+
 
+        <span class="k">for</span> <span class="n">territory</span><span class="p">,</span> <span class="n">_lang</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">terr_lang_list</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">item</span><span class="p">:</span> <span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="s1">&#39;population_percent&#39;</span><span class="p">],</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+            <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">territory</span>
 
+            <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="k">return</span> <span class="n">engine_locale</span>
 
+
 
+    <span class="c1"># No luck: narrow by &quot;language from territory&quot; and &quot;territory from language&quot;</span>
 
+    <span class="c1"># does not fit to a locale supported by the engine.</span>
 
+
 
+    <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">default</span>
 
+
 
+    <span class="k">return</span> <span class="n">default</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="match_locale">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.match_locale">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">match_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">locale_tag_list</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">fallback</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="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return tag from ``locale_tag_list`` that best fits to ``searxng_locale``.</span>
 
+
 
+<span class="sd">    :param str searxng_locale: SearXNG&#39;s internal representation of locale (de,</span>
 
+<span class="sd">        de-DE, fr-BE, zh, zh-CN, zh-TW ..).</span>
 
+
 
+<span class="sd">    :param list locale_tag_list: The list of locale tags to select from</span>
 
+
 
+<span class="sd">    :param str fallback: fallback locale tag (if unset --&gt; ``None``)</span>
 
+
 
+<span class="sd">    The rules to find a match are implemented in :py:obj:`get_engine_locale`,</span>
 
+<span class="sd">    the ``engine_locales`` is build up by :py:obj:`build_engine_locales`.</span>
 
+
 
+<span class="sd">    .. hint::</span>
 
+
 
+<span class="sd">       The *SearXNG locale* string and the members of ``locale_tag_list`` has to</span>
 
+<span class="sd">       be known by babel!  The :py:obj:`ADDITIONAL_TRANSLATIONS` are used in the</span>
 
+<span class="sd">       UI and are not known by babel --&gt; will be ignored.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># searxng_locale = &#39;es&#39;</span>
 
+    <span class="c1"># locale_tag_list = [&#39;es-AR&#39;, &#39;es-ES&#39;, &#39;es-MX&#39;]</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">searxng_locale</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">fallback</span>
 
+
 
+    <span class="n">locale</span> <span class="o">=</span> <span class="n">get_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">fallback</span>
 
+
 
+    <span class="c1"># normalize to a SearXNG locale that can be passed to get_engine_locale</span>
 
+
 
+    <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
 
+        <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
 
+
 
+    <span class="c1"># clean up locale_tag_list</span>
 
+
 
+    <span class="n">tag_list</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">locale_tag_list</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">tag</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;all&#39;</span><span class="p">,</span> <span class="s1">&#39;auto&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">ADDITIONAL_TRANSLATIONS</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">tag_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
 
+
 
+    <span class="c1"># emulate fetch_traits</span>
 
+    <span class="n">engine_locales</span> <span class="o">=</span> <span class="n">build_engine_locales</span><span class="p">(</span><span class="n">tag_list</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">get_engine_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">,</span> <span class="n">engine_locales</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">fallback</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="build_engine_locales">
 
+<a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.build_engine_locales">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">build_engine_locales</span><span class="p">(</span><span class="n">tag_list</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;From a list of locale tags a dictionary is build that can be passed by</span>
 
+<span class="sd">    argument ``engine_locales`` to :py:obj:`get_engine_locale`.  This function</span>
 
+<span class="sd">    is mainly used by :py:obj:`match_locale` and is similar to what the</span>
 
+<span class="sd">    ``fetch_traits(..)`` function of engines do.</span>
 
+
 
+<span class="sd">    If there are territory codes in the ``tag_list`` that have a *script code*</span>
 
+<span class="sd">    additional keys are added to the returned dictionary.</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">       &gt;&gt;&gt; import locales</span>
 
+<span class="sd">       &gt;&gt;&gt; engine_locales = locales.build_engine_locales([&#39;en&#39;, &#39;en-US&#39;, &#39;zh&#39;, &#39;zh-CN&#39;, &#39;zh-TW&#39;])</span>
 
+<span class="sd">       &gt;&gt;&gt; engine_locales</span>
 
+<span class="sd">       {</span>
 
+<span class="sd">           &#39;en&#39;: &#39;en&#39;, &#39;en-US&#39;: &#39;en-US&#39;,</span>
 
+<span class="sd">           &#39;zh&#39;: &#39;zh&#39;, &#39;zh-CN&#39;: &#39;zh-CN&#39;, &#39;zh_Hans&#39;: &#39;zh-CN&#39;,</span>
 
+<span class="sd">           &#39;zh-TW&#39;: &#39;zh-TW&#39;, &#39;zh_Hant&#39;: &#39;zh-TW&#39;</span>
 
+<span class="sd">       }</span>
 
+<span class="sd">       &gt;&gt;&gt; get_engine_locale(&#39;zh-Hans&#39;, engine_locales)</span>
 
+<span class="sd">       &#39;zh-CN&#39;</span>
 
+
 
+<span class="sd">    This function is a good example to understand the language/region model</span>
 
+<span class="sd">    of SearXNG:</span>
 
+
 
+<span class="sd">      SearXNG only distinguishes between **search languages** and **search</span>
 
+<span class="sd">      regions**, by adding the *script-tags*, languages with *script-tags* can</span>
 
+<span class="sd">      be assigned to the **regions** that SearXNG supports.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">engine_locales</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">tag_list</span><span class="p">:</span>
 
+        <span class="n">locale</span> <span class="o">=</span> <span class="n">get_locale</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;build_engine_locales: skip locale tag </span><span class="si">%s</span><span class="s2"> / unknown by babel&quot;</span><span class="p">,</span> <span class="n">tag</span><span class="p">)</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
 
+            <span class="n">engine_locales</span><span class="p">[</span><span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">tag</span>
 
+            <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">script</span><span class="p">:</span>
 
+                <span class="n">engine_locales</span><span class="p">[</span><span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">tag</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">engine_locales</span><span class="p">[</span><span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">tag</span>
 
+    <span class="k">return</span> <span class="n">engine_locales</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 444 - 0
_modules/searx/plugins/_core.html
View File 

@@ -0,0 +1,444 @@
 
+<!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.plugins._core &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.plugins._core</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.plugins._core</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="c1"># pylint: disable=too-few-public-methods,missing-module-docstring</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;PluginInfo&quot;</span><span class="p">,</span> <span class="s2">&quot;Plugin&quot;</span><span class="p">,</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">,</span> <span class="s2">&quot;PluginStorage&quot;</span><span class="p">]</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">abc</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">importlib</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">inspect</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">re</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">dataclasses</span><span class="w"> </span><span class="kn">import</span> <span class="n">dataclass</span><span class="p">,</span> <span class="n">field</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</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="k">if</span> <span class="n">typing</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
 
+    <span class="kn">import</span><span class="w"> </span><span class="nn">flask</span>
 
+
 
+<span class="n">log</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">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;searx.plugins&quot;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="PluginInfo">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginInfo">[docs]</a>
 
+<span class="nd">@dataclass</span>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">PluginInfo</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Object that holds informations about a *plugin*, these infos are shown to</span>
 
+<span class="sd">    the user in the Preferences menu.</span>
 
+
 
+<span class="sd">    To be able to translate the information into other languages, the text must</span>
 
+<span class="sd">    be written in English and translated with :py:obj:`flask_babel.gettext`.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The ID-selector in HTML/CSS `#&lt;id&gt;`.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Name of the *plugin*.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">description</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Short description of the *answerer*.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">preference_section</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">&quot;general&quot;</span><span class="p">,</span> <span class="s2">&quot;ui&quot;</span><span class="p">,</span> <span class="s2">&quot;privacy&quot;</span><span class="p">,</span> <span class="s2">&quot;query&quot;</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="s2">&quot;general&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Section (tab/group) in the preferences where this plugin is shown to the</span>
 
+<span class="sd">    user.</span>
 
+
 
+<span class="sd">    The value ``query`` is reserved for plugins that are activated via a</span>
 
+<span class="sd">    *keyword* as part of a search query, see:</span>
 
+
 
+<span class="sd">    - :py:obj:`PluginInfo.examples`</span>
 
+<span class="sd">    - :py:obj:`Plugin.keywords`</span>
 
+
 
+<span class="sd">    Those plugins are shown in the preferences in tab *Special Queries*.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">examples</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">list</span><span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;List of short examples of the usage / of query terms.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">keywords</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">list</span><span class="p">)</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;See :py:obj:`Plugin.keywords`&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<span class="n">ID_REGXP</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="s2">&quot;[a-z][a-z0-9].*&quot;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="Plugin">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">Plugin</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Abstract base class of all Plugins.&quot;&quot;&quot;</span>
 
+
 
+    <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The ID (suffix) in the HTML form.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">active</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">ClassVar</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Plugin is enabled/disabled by default (:py:obj:`PluginCfg.active`).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">keywords</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Keywords in the search query that activate the plugin.  The *keyword* is</span>
 
+<span class="sd">    the first word in a search query.  If a plugin should be executed regardless</span>
 
+<span class="sd">    of the search query, the list of keywords should be empty (which is also the</span>
 
+<span class="sd">    default in the base class for Plugins).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">log</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">Logger</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A logger object, is automatically initialized when calling the</span>
 
+<span class="sd">    constructor (if not already set in the subclass).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">info</span><span class="p">:</span> <span class="n">PluginInfo</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Informations about the *plugin*, see :py:obj:`PluginInfo`.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">fqn</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</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">plg_cfg</span><span class="p">:</span> <span class="n">PluginCfg</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">fqn</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">fqn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__mro__</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="vm">__module__</span>
 
+
 
+        <span class="c1"># names from the configuration</span>
 
+        <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">plg_cfg</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
 
+
 
+        <span class="c1"># names that must be set by the plugin implementation</span>
 
+        <span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="p">[</span>
 
+            <span class="s2">&quot;id&quot;</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="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;plugin </span><span class="si">{</span><span class="bp">self</span><span class="si">}</span><span class="s2"> is missing attribute </span><span class="si">{</span><span class="n">attr</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">ID_REGXP</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">):</span>
 
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;plugin ID </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2"> contains invalid character (use lowercase ASCII)&quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;log&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
 
+            <span class="n">pkg_name</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">getmodule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">)</span><span class="o">.</span><span class="n">__package__</span>  <span class="c1"># type: ignore</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">pkg_name</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">&quot;</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="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The hash value is used in :py:obj:`set`, for example, when an object</span>
 
+<span class="sd">        is added to the set.  The hash value is also used in other contexts,</span>
 
+<span class="sd">        e.g. when checking for equality to identify identical plugins from</span>
 
+<span class="sd">        different sources (name collisions).&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">return</span> <span class="nb">id</span><span class="p">(</span><span class="bp">self</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="w">        </span><span class="sd">&quot;&quot;&quot;py:obj:`Plugin` objects are equal if the hash values of the two</span>
 
+<span class="sd">        objects are equal.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">hash</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="Plugin.init">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin.init">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">:</span> <span class="s2">&quot;flask.Flask&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Initialization of the plugin, the return value decides whether this</span>
 
+<span class="sd">        plugin is active or not.  Initialization only takes place once, at the</span>
 
+<span class="sd">        time the WEB application is set up.  The base methode always returns</span>
 
+<span class="sd">        ``True``, the methode can be overwritten in the inheritances,</span>
 
+
 
+<span class="sd">        - ``True`` plugin is active</span>
 
+<span class="sd">        - ``False`` plugin is inactive</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="kc">True</span></div>
 
+
 
+
 
+    <span class="c1"># pylint: disable=unused-argument</span>
 
+<div class="viewcode-block" id="Plugin.pre_search">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin.pre_search">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">pre_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Runs BEFORE the search request and returns a boolean:</span>
 
+
 
+<span class="sd">        - ``True`` to continue the search</span>
 
+<span class="sd">        - ``False`` to stop the search</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="kc">True</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="Plugin.on_result">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin.on_result">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">on_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">,</span> <span class="n">result</span><span class="p">:</span> <span class="n">Result</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Runs for each result of each engine and returns a boolean:</span>
 
+
 
+<span class="sd">        - ``True`` to keep the result</span>
 
+<span class="sd">        - ``False`` to remove the result from the result list</span>
 
+
 
+<span class="sd">        The ``result`` can be modified to the needs.</span>
 
+
 
+<span class="sd">        .. hint::</span>
 
+
 
+<span class="sd">           If :py:obj:`Result.url &lt;searx.result_types._base.Result.url&gt;` is modified,</span>
 
+<span class="sd">           :py:obj:`Result.parsed_url &lt;searx.result_types._base.Result.parsed_url&gt;` must</span>
 
+<span class="sd">           be changed accordingly:</span>
 
+
 
+<span class="sd">           .. code:: python</span>
 
+
 
+<span class="sd">              result[&quot;parsed_url&quot;] = urlparse(result[&quot;url&quot;])</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="kc">True</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="Plugin.post_search">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.Plugin.post_search">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="o">|</span> <span class="n">typing</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="n">Result</span><span class="p">]:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Runs AFTER the search request.  Can return a list of</span>
 
+<span class="sd">        :py:obj:`Result &lt;searx.result_types._base.Result&gt;` objects to be added to the</span>
 
+<span class="sd">        final result list.&quot;&quot;&quot;</span>
 
+        <span class="k">return</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="PluginCfg">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginCfg">[docs]</a>
 
+<span class="nd">@dataclass</span>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">PluginCfg</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Settings of a plugin.</span>
 
+
 
+<span class="sd">    .. code:: yaml</span>
 
+
 
+<span class="sd">       mypackage.mymodule.MyPlugin:</span>
 
+<span class="sd">         active: true</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">active</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Plugin is active by default and the user can *opt-out* in the preferences.&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="PluginStorage">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">PluginStorage</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A storage for managing the *plugins* of SearXNG.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">plugin_list</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="n">Plugin</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The list of :py:obj:`Plugins` in this storage.&quot;&quot;&quot;</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">plugin_list</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">yield from</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="p">)</span>
 
+
 
+    <span class="nd">@property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">PluginInfo</span><span class="p">]:</span>
 
+
 
+        <span class="k">return</span> <span class="p">[</span><span class="n">p</span><span class="o">.</span><span class="n">info</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="p">]</span>
 
+
 
+<div class="viewcode-block" id="PluginStorage.load_settings">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage.load_settings">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">load_settings</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</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="w">        </span><span class="sd">&quot;&quot;&quot;Load plugins configured in SearXNG&#39;s settings :ref:`settings</span>
 
+<span class="sd">        plugins`.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">for</span> <span class="n">fqn</span><span class="p">,</span> <span class="n">plg_settings</span> <span class="ow">in</span> <span class="n">cfg</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="bp">cls</span> <span class="o">=</span> <span class="kc">None</span>
 
+            <span class="n">mod_name</span><span class="p">,</span> <span class="n">cls_name</span> <span class="o">=</span> <span class="n">fqn</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="n">mod</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="n">mod_name</span><span class="p">)</span>
 
+                <span class="bp">cls</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">mod</span><span class="p">,</span> <span class="n">cls_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+            <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>  <span class="c1"># pylint: disable=broad-exception-caught</span>
 
+                <span class="n">log</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span>
 
+
 
+            <span class="k">if</span> <span class="bp">cls</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;plugin </span><span class="si">{</span><span class="n">fqn</span><span class="si">}</span><span class="s2"> is not implemented&quot;</span>
 
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
+            <span class="n">plg</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">PluginCfg</span><span class="p">(</span><span class="o">**</span><span class="n">plg_settings</span><span class="p">))</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">plg</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="PluginStorage.register">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage.register">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="n">Plugin</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Register a :py:obj:`Plugin`.  In case of name collision (if two</span>
 
+<span class="sd">        plugins have same ID) a :py:obj:`KeyError` exception is raised.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="k">if</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="p">[</span><span class="n">p</span><span class="o">.</span><span class="n">id</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="p">]:</span>
 
+            <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;name collision &#39;</span><span class="si">{</span><span class="n">plugin</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
 
+            <span class="n">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
+            <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">plugin</span><span class="p">)</span>
 
+        <span class="n">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;plugin has been loaded&quot;</span><span class="p">)</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="PluginStorage.init">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage.init">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">:</span> <span class="s2">&quot;flask.Flask&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Calls the method :py:obj:`Plugin.init` of each plugin in this</span>
 
+<span class="sd">        storage.  Depending on its return value, the plugin is removed from</span>
 
+<span class="sd">        *this* storage or not.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">for</span> <span class="n">plg</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="o">.</span><span class="n">copy</span><span class="p">():</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">plg</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">app</span><span class="p">):</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">plg</span><span class="p">)</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">pre_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+
 
+        <span class="n">ret</span> <span class="o">=</span> <span class="kc">True</span>
 
+        <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">search</span><span class="o">.</span><span class="n">user_plugins</span><span class="p">]:</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="n">ret</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">pre_search</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="o">=</span><span class="n">search</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">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s2">&quot;Exception while calling pre_search&quot;</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">ret</span><span class="p">:</span>
 
+                <span class="c1"># skip this search on the first False from a plugin</span>
 
+                <span class="k">break</span>
 
+        <span class="k">return</span> <span class="n">ret</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">on_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">,</span> <span class="n">result</span><span class="p">:</span> <span class="n">Result</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+
 
+        <span class="n">ret</span> <span class="o">=</span> <span class="kc">True</span>
 
+        <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">search</span><span class="o">.</span><span class="n">user_plugins</span><span class="p">]:</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="n">ret</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">on_result</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="o">=</span><span class="n">search</span><span class="p">,</span> <span class="n">result</span><span class="o">=</span><span class="n">result</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">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s2">&quot;Exception while calling on_result&quot;</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">ret</span><span class="p">:</span>
 
+                <span class="c1"># ignore this result item on the first False from a plugin</span>
 
+                <span class="k">break</span>
 
+
 
+        <span class="k">return</span> <span class="n">ret</span>
 
+
 
+<div class="viewcode-block" id="PluginStorage.post_search">
 
+<a class="viewcode-back" href="../../../dev/plugins/development.html#searx.plugins.PluginStorage.post_search">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Extend :py:obj:`search.result_container</span>
 
+<span class="sd">        &lt;searx.results.ResultContainer`&gt; with result items from plugins listed</span>
 
+<span class="sd">        in :py:obj:`search.user_plugins &lt;SearchWithPlugins.user_plugins&gt;`.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="n">keyword</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">():</span>
 
+            <span class="k">if</span> <span class="n">keyword</span><span class="p">:</span>
 
+                <span class="k">break</span>
 
+
 
+        <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">plugin_list</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">search</span><span class="o">.</span><span class="n">user_plugins</span><span class="p">]:</span>
 
+
 
+            <span class="k">if</span> <span class="n">plugin</span><span class="o">.</span><span class="n">keywords</span><span class="p">:</span>
 
+                <span class="c1"># plugin with keywords: skip plugin if no keyword match</span>
 
+                <span class="k">if</span> <span class="n">keyword</span> <span class="ow">and</span> <span class="n">keyword</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">plugin</span><span class="o">.</span><span class="n">keywords</span><span class="p">:</span>
 
+                    <span class="k">continue</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="n">results</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">post_search</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="o">=</span><span class="n">search</span><span class="p">)</span> <span class="ow">or</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">plugin</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s2">&quot;Exception while calling post_search&quot;</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="c1"># In case of *plugins* prefix ``plugin:`` is set, see searx.result_types.Result</span>
 
+            <span class="n">search</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;plugin: </span><span class="si">{</span><span class="n">plugin</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">results</span><span class="p">)</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 268 - 0
_modules/searx/plugins/calculator.html
View File 

@@ -0,0 +1,268 @@
 
+<!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.plugins.calculator &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.plugins.calculator</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.plugins.calculator</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Calculate mathematical expressions using :py:obj:`ast.parse` (mode=&quot;eval&quot;).</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</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">ast</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">operator</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">multiprocessing</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.numbers</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</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="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">PluginInfo</span>
 
+
 
+<span class="k">if</span> <span class="n">typing</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">PluginCfg</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGPlugin">
 
+<a class="viewcode-back" href="../../../dev/plugins/calculator.html#searx.plugins.calculator.SXNGPlugin">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNGPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Plugin converts strings to different hash digests.  The results are</span>
 
+<span class="sd">    displayed in area for the &quot;answers&quot;.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="nb">id</span> <span class="o">=</span> <span class="s2">&quot;calculator&quot;</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">plg_cfg</span><span class="p">:</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">plg_cfg</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
 
+            <span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
 
+            <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Basic Calculator&quot;</span><span class="p">),</span>
 
+            <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Calculate mathematical expressions via the search bar&quot;</span><span class="p">),</span>
 
+            <span class="n">preference_section</span><span class="o">=</span><span class="s2">&quot;general&quot;</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="SXNGPlugin.post_search">
 
+<a class="viewcode-back" href="../../../dev/plugins/calculator.html#searx.plugins.calculator.SXNGPlugin.post_search">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="s2">&quot;SXNG_Request&quot;</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+        <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+        <span class="c1"># only show the result of the expression on the first page</span>
 
+        <span class="k">if</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="n">query</span> <span class="o">=</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span>
 
+        <span class="c1"># in order to avoid DoS attacks with long expressions, ignore long expressions</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">query</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">100</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="c1"># replace commonly used math operators with their proper Python operator</span>
 
+        <span class="n">query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;x&quot;</span><span class="p">,</span> <span class="s2">&quot;*&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;:&quot;</span><span class="p">,</span> <span class="s2">&quot;/&quot;</span><span class="p">)</span>
 
+
 
+        <span class="c1"># use UI language</span>
 
+        <span class="n">ui_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="n">request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s2">&quot;locale&quot;</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="s2">&quot;-&quot;</span><span class="p">)</span>
 
+
 
+        <span class="c1"># parse the number system in a localized way</span>
 
+        <span class="k">def</span><span class="w"> </span><span class="nf">_decimal</span><span class="p">(</span><span class="n">match</span><span class="p">:</span> <span class="n">re</span><span class="o">.</span><span class="n">Match</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">string</span><span class="p">[</span><span class="n">match</span><span class="o">.</span><span class="n">start</span><span class="p">()</span> <span class="p">:</span> <span class="n">match</span><span class="o">.</span><span class="n">end</span><span class="p">()]</span>
 
+            <span class="n">val</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">parse_decimal</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">ui_locale</span><span class="p">,</span> <span class="n">numbering_system</span><span class="o">=</span><span class="s2">&quot;latn&quot;</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">val</span><span class="p">)</span>
 
+
 
+        <span class="n">decimal</span> <span class="o">=</span> <span class="n">ui_locale</span><span class="o">.</span><span class="n">number_symbols</span><span class="p">[</span><span class="s2">&quot;latn&quot;</span><span class="p">][</span><span class="s2">&quot;decimal&quot;</span><span class="p">]</span>
 
+        <span class="n">group</span> <span class="o">=</span> <span class="n">ui_locale</span><span class="o">.</span><span class="n">number_symbols</span><span class="p">[</span><span class="s2">&quot;latn&quot;</span><span class="p">][</span><span class="s2">&quot;group&quot;</span><span class="p">]</span>
 
+        <span class="n">query</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="sa">f</span><span class="s2">&quot;[0-9]+[</span><span class="si">{</span><span class="n">decimal</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">group</span><span class="si">}</span><span class="s2">][0-9]+[</span><span class="si">{</span><span class="n">decimal</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">group</span><span class="si">}</span><span class="s2">]?[0-9]?&quot;</span><span class="p">,</span> <span class="n">_decimal</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
 
+
 
+        <span class="c1"># only numbers and math operators are accepted</span>
 
+        <span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">isalpha</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">query</span><span class="p">):</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="c1"># in python, powers are calculated via **</span>
 
+        <span class="n">query_py_formatted</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;^&quot;</span><span class="p">,</span> <span class="s2">&quot;**&quot;</span><span class="p">)</span>
 
+
 
+        <span class="c1"># Prevent the runtime from being longer than 50 ms</span>
 
+        <span class="n">res</span> <span class="o">=</span> <span class="n">timeout_func</span><span class="p">(</span><span class="mf">0.05</span><span class="p">,</span> <span class="n">_eval_expr</span><span class="p">,</span> <span class="n">query_py_formatted</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">res</span> <span class="o">==</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="n">res</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">format_decimal</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">ui_locale</span><span class="p">)</span>
 
+        <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="si">}</span><span class="s2"> = </span><span class="si">{</span><span class="n">res</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
 
+
 
+        <span class="k">return</span> <span class="n">results</span></div>
 
+</div>
 
+
 
+
 
+
 
+<span class="n">operators</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">type</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="n">ast</span><span class="o">.</span><span class="n">Add</span><span class="p">:</span> <span class="n">operator</span><span class="o">.</span><span class="n">add</span><span class="p">,</span>
 
+    <span class="n">ast</span><span class="o">.</span><span class="n">Sub</span><span class="p">:</span> <span class="n">operator</span><span class="o">.</span><span class="n">sub</span><span class="p">,</span>
 
+    <span class="n">ast</span><span class="o">.</span><span class="n">Mult</span><span class="p">:</span> <span class="n">operator</span><span class="o">.</span><span class="n">mul</span><span class="p">,</span>
 
+    <span class="n">ast</span><span class="o">.</span><span class="n">Div</span><span class="p">:</span> <span class="n">operator</span><span class="o">.</span><span class="n">truediv</span><span class="p">,</span>
 
+    <span class="n">ast</span><span class="o">.</span><span class="n">Pow</span><span class="p">:</span> <span class="n">operator</span><span class="o">.</span><span class="n">pow</span><span class="p">,</span>
 
+    <span class="n">ast</span><span class="o">.</span><span class="n">BitXor</span><span class="p">:</span> <span class="n">operator</span><span class="o">.</span><span class="n">xor</span><span class="p">,</span>
 
+    <span class="n">ast</span><span class="o">.</span><span class="n">USub</span><span class="p">:</span> <span class="n">operator</span><span class="o">.</span><span class="n">neg</span><span class="p">,</span>
 
+<span class="p">}</span>
 
+
 
+<span class="c1"># with multiprocessing.get_context(&quot;fork&quot;) we are ready for Py3.14 (by emulating</span>
 
+<span class="c1"># the old behavior &quot;fork&quot;) but it will not solve the core problem of fork, nor</span>
 
+<span class="c1"># will it remove the deprecation warnings in py3.12 &amp; py3.13.  Issue is</span>
 
+<span class="c1"># ddiscussed here: https://github.com/searxng/searxng/issues/4159</span>
 
+<span class="n">mp_fork</span> <span class="o">=</span> <span class="n">multiprocessing</span><span class="o">.</span><span class="n">get_context</span><span class="p">(</span><span class="s2">&quot;fork&quot;</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_eval_expr</span><span class="p">(</span><span class="n">expr</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">    &gt;&gt;&gt; _eval_expr(&#39;2^6&#39;)</span>
 
+<span class="sd">    64</span>
 
+<span class="sd">    &gt;&gt;&gt; _eval_expr(&#39;2**6&#39;)</span>
 
+<span class="sd">    64</span>
 
+<span class="sd">    &gt;&gt;&gt; _eval_expr(&#39;1 + 2*3**(4^5) / (6 + -7)&#39;)</span>
 
+<span class="sd">    -5.0</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">_eval</span><span class="p">(</span><span class="n">ast</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">expr</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">&#39;eval&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">body</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="ne">ZeroDivisionError</span><span class="p">:</span>
 
+        <span class="c1"># This is undefined</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_eval</span><span class="p">(</span><span class="n">node</span><span class="p">):</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="n">ast</span><span class="o">.</span><span class="n">Constant</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">)):</span>
 
+        <span class="k">return</span> <span class="n">node</span><span class="o">.</span><span class="n">value</span>
 
+
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="n">ast</span><span class="o">.</span><span class="n">BinOp</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">operators</span><span class="p">[</span><span class="nb">type</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">op</span><span class="p">)](</span><span class="n">_eval</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">left</span><span class="p">),</span> <span class="n">_eval</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">right</span><span class="p">))</span>
 
+
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">node</span><span class="p">,</span> <span class="n">ast</span><span class="o">.</span><span class="n">UnaryOp</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">operators</span><span class="p">[</span><span class="nb">type</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">op</span><span class="p">)](</span><span class="n">_eval</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">operand</span><span class="p">))</span>
 
+
 
+    <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">node</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">handler</span><span class="p">(</span><span class="n">q</span><span class="p">:</span> <span class="n">multiprocessing</span><span class="o">.</span><span class="n">Queue</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>  <span class="c1"># pylint:disable=invalid-name</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">q</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">))</span>
 
+    <span class="k">except</span><span class="p">:</span>
 
+        <span class="n">q</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">raise</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">timeout_func</span><span class="p">(</span><span class="n">timeout</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 
+
 
+    <span class="n">que</span> <span class="o">=</span> <span class="n">mp_fork</span><span class="o">.</span><span class="n">Queue</span><span class="p">()</span>
 
+    <span class="n">p</span> <span class="o">=</span> <span class="n">mp_fork</span><span class="o">.</span><span class="n">Process</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="n">handler</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">que</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="n">args</span><span class="p">),</span> <span class="n">kwargs</span><span class="o">=</span><span class="n">kwargs</span><span class="p">)</span>
 
+    <span class="n">p</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
 
+    <span class="n">p</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span>
 
+    <span class="n">ret_val</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="c1"># pylint: disable=used-before-assignment,undefined-variable</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">p</span><span class="o">.</span><span class="n">is_alive</span><span class="p">():</span>
 
+        <span class="n">ret_val</span> <span class="o">=</span> <span class="n">que</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;terminate function after timeout is exceeded&quot;</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">p</span><span class="o">.</span><span class="n">terminate</span><span class="p">()</span>
 
+    <span class="n">p</span><span class="o">.</span><span class="n">join</span><span class="p">()</span>
 
+    <span class="n">p</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
 
+    <span class="k">return</span> <span class="n">ret_val</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 176 - 0
_modules/searx/plugins/hash_plugin.html
View File 

@@ -0,0 +1,176 @@
 
+<!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.plugins.hash_plugin &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.plugins.hash_plugin</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.plugins.hash_plugin</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, missing-class-docstring</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</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">re</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">hashlib</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">PluginInfo</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">if</span> <span class="n">typing</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">PluginCfg</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGPlugin">
 
+<a class="viewcode-back" href="../../../dev/plugins/hash_plugin.html#searx.plugins.hash_plugin.SXNGPlugin">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNGPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Plugin converts strings to different hash digests.  The results are</span>
 
+<span class="sd">    displayed in area for the &quot;answers&quot;.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="nb">id</span> <span class="o">=</span> <span class="s2">&quot;hash_plugin&quot;</span>
 
+    <span class="n">keywords</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;md5&quot;</span><span class="p">,</span> <span class="s2">&quot;sha1&quot;</span><span class="p">,</span> <span class="s2">&quot;sha224&quot;</span><span class="p">,</span> <span class="s2">&quot;sha256&quot;</span><span class="p">,</span> <span class="s2">&quot;sha384&quot;</span><span class="p">,</span> <span class="s2">&quot;sha512&quot;</span><span class="p">]</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">plg_cfg</span><span class="p">:</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">plg_cfg</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">parser_re</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">f</span><span class="s2">&quot;(</span><span class="si">{</span><span class="s1">&#39;|&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">keywords</span><span class="p">)</span><span class="si">}</span><span class="s2">) (.*)&quot;</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="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
 
+            <span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
 
+            <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Hash plugin&quot;</span><span class="p">),</span>
 
+            <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Converts strings to different hash digests.&quot;</span><span class="p">),</span>
 
+            <span class="n">examples</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;sha512 The quick brown fox jumps over the lazy dog&quot;</span><span class="p">],</span>
 
+            <span class="n">preference_section</span><span class="o">=</span><span class="s2">&quot;query&quot;</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="SXNGPlugin.post_search">
 
+<a class="viewcode-back" href="../../../dev/plugins/hash_plugin.html#searx.plugins.hash_plugin.SXNGPlugin.post_search">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="s2">&quot;SXNG_Request&quot;</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a result list only for the first page.&quot;&quot;&quot;</span>
 
+        <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+        <span class="k">if</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="n">m</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parser_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">search</span><span class="o">.</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="c1"># wrong query</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="n">function</span><span class="p">,</span> <span class="n">string</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">if</span> <span class="ow">not</span> <span class="n">string</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
 
+            <span class="c1"># end if the string is empty</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="c1"># select hash function</span>
 
+        <span class="n">f</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">function</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
 
+
 
+        <span class="c1"># make digest from the given string</span>
 
+        <span class="n">f</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">string</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
 
+        <span class="n">answer</span> <span class="o">=</span> <span class="n">function</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span> <span class="o">+</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;hash digest&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;: &quot;</span> <span class="o">+</span> <span class="n">f</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
 
+
 
+        <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="n">answer</span><span class="p">))</span>
 
+
 
+        <span class="k">return</span> <span class="n">results</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 320 - 0
_modules/searx/plugins/hostnames.html
View File 

@@ -0,0 +1,320 @@
 
+<!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.plugins.hostnames &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.plugins.hostnames</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.plugins.hostnames</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="c1"># pylint: disable=too-many-branches, unused-argument</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="sd">During the initialization phase, the plugin checks whether a ``hostnames:``</span>
 
+<span class="sd">configuration exists. If this is not the case, the plugin is not included</span>
 
+<span class="sd">in the PluginStorage (it is not available for selection).</span>
 
+
 
+<span class="sd">- ``hostnames.replace``: A **mapping** of regular expressions to hostnames to be</span>
 
+<span class="sd">  replaced by other hostnames.</span>
 
+
 
+<span class="sd">  .. code:: yaml</span>
 
+
 
+<span class="sd">     hostnames:</span>
 
+<span class="sd">       replace:</span>
 
+<span class="sd">         &#39;(.*\\.)?youtube\\.com$&#39;: &#39;invidious.example.com&#39;</span>
 
+<span class="sd">         &#39;(.*\\.)?youtu\\.be$&#39;: &#39;invidious.example.com&#39;</span>
 
+<span class="sd">         ...</span>
 
+
 
+<span class="sd">- ``hostnames.remove``: A **list** of regular expressions of the hostnames whose</span>
 
+<span class="sd">  results should be taken from the results list.</span>
 
+
 
+<span class="sd">  .. code:: yaml</span>
 
+
 
+<span class="sd">     hostnames:</span>
 
+<span class="sd">       remove:</span>
 
+<span class="sd">         - &#39;(.*\\.)?facebook.com$&#39;</span>
 
+<span class="sd">         - ...</span>
 
+
 
+<span class="sd">- ``hostnames.high_priority``: A **list** of regular expressions for hostnames</span>
 
+<span class="sd">  whose result should be given higher priority. The results from these hosts are</span>
 
+<span class="sd">  arranged higher in the results list.</span>
 
+
 
+<span class="sd">  .. code:: yaml</span>
 
+
 
+<span class="sd">     hostnames:</span>
 
+<span class="sd">       high_priority:</span>
 
+<span class="sd">         - &#39;(.*\\.)?wikipedia.org$&#39;</span>
 
+<span class="sd">         - ...</span>
 
+
 
+<span class="sd">- ``hostnames.lower_priority``: A **list** of regular expressions for hostnames</span>
 
+<span class="sd">  whose result should be given lower priority. The results from these hosts are</span>
 
+<span class="sd">  arranged lower in the results list.</span>
 
+
 
+<span class="sd">  .. code:: yaml</span>
 
+
 
+<span class="sd">     hostnames:</span>
 
+<span class="sd">       low_priority:</span>
 
+<span class="sd">         - &#39;(.*\\.)?google(\\..*)?$&#39;</span>
 
+<span class="sd">         - ...</span>
 
+
 
+<span class="sd">If the URL matches the pattern of ``high_priority`` AND ``low_priority``, the</span>
 
+<span class="sd">higher priority wins over the lower priority.</span>
 
+
 
+<span class="sd">Alternatively, you can also specify a file name for the **mappings** or</span>
 
+<span class="sd">**lists** to load these from an external file:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">   hostnames:</span>
 
+<span class="sd">     replace: &#39;rewrite-hosts.yml&#39;</span>
 
+<span class="sd">     remove:</span>
 
+<span class="sd">       - &#39;(.*\\.)?facebook.com$&#39;</span>
 
+<span class="sd">       - ...</span>
 
+<span class="sd">     low_priority:</span>
 
+<span class="sd">       - &#39;(.*\\.)?google(\\..*)?$&#39;</span>
 
+<span class="sd">       - ...</span>
 
+<span class="sd">     high_priority:</span>
 
+<span class="sd">       - &#39;(.*\\.)?wikipedia.org$&#39;</span>
 
+<span class="sd">       - ...</span>
 
+
 
+<span class="sd">The ``rewrite-hosts.yml`` from the example above must be in the folder in which</span>
 
+<span class="sd">the ``settings.yml`` file is already located (``/etc/searxng``). The file then</span>
 
+<span class="sd">only contains the lists or the mapping tables without further information on the</span>
 
+<span class="sd">namespaces.  In the example above, this would be a mapping table that looks</span>
 
+<span class="sd">something like this:</span>
 
+
 
+<span class="sd">.. code:: yaml</span>
 
+
 
+<span class="sd">   &#39;(.*\\.)?youtube\\.com$&#39;: &#39;invidious.example.com&#39;</span>
 
+<span class="sd">   &#39;(.*\\.)?youtu\\.be$&#39;: &#39;invidious.example.com&#39;</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</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">re</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlunparse</span><span class="p">,</span> <span class="n">urlparse</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</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">settings</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types._base</span><span class="w"> </span><span class="kn">import</span> <span class="n">MainResult</span><span class="p">,</span> <span class="n">LegacyResult</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.settings_loader</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_yaml_cfg</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">PluginInfo</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">._core</span><span class="w"> </span><span class="kn">import</span> <span class="n">log</span>
 
+
 
+<span class="k">if</span> <span class="n">typing</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">flask</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.search</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</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="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">PluginCfg</span>
 
+
 
+
 
+<span class="n">REPLACE</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">Pattern</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="n">REMOVE</span><span class="p">:</span> <span class="nb">set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+<span class="n">HIGH</span><span class="p">:</span> <span class="nb">set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+<span class="n">LOW</span><span class="p">:</span> <span class="nb">set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGPlugin">
 
+<a class="viewcode-back" href="../../../dev/plugins/hostnames.html#searx.plugins.hostnames.SXNGPlugin">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNGPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Rewrite hostnames, remove results or prioritize them.&quot;&quot;&quot;</span>
 
+
 
+    <span class="nb">id</span> <span class="o">=</span> <span class="s2">&quot;hostnames&quot;</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">plg_cfg</span><span class="p">:</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">plg_cfg</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
 
+            <span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
 
+            <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Hostnames plugin&quot;</span><span class="p">),</span>
 
+            <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Rewrite hostnames, remove results or prioritize them based on the hostname&quot;</span><span class="p">),</span>
 
+            <span class="n">preference_section</span><span class="o">=</span><span class="s2">&quot;general&quot;</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="SXNGPlugin.on_result">
 
+<a class="viewcode-back" href="../../../dev/plugins/hostnames.html#searx.plugins.hostnames.SXNGPlugin.on_result">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">on_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="s2">&quot;SXNG_Request&quot;</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">,</span> <span class="n">result</span><span class="p">:</span> <span class="n">Result</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+
 
+        <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">REMOVE</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="ow">and</span> <span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
 
+                <span class="c1"># if the link (parsed_url) of the result match, then remove the</span>
 
+                <span class="c1"># result from the result list, in any other case, the result</span>
 
+                <span class="c1"># remains in the list / see final &quot;return True&quot; below.</span>
 
+                <span class="c1"># log.debug(&quot;FIXME: remove [url/parsed_url] %s %s&quot;, pattern.pattern, result.url)</span>
 
+                <span class="k">return</span> <span class="kc">False</span>
 
+
 
+        <span class="n">result</span><span class="o">.</span><span class="n">filter_urls</span><span class="p">(</span><span class="n">filter_url_field</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="p">(</span><span class="n">MainResult</span><span class="p">,</span> <span class="n">LegacyResult</span><span class="p">)):</span>
 
+            <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">LOW</span><span class="p">:</span>
 
+                <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="ow">and</span> <span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
 
+                    <span class="n">result</span><span class="o">.</span><span class="n">priority</span> <span class="o">=</span> <span class="s2">&quot;low&quot;</span>
 
+
 
+            <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">HIGH</span><span class="p">:</span>
 
+                <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="ow">and</span> <span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
 
+                    <span class="n">result</span><span class="o">.</span><span class="n">priority</span> <span class="o">=</span> <span class="s2">&quot;high&quot;</span>
 
+
 
+        <span class="k">return</span> <span class="kc">True</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGPlugin.init">
 
+<a class="viewcode-back" href="../../../dev/plugins/hostnames.html#searx.plugins.hostnames.SXNGPlugin.init">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">:</span> <span class="s2">&quot;flask.Flask&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>  <span class="c1"># pylint: disable=unused-argument</span>
 
+        <span class="k">global</span> <span class="n">REPLACE</span><span class="p">,</span> <span class="n">REMOVE</span><span class="p">,</span> <span class="n">HIGH</span><span class="p">,</span> <span class="n">LOW</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">settings</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">id</span><span class="p">):</span>
 
+            <span class="c1"># Remove plugin, if there isn&#39;t a &quot;hostnames:&quot; setting</span>
 
+            <span class="k">return</span> <span class="kc">False</span>
 
+
 
+        <span class="n">REPLACE</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_regular_expressions</span><span class="p">(</span><span class="s2">&quot;replace&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="p">{}</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">REMOVE</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_regular_expressions</span><span class="p">(</span><span class="s2">&quot;remove&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">set</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">HIGH</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_regular_expressions</span><span class="p">(</span><span class="s2">&quot;high_priority&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">set</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">LOW</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_regular_expressions</span><span class="p">(</span><span class="s2">&quot;low_priority&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">set</span><span class="p">()</span>  <span class="c1"># type: ignore</span>
 
+
 
+        <span class="k">return</span> <span class="kc">True</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_load_regular_expressions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings_key</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">Pattern</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="nb">set</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">setting_value</span> <span class="o">=</span> <span class="n">settings</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">id</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">settings_key</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">setting_value</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="kc">None</span>
 
+
 
+        <span class="c1"># load external file with configuration</span>
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">setting_value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+            <span class="n">setting_value</span> <span class="o">=</span> <span class="n">get_yaml_cfg</span><span class="p">(</span><span class="n">setting_value</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">setting_value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 
+            <span class="k">return</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="n">r</span><span class="p">)</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">setting_value</span><span class="p">}</span>
 
+
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">setting_value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+            <span class="k">return</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="n">p</span><span class="p">):</span> <span class="n">r</span> <span class="k">for</span> <span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">r</span><span class="p">)</span> <span class="ow">in</span> <span class="n">setting_value</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
 
+
 
+        <span class="k">return</span> <span class="kc">None</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="filter_url_field">
 
+<a class="viewcode-back" href="../../../dev/plugins/hostnames.html#searx.plugins.hostnames.filter_url_field">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">filter_url_field</span><span class="p">(</span><span class="n">result</span><span class="p">:</span> <span class="s2">&quot;Result|LegacyResult&quot;</span><span class="p">,</span> <span class="n">field_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">url_src</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span> <span class="o">|</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns bool ``True`` to use URL unchanged (``False`` to ignore URL).</span>
 
+<span class="sd">    If URL should be modified, the returned string is the new URL to use.&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">url_src</span><span class="p">:</span>
 
+        <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;missing a URL in field </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">field_name</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="kc">True</span>
 
+
 
+    <span class="n">url_src_parsed</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">url</span><span class="o">=</span><span class="n">url_src</span><span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">REMOVE</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">url_src_parsed</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
 
+            <span class="k">return</span> <span class="kc">False</span>
 
+
 
+    <span class="k">for</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">replacement</span> <span class="ow">in</span> <span class="n">REPLACE</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">url_src_parsed</span><span class="o">.</span><span class="n">netloc</span><span class="p">):</span>
 
+            <span class="n">new_url</span> <span class="o">=</span> <span class="n">url_src_parsed</span><span class="o">.</span><span class="n">_replace</span><span class="p">(</span><span class="n">netloc</span><span class="o">=</span><span class="n">pattern</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="n">replacement</span><span class="p">,</span> <span class="n">url_src_parsed</span><span class="o">.</span><span class="n">netloc</span><span class="p">))</span>
 
+            <span class="n">new_url</span> <span class="o">=</span> <span class="n">urlunparse</span><span class="p">(</span><span class="n">new_url</span><span class="p">)</span>
 
+            <span class="k">return</span> <span class="n">new_url</span>
 
+
 
+    <span class="k">return</span> <span class="kc">True</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 167 - 0
_modules/searx/plugins/self_info.html
View File 

@@ -0,0 +1,167 @@
 
+<!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.plugins.self_info &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.plugins.self_info</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.plugins.self_info</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, missing-class-docstring</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</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">re</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.botdetection._helpers</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_real_ip</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="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">PluginInfo</span>
 
+
 
+<span class="k">if</span> <span class="n">typing</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">PluginCfg</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGPlugin">
 
+<a class="viewcode-back" href="../../../dev/plugins/self_info.html#searx.plugins.self_info.SXNGPlugin">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNGPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Simple plugin that displays information about user&#39;s request, including</span>
 
+<span class="sd">    the IP or HTTP User-Agent.  The information is displayed in area for the</span>
 
+<span class="sd">    &quot;answers&quot;.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="nb">id</span> <span class="o">=</span> <span class="s2">&quot;self_info&quot;</span>
 
+    <span class="n">keywords</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;ip&quot;</span><span class="p">,</span> <span class="s2">&quot;user-agent&quot;</span><span class="p">]</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">plg_cfg</span><span class="p">:</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">plg_cfg</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">ip_regex</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">&quot;^ip&quot;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">ua_regex</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">&quot;^user-agent&quot;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
 
+            <span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
 
+            <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Self Information&quot;</span><span class="p">),</span>
 
+            <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span>
 
+<span class="w">                </span><span class="sd">&quot;&quot;&quot;Displays your IP if the query is &quot;ip&quot; and your user agent if the query is &quot;user-agent&quot;.&quot;&quot;&quot;</span>
 
+            <span class="p">),</span>
 
+            <span class="n">preference_section</span><span class="o">=</span><span class="s2">&quot;query&quot;</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="SXNGPlugin.post_search">
 
+<a class="viewcode-back" href="../../../dev/plugins/self_info.html#searx.plugins.self_info.SXNGPlugin.post_search">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="s2">&quot;SXNG_Request&quot;</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a result list only for the first page.&quot;&quot;&quot;</span>
 
+        <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+        <span class="k">if</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ip_regex</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">):</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Your IP is: &quot;</span><span class="p">)</span> <span class="o">+</span> <span class="n">get_real_ip</span><span class="p">(</span><span class="n">request</span><span class="p">)))</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ua_regex</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">):</span>
 
+            <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Your user-agent is: &quot;</span><span class="p">)</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">user_agent</span><span class="p">)))</span>
 
+
 
+        <span class="k">return</span> <span class="n">results</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 189 - 0
_modules/searx/plugins/tor_check.html
View File 

@@ -0,0 +1,189 @@
 
+<!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.plugins.tor_check &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.plugins.tor_check</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.plugins.tor_check</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;A plugin to check if the ip address of the request is a Tor exit-node if the</span>
 
+<span class="sd">user searches for ``tor-check``.  It fetches the tor exit node list from</span>
 
+<span class="sd">:py:obj:`url_exit_list` and parses all the IPs into a list, then checks if the</span>
 
+<span class="sd">user&#39;s IP address is in it.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</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">re</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">httpx</span><span class="w"> </span><span class="kn">import</span> <span class="n">HTTPError</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</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">PluginInfo</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="kn">from</span><span class="w"> </span><span class="nn">searx.botdetection</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_real_ip</span>
 
+
 
+<span class="k">if</span> <span class="n">typing</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">PluginCfg</span>
 
+
 
+
 
+<span class="c1"># Regex for exit node addresses in the list.</span>
 
+<span class="n">reg</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">&quot;(?&lt;=ExitAddress )\S+&quot;</span><span class="p">)</span>
 
+
 
+<span class="n">url_exit_list</span> <span class="o">=</span> <span class="s2">&quot;https://check.torproject.org/exit-addresses&quot;</span>
 
+<span class="sd">&quot;&quot;&quot;URL to load Tor exit list from.&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGPlugin">
 
+<a class="viewcode-back" href="../../../dev/plugins/tor_check.html#searx.plugins.tor_check.SXNGPlugin">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNGPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Rewrite hostnames, remove results or prioritize them.&quot;&quot;&quot;</span>
 
+
 
+    <span class="nb">id</span> <span class="o">=</span> <span class="s2">&quot;tor_check&quot;</span>
 
+    <span class="n">keywords</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;tor-check&quot;</span><span class="p">]</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">plg_cfg</span><span class="p">:</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">plg_cfg</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
 
+            <span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
 
+            <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Tor check plugin&quot;</span><span class="p">),</span>
 
+            <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span>
 
+                <span class="s2">&quot;This plugin checks if the address of the request is a Tor exit-node, and&quot;</span>
 
+                <span class="s2">&quot; informs the user if it is; like check.torproject.org, but from SearXNG.&quot;</span>
 
+            <span class="p">),</span>
 
+            <span class="n">preference_section</span><span class="o">=</span><span class="s2">&quot;query&quot;</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="SXNGPlugin.post_search">
 
+<a class="viewcode-back" href="../../../dev/plugins/tor_check.html#searx.plugins.tor_check.SXNGPlugin.post_search">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="s2">&quot;SXNG_Request&quot;</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+        <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+        <span class="k">if</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="k">if</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;tor-check&quot;</span><span class="p">:</span>
 
+
 
+            <span class="c1"># Request the list of tor exit nodes.</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="n">resp</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">url_exit_list</span><span class="p">)</span>
 
+                <span class="n">node_list</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">reg</span><span class="p">,</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+
 
+            <span class="k">except</span> <span class="n">HTTPError</span><span class="p">:</span>
 
+                <span class="c1"># No answer, return error</span>
 
+                <span class="n">msg</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Could not download the list of Tor exit-nodes from&quot;</span><span class="p">)</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">msg</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">url_exit_list</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
 
+                <span class="k">return</span> <span class="n">results</span>
 
+
 
+            <span class="n">real_ip</span> <span class="o">=</span> <span class="n">get_real_ip</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
 
+
 
+            <span class="k">if</span> <span class="n">real_ip</span> <span class="ow">in</span> <span class="n">node_list</span><span class="p">:</span>
 
+                <span class="n">msg</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;You are using Tor and it looks like you have the external IP address&quot;</span><span class="p">)</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">msg</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">real_ip</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
 
+
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">msg</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;You are not using Tor and you have the external IP address&quot;</span><span class="p">)</span>
 
+                <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">msg</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">real_ip</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
 
+
 
+        <span class="k">return</span> <span class="n">results</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 396 - 0
_modules/searx/plugins/unit_converter.html
View File 

@@ -0,0 +1,396 @@
 
+<!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.plugins.unit_converter &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.plugins.unit_converter</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.plugins.unit_converter</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;A plugin for converting measured values from one unit to another unit (a</span>
 
+<span class="sd">unit converter).</span>
 
+
 
+<span class="sd">The plugin looks up the symbols (given in the query term) in a list of</span>
 
+<span class="sd">converters, each converter is one item in the list (compare</span>
 
+<span class="sd">:py:obj:`ADDITIONAL_UNITS`).  If the symbols are ambiguous, the matching units</span>
 
+<span class="sd">of measurement are evaluated.  The weighting in the evaluation results from the</span>
 
+<span class="sd">sorting of the :py:obj:`list of unit converters&lt;symbol_to_si&gt;`.</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</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">re</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">babel.numbers</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span><span class="p">,</span> <span class="n">get_locale</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">data</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">PluginInfo</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">if</span> <span class="n">typing</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
 
+    <span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">PluginCfg</span>
 
+
 
+
 
+<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="n">description</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+
 
+<span class="n">plugin_id</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="n">preference_section</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+
 
+<span class="n">CONVERT_KEYWORDS</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;in&quot;</span><span class="p">,</span> <span class="s2">&quot;to&quot;</span><span class="p">,</span> <span class="s2">&quot;as&quot;</span><span class="p">]</span>
 
+
 
+
 
+<div class="viewcode-block" id="SXNGPlugin">
 
+<a class="viewcode-back" href="../../../dev/plugins/unit_converter.html#searx.plugins.unit_converter.SXNGPlugin">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SXNGPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Convert between units.  The result is displayed in area for the</span>
 
+<span class="sd">    &quot;answers&quot;.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="nb">id</span> <span class="o">=</span> <span class="s2">&quot;unit_converter&quot;</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">plg_cfg</span><span class="p">:</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">plg_cfg</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
 
+            <span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
 
+            <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Unit converter plugin&quot;</span><span class="p">),</span>
 
+            <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Convert between units&quot;</span><span class="p">),</span>
 
+            <span class="n">preference_section</span><span class="o">=</span><span class="s2">&quot;general&quot;</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="SXNGPlugin.post_search">
 
+<a class="viewcode-back" href="../../../dev/plugins/unit_converter.html#searx.plugins.unit_converter.SXNGPlugin.post_search">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="s2">&quot;SXNG_Request&quot;</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
 
+        <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
 
+
 
+        <span class="c1"># only convert between units on the first page</span>
 
+        <span class="k">if</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="n">query</span> <span class="o">=</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span>
 
+        <span class="n">query_parts</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">query_parts</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">3</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">results</span>
 
+
 
+        <span class="k">for</span> <span class="n">query_part</span> <span class="ow">in</span> <span class="n">query_parts</span><span class="p">:</span>
 
+            <span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">CONVERT_KEYWORDS</span><span class="p">:</span>
 
+                <span class="k">if</span> <span class="n">query_part</span> <span class="o">==</span> <span class="n">keyword</span><span class="p">:</span>
 
+                    <span class="n">from_query</span><span class="p">,</span> <span class="n">to_query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
 
+                    <span class="n">target_val</span> <span class="o">=</span> <span class="n">_parse_text_and_convert</span><span class="p">(</span><span class="n">from_query</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span> <span class="n">to_query</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
 
+                    <span class="k">if</span> <span class="n">target_val</span><span class="p">:</span>
 
+                        <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="n">target_val</span><span class="p">))</span>
 
+
 
+        <span class="k">return</span> <span class="n">results</span></div>
 
+</div>
 
+
 
+
 
+
 
+<span class="c1"># inspired from https://stackoverflow.com/a/42475086</span>
 
+<span class="n">RE_MEASURE</span> <span class="o">=</span> <span class="sa">r</span><span class="s1">&#39;&#39;&#39;</span>
 
+<span class="s1">(?P&lt;sign&gt;[-+]?)         # +/- or nothing for positive</span>
 
+<span class="s1">(\s*)                   # separator: white space or nothing</span>
 
+<span class="s1">(?P&lt;number&gt;[\d\.,]*)    # number: 1,000.00 (en) or 1.000,00 (de)</span>
 
+<span class="s1">(?P&lt;E&gt;[eE][-+]?\d+)?    # scientific notation: e(+/-)2 (*10^2)</span>
 
+<span class="s1">(\s*)                   # separator: white space or nothing</span>
 
+<span class="s1">(?P&lt;unit&gt;\S+)           # unit of measure</span>
 
+<span class="s1">&#39;&#39;&#39;</span>
 
+
 
+
 
+<span class="n">ADDITIONAL_UNITS</span> <span class="o">=</span> <span class="p">[</span>
 
+    <span class="p">{</span>
 
+        <span class="s2">&quot;si_name&quot;</span><span class="p">:</span> <span class="s2">&quot;Q11579&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;symbol&quot;</span><span class="p">:</span> <span class="s2">&quot;°C&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;to_si&quot;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">val</span><span class="p">:</span> <span class="n">val</span> <span class="o">+</span> <span class="mf">273.15</span><span class="p">,</span>
 
+        <span class="s2">&quot;from_si&quot;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">val</span><span class="p">:</span> <span class="n">val</span> <span class="o">-</span> <span class="mf">273.15</span><span class="p">,</span>
 
+    <span class="p">},</span>
 
+    <span class="p">{</span>
 
+        <span class="s2">&quot;si_name&quot;</span><span class="p">:</span> <span class="s2">&quot;Q11579&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;symbol&quot;</span><span class="p">:</span> <span class="s2">&quot;°F&quot;</span><span class="p">,</span>
 
+        <span class="s2">&quot;to_si&quot;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">val</span><span class="p">:</span> <span class="p">(</span><span class="n">val</span> <span class="o">+</span> <span class="mf">459.67</span><span class="p">)</span> <span class="o">*</span> <span class="mi">5</span> <span class="o">/</span> <span class="mi">9</span><span class="p">,</span>
 
+        <span class="s2">&quot;from_si&quot;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">val</span><span class="p">:</span> <span class="p">(</span><span class="n">val</span> <span class="o">*</span> <span class="mi">9</span> <span class="o">/</span> <span class="mi">5</span><span class="p">)</span> <span class="o">-</span> <span class="mf">459.67</span><span class="p">,</span>
 
+    <span class="p">},</span>
 
+<span class="p">]</span>
 
+<span class="sd">&quot;&quot;&quot;Additional items to convert from a measure unit to a SI unit (vice versa).</span>
 
+
 
+<span class="sd">.. code:: python</span>
 
+
 
+<span class="sd">    {</span>
 
+<span class="sd">        &quot;si_name&quot;: &quot;Q11579&quot;,                 # Wikidata item ID of the SI unit (Kelvin)</span>
 
+<span class="sd">        &quot;symbol&quot;: &quot;°C&quot;,                      # symbol of the measure unit</span>
 
+<span class="sd">        &quot;to_si&quot;: lambda val: val + 273.15,   # convert measure value (val) to SI unit</span>
 
+<span class="sd">        &quot;from_si&quot;: lambda val: val - 273.15, # convert SI value (val) measure unit</span>
 
+<span class="sd">    },</span>
 
+<span class="sd">    {</span>
 
+<span class="sd">        &quot;si_name&quot;: &quot;Q11573&quot;,</span>
 
+<span class="sd">        &quot;symbol&quot;: &quot;mi&quot;,</span>
 
+<span class="sd">        &quot;to_si&quot;: 1609.344,                   # convert measure value (val) to SI unit</span>
 
+<span class="sd">        &quot;from_si&quot;: 1 / 1609.344              # convert SI value (val) measure unit</span>
 
+<span class="sd">    },</span>
 
+
 
+<span class="sd">The values of ``to_si`` and ``from_si`` can be of :py:obj:`float` (a multiplier)</span>
 
+<span class="sd">or a callable_ (val in / converted value returned).</span>
 
+
 
+<span class="sd">.. _callable: https://docs.python.org/3/glossary.html#term-callable</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="n">ALIAS_SYMBOLS</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;°C&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;C&#39;</span><span class="p">,),</span>
 
+    <span class="s1">&#39;°F&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;F&#39;</span><span class="p">,),</span>
 
+    <span class="s1">&#39;mi&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;L&#39;</span><span class="p">,),</span>
 
+<span class="p">}</span>
 
+<span class="sd">&quot;&quot;&quot;Alias symbols for known unit of measure symbols / by example::</span>
 
+
 
+<span class="sd">    &#39;°C&#39;: (&#39;C&#39;, ...),  # list of alias symbols for °C (Q69362731)</span>
 
+<span class="sd">    &#39;°F&#39;: (&#39;F&#39;, ...),  # list of alias symbols for °F (Q99490479)</span>
 
+<span class="sd">    &#39;mi&#39;: (&#39;L&#39;,),      # list of alias symbols for mi (Q253276)</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="n">SYMBOL_TO_SI</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+
 
+<div class="viewcode-block" id="symbol_to_si">
 
+<a class="viewcode-back" href="../../../dev/plugins/unit_converter.html#searx.plugins.unit_converter.symbol_to_si">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">symbol_to_si</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Generates a list of tuples, each tuple is a measure unit and the fields</span>
 
+<span class="sd">    in the tuple are:</span>
 
+
 
+<span class="sd">    0. Symbol of the measure unit (e.g. &#39;mi&#39; for measure unit &#39;miles&#39; Q253276)</span>
 
+
 
+<span class="sd">    1. SI name of the measure unit (e.g. Q11573 for SI unit &#39;metre&#39;)</span>
 
+
 
+<span class="sd">    2. Factor to get SI value from measure unit (e.g. 1mi is equal to SI 1m</span>
 
+<span class="sd">       multiplied by 1609.344)</span>
 
+
 
+<span class="sd">    3. Factor to get measure value from from SI value (e.g. SI 100m is equal to</span>
 
+<span class="sd">       100mi divided by 1609.344)</span>
 
+
 
+<span class="sd">    The returned list is sorted, the first items are created from</span>
 
+<span class="sd">    ``WIKIDATA_UNITS``, the second group of items is build from</span>
 
+<span class="sd">    :py:obj:`ADDITIONAL_UNITS` and items created from :py:obj:`ALIAS_SYMBOLS`.</span>
 
+
 
+<span class="sd">    If you search this list for a symbol, then a match with a symbol from</span>
 
+<span class="sd">    Wikidata has the highest weighting (first hit in the list), followed by the</span>
 
+<span class="sd">    symbols from the :py:obj:`ADDITIONAL_UNITS` and the lowest weighting is</span>
 
+<span class="sd">    given to the symbols resulting from the aliases :py:obj:`ALIAS_SYMBOLS`.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="k">global</span> <span class="n">SYMBOL_TO_SI</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+    <span class="k">if</span> <span class="n">SYMBOL_TO_SI</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">SYMBOL_TO_SI</span>
 
+
 
+    <span class="c1"># filter out units which can&#39;t be normalized to a SI unit and filter out</span>
 
+    <span class="c1"># units without a symbol / arcsecond does not have a symbol</span>
 
+    <span class="c1"># https://www.wikidata.org/wiki/Q829073</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">WIKIDATA_UNITS</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;to_si_factor&#39;</span><span class="p">]</span> <span class="ow">and</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">]:</span>
 
+            <span class="n">SYMBOL_TO_SI</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                <span class="p">(</span>
 
+                    <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">],</span>
 
+                    <span class="n">item</span><span class="p">[</span><span class="s1">&#39;si_name&#39;</span><span class="p">],</span>
 
+                    <span class="mi">1</span> <span class="o">/</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;to_si_factor&#39;</span><span class="p">],</span>  <span class="c1"># from_si</span>
 
+                    <span class="n">item</span><span class="p">[</span><span class="s1">&#39;to_si_factor&#39;</span><span class="p">],</span>  <span class="c1"># to_si</span>
 
+                    <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">],</span>
 
+                <span class="p">)</span>
 
+            <span class="p">)</span>
 
+
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">ADDITIONAL_UNITS</span><span class="p">:</span>
 
+        <span class="n">SYMBOL_TO_SI</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+            <span class="p">(</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">],</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;si_name&#39;</span><span class="p">],</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;from_si&#39;</span><span class="p">],</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;to_si&#39;</span><span class="p">],</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">],</span>
 
+            <span class="p">)</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="n">alias_items</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">SYMBOL_TO_SI</span><span class="p">:</span>
 
+        <span class="k">for</span> <span class="n">alias</span> <span class="ow">in</span> <span class="n">ALIAS_SYMBOLS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">()):</span>
 
+            <span class="n">alias_items</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
 
+                <span class="p">(</span>
 
+                    <span class="n">alias</span><span class="p">,</span>
 
+                    <span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span>
 
+                    <span class="n">item</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span>  <span class="c1"># from_si</span>
 
+                    <span class="n">item</span><span class="p">[</span><span class="mi">3</span><span class="p">],</span>  <span class="c1"># to_si</span>
 
+                    <span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>  <span class="c1"># origin unit</span>
 
+                <span class="p">)</span>
 
+            <span class="p">)</span>
 
+    <span class="n">SYMBOL_TO_SI</span> <span class="o">=</span> <span class="n">SYMBOL_TO_SI</span> <span class="o">+</span> <span class="n">alias_items</span>
 
+    <span class="k">return</span> <span class="n">SYMBOL_TO_SI</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_parse_text_and_convert</span><span class="p">(</span><span class="n">from_query</span><span class="p">,</span> <span class="n">to_query</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+
 
+    <span class="c1"># pylint: disable=too-many-branches, too-many-locals</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">from_query</span> <span class="ow">and</span> <span class="n">to_query</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="n">measured</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">RE_MEASURE</span><span class="p">,</span> <span class="n">from_query</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">VERBOSE</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">measured</span> <span class="ow">and</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;number&#39;</span><span class="p">),</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;unit&#39;</span><span class="p">)):</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="c1"># Symbols are not unique, if there are several hits for the from-unit, then</span>
 
+    <span class="c1"># the correct one must be determined by comparing it with the to-unit</span>
 
+    <span class="c1"># https://github.com/searxng/searxng/pull/3378#issuecomment-2080974863</span>
 
+
 
+    <span class="c1"># first: collecting possible units</span>
 
+
 
+    <span class="n">source_list</span><span class="p">,</span> <span class="n">target_list</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
 
+
 
+    <span class="k">for</span> <span class="n">symbol</span><span class="p">,</span> <span class="n">si_name</span><span class="p">,</span> <span class="n">from_si</span><span class="p">,</span> <span class="n">to_si</span><span class="p">,</span> <span class="n">orig_symbol</span> <span class="ow">in</span> <span class="n">symbol_to_si</span><span class="p">():</span>
 
+
 
+        <span class="k">if</span> <span class="n">symbol</span> <span class="o">==</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;unit&#39;</span><span class="p">):</span>
 
+            <span class="n">source_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">si_name</span><span class="p">,</span> <span class="n">to_si</span><span class="p">))</span>
 
+        <span class="k">if</span> <span class="n">symbol</span> <span class="o">==</span> <span class="n">to_query</span><span class="p">:</span>
 
+            <span class="n">target_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">si_name</span><span class="p">,</span> <span class="n">from_si</span><span class="p">,</span> <span class="n">orig_symbol</span><span class="p">))</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">source_list</span> <span class="ow">and</span> <span class="n">target_list</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="n">source_to_si</span> <span class="o">=</span> <span class="n">target_from_si</span> <span class="o">=</span> <span class="n">target_symbol</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+    <span class="c1"># second: find the right unit by comparing list of from-units with list of to-units</span>
 
+
 
+    <span class="k">for</span> <span class="n">source</span> <span class="ow">in</span> <span class="n">source_list</span><span class="p">:</span>
 
+        <span class="k">for</span> <span class="n">target</span> <span class="ow">in</span> <span class="n">target_list</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="n">source</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">target</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>  <span class="c1"># compare si_name</span>
 
+                <span class="n">source_to_si</span> <span class="o">=</span> <span class="n">source</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+                <span class="n">target_from_si</span> <span class="o">=</span> <span class="n">target</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+                <span class="n">target_symbol</span> <span class="o">=</span> <span class="n">target</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">source_to_si</span> <span class="ow">and</span> <span class="n">target_from_si</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="n">_locale</span> <span class="o">=</span> <span class="n">get_locale</span><span class="p">()</span> <span class="ow">or</span> <span class="s1">&#39;en_US&#39;</span>
 
+
 
+    <span class="n">value</span> <span class="o">=</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;sign&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;number&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="p">(</span><span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;E&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+    <span class="n">value</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">parse_decimal</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">_locale</span><span class="p">)</span>
 
+
 
+    <span class="c1"># convert value to SI unit</span>
 
+
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source_to_si</span><span class="p">,</span> <span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="nb">int</span><span class="p">)):</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">*</span> <span class="n">source_to_si</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">source_to_si</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
 
+
 
+    <span class="c1"># convert value from SI unit to target unit</span>
 
+
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">target_from_si</span><span class="p">,</span> <span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="nb">int</span><span class="p">)):</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">*</span> <span class="n">target_from_si</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">value</span> <span class="o">=</span> <span class="n">target_from_si</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
 
+
 
+    <span class="k">if</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;E&#39;</span><span class="p">):</span>
 
+        <span class="c1"># when incoming notation is scientific, outgoing notation is scientific</span>
 
+        <span class="n">result</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">format_scientific</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">_locale</span><span class="p">)</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">result</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">format_decimal</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">_locale</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">&#39;#,##0.##########;-#&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">result</span><span class="si">}</span><span class="s1"> </span><span class="si">{</span><span class="n">target_symbol</span><span class="si">}</span><span class="s1">&#39;</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 362 - 0
_modules/searx/redislib.html
View File 

@@ -0,0 +1,362 @@
 
+<!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.redislib &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.redislib</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.redislib</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;A collection of convenient functions and redis/lua scripts.</span>
 
+
 
+<span class="sd">This code was partial inspired by the `Bullet-Proofing Lua Scripts in RedisPy`_</span>
 
+<span class="sd">article.</span>
 
+
 
+<span class="sd">.. _Bullet-Proofing Lua Scripts in RedisPy:</span>
 
+<span class="sd">   https://redis.com/blog/bullet-proofing-lua-scripts-in-redispy/</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">hmac</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="n">LUA_SCRIPT_STORAGE</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="sd">&quot;&quot;&quot;A global dictionary to cache client&#39;s ``Script`` objects, used by</span>
 
+<span class="sd">:py:obj:`lua_script_storage`&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="lua_script_storage">
 
+<a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.lua_script_storage">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">lua_script_storage</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">script</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a redis :py:obj:`Script</span>
 
+<span class="sd">    &lt;redis.commands.core.CoreCommands.register_script&gt;` instance.</span>
 
+
 
+<span class="sd">    Due to performance reason the ``Script`` object is instantiated only once</span>
 
+<span class="sd">    for a client (``client.register_script(..)``) and is cached in</span>
 
+<span class="sd">    :py:obj:`LUA_SCRIPT_STORAGE`.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># redis connection can be closed, lets use the id() of the redis connector</span>
 
+    <span class="c1"># as key in the script-storage:</span>
 
+    <span class="n">client_id</span> <span class="o">=</span> <span class="nb">id</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">LUA_SCRIPT_STORAGE</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">client_id</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">LUA_SCRIPT_STORAGE</span><span class="p">[</span><span class="n">client_id</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+    <span class="k">if</span> <span class="n">LUA_SCRIPT_STORAGE</span><span class="p">[</span><span class="n">client_id</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">script</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">LUA_SCRIPT_STORAGE</span><span class="p">[</span><span class="n">client_id</span><span class="p">][</span><span class="n">script</span><span class="p">]</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">register_script</span><span class="p">(</span><span class="n">script</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">LUA_SCRIPT_STORAGE</span><span class="p">[</span><span class="n">client_id</span><span class="p">][</span><span class="n">script</span><span class="p">]</span></div>
 
+
 
+
 
+
 
+<span class="n">PURGE_BY_PREFIX</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
 
+<span class="s2">local prefix = tostring(ARGV[1])</span>
 
+<span class="s2">for i, name in ipairs(redis.call(&#39;KEYS&#39;, prefix .. &#39;*&#39;)) do</span>
 
+<span class="s2">    redis.call(&#39;EXPIRE&#39;, name, 0)</span>
 
+<span class="s2">end</span>
 
+<span class="s2">&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="purge_by_prefix">
 
+<a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.purge_by_prefix">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">purge_by_prefix</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">prefix</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;SearXNG_&quot;</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Purge all keys with ``prefix`` from database.</span>
 
+
 
+<span class="sd">    Queries all keys in the database by the given prefix and set expire time to</span>
 
+<span class="sd">    zero.  The default prefix will drop all keys which has been set by SearXNG</span>
 
+<span class="sd">    (drops SearXNG schema entirely from database).</span>
 
+
 
+<span class="sd">    The implementation is the lua script from string :py:obj:`PURGE_BY_PREFIX`.</span>
 
+<span class="sd">    The lua script uses EXPIRE_ instead of DEL_: if there are a lot keys to</span>
 
+<span class="sd">    delete and/or their values are big, `DEL` could take more time and blocks</span>
 
+<span class="sd">    the command loop while `EXPIRE` turns back immediate.</span>
 
+
 
+<span class="sd">    :param prefix: prefix of the key to delete (default: ``SearXNG_``)</span>
 
+<span class="sd">    :type name: str</span>
 
+
 
+<span class="sd">    .. _EXPIRE: https://redis.io/commands/expire/</span>
 
+<span class="sd">    .. _DEL: https://redis.io/commands/del/</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">script</span> <span class="o">=</span> <span class="n">lua_script_storage</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">PURGE_BY_PREFIX</span><span class="p">)</span>
 
+    <span class="n">script</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="n">prefix</span><span class="p">])</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="secret_hash">
 
+<a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.secret_hash">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">secret_hash</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="w">    </span><span class="sd">&quot;&quot;&quot;Creates a hash of the ``name``.</span>
 
+
 
+<span class="sd">    Combines argument ``name`` with the ``secret_key`` from :ref:`settings</span>
 
+<span class="sd">    server`.  This function can be used to get a more anonymized name of a Redis</span>
 
+<span class="sd">    KEY.</span>
 
+
 
+<span class="sd">    :param name: the name to create a secret hash for</span>
 
+<span class="sd">    :type name: str</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">m</span> <span class="o">=</span> <span class="n">hmac</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">bytes</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">),</span> <span class="n">digestmod</span><span class="o">=</span><span class="s1">&#39;sha256&#39;</span><span class="p">)</span>
 
+    <span class="n">m</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="nb">bytes</span><span class="p">(</span><span class="n">get_setting</span><span class="p">(</span><span class="s1">&#39;server.secret_key&#39;</span><span class="p">),</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">))</span>
 
+    <span class="k">return</span> <span class="n">m</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span></div>
 
+
 
+
 
+
 
+<span class="n">INCR_COUNTER</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
 
+<span class="s2">local limit = tonumber(ARGV[1])</span>
 
+<span class="s2">local expire = tonumber(ARGV[2])</span>
 
+<span class="s2">local c_name = KEYS[1]</span>
 
+
 
+<span class="s2">local c = redis.call(&#39;GET&#39;, c_name)</span>
 
+
 
+<span class="s2">if not c then</span>
 
+<span class="s2">    c = redis.call(&#39;INCR&#39;, c_name)</span>
 
+<span class="s2">    if expire &gt; 0 then</span>
 
+<span class="s2">        redis.call(&#39;EXPIRE&#39;, c_name, expire)</span>
 
+<span class="s2">    end</span>
 
+<span class="s2">else</span>
 
+<span class="s2">    c = tonumber(c)</span>
 
+<span class="s2">    if limit == 0 or c &lt; limit then</span>
 
+<span class="s2">       c = redis.call(&#39;INCR&#39;, c_name)</span>
 
+<span class="s2">    end</span>
 
+<span class="s2">end</span>
 
+<span class="s2">return c</span>
 
+<span class="s2">&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="incr_counter">
 
+<a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.incr_counter">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">incr_counter</span><span class="p">(</span><span class="n">client</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">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">expire</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Increment a counter and return the new value.</span>
 
+
 
+<span class="sd">    If counter with redis key ``SearXNG_counter_&lt;name&gt;`` does not exists it is</span>
 
+<span class="sd">    created with initial value 1 returned.  The replacement ``&lt;name&gt;`` is a</span>
 
+<span class="sd">    *secret hash* of the value from argument ``name`` (see</span>
 
+<span class="sd">    :py:func:`secret_hash`).</span>
 
+
 
+<span class="sd">    The implementation of the redis counter is the lua script from string</span>
 
+<span class="sd">    :py:obj:`INCR_COUNTER`.</span>
 
+
 
+<span class="sd">    :param name: name of the counter</span>
 
+<span class="sd">    :type name: str</span>
 
+
 
+<span class="sd">    :param expire: live-time of the counter in seconds (default ``None`` means</span>
 
+<span class="sd">      infinite).</span>
 
+<span class="sd">    :type expire: int / see EXPIRE_</span>
 
+
 
+<span class="sd">    :param limit: limit where the counter stops to increment (default ``None``)</span>
 
+<span class="sd">    :type limit: int / limit is 2^64 see INCR_</span>
 
+
 
+<span class="sd">    :return: value of the incremented counter</span>
 
+<span class="sd">    :type return: int</span>
 
+
 
+<span class="sd">    .. _EXPIRE: https://redis.io/commands/expire/</span>
 
+<span class="sd">    .. _INCR: https://redis.io/commands/incr/</span>
 
+
 
+<span class="sd">    A simple demo of a counter with expire time and limit::</span>
 
+
 
+<span class="sd">      &gt;&gt;&gt; for i in range(6):</span>
 
+<span class="sd">      ...   i, incr_counter(client, &quot;foo&quot;, 3, 5) # max 3, duration 5 sec</span>
 
+<span class="sd">      ...   time.sleep(1) # from the third call on max has been reached</span>
 
+<span class="sd">      ...</span>
 
+<span class="sd">      (0, 1)</span>
 
+<span class="sd">      (1, 2)</span>
 
+<span class="sd">      (2, 3)</span>
 
+<span class="sd">      (3, 3)</span>
 
+<span class="sd">      (4, 3)</span>
 
+<span class="sd">      (5, 1)</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">script</span> <span class="o">=</span> <span class="n">lua_script_storage</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">INCR_COUNTER</span><span class="p">)</span>
 
+    <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;SearXNG_counter_&quot;</span> <span class="o">+</span> <span class="n">secret_hash</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+    <span class="n">c</span> <span class="o">=</span> <span class="n">script</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="n">limit</span><span class="p">,</span> <span class="n">expire</span><span class="p">],</span> <span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="n">name</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">c</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="drop_counter">
 
+<a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.drop_counter">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">drop_counter</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Drop counter with redis key ``SearXNG_counter_&lt;name&gt;``</span>
 
+
 
+<span class="sd">    The replacement ``&lt;name&gt;`` is a *secret hash* of the value from argument</span>
 
+<span class="sd">    ``name`` (see :py:func:`incr_counter` and :py:func:`incr_sliding_window`).</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;SearXNG_counter_&quot;</span> <span class="o">+</span> <span class="n">secret_hash</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+    <span class="n">client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<span class="n">INCR_SLIDING_WINDOW</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
 
+<span class="s2">local expire = tonumber(ARGV[1])</span>
 
+<span class="s2">local name = KEYS[1]</span>
 
+<span class="s2">local current_time = redis.call(&#39;TIME&#39;)</span>
 
+
 
+<span class="s2">redis.call(&#39;ZREMRANGEBYSCORE&#39;, name, 0, current_time[1] - expire)</span>
 
+<span class="s2">redis.call(&#39;ZADD&#39;, name, current_time[1], current_time[1] .. current_time[2])</span>
 
+<span class="s2">local result = redis.call(&#39;ZCOUNT&#39;, name, 0, current_time[1] + 1)</span>
 
+<span class="s2">redis.call(&#39;EXPIRE&#39;, name, expire)</span>
 
+<span class="s2">return result</span>
 
+<span class="s2">&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="incr_sliding_window">
 
+<a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.incr_sliding_window">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">incr_sliding_window</span><span class="p">(</span><span class="n">client</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">duration</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Increment a sliding-window counter and return the new value.</span>
 
+
 
+<span class="sd">    If counter with redis key ``SearXNG_counter_&lt;name&gt;`` does not exists it is</span>
 
+<span class="sd">    created with initial value 1 returned.  The replacement ``&lt;name&gt;`` is a</span>
 
+<span class="sd">    *secret hash* of the value from argument ``name`` (see</span>
 
+<span class="sd">    :py:func:`secret_hash`).</span>
 
+
 
+<span class="sd">    :param name: name of the counter</span>
 
+<span class="sd">    :type name: str</span>
 
+
 
+<span class="sd">    :param duration: live-time of the sliding window in seconds</span>
 
+<span class="sd">    :typeduration: int</span>
 
+
 
+<span class="sd">    :return: value of the incremented counter</span>
 
+<span class="sd">    :type return: int</span>
 
+
 
+<span class="sd">    The implementation of the redis counter is the lua script from string</span>
 
+<span class="sd">    :py:obj:`INCR_SLIDING_WINDOW`.  The lua script uses `sorted sets in Redis`_</span>
 
+<span class="sd">    to implement a sliding window for the redis key ``SearXNG_counter_&lt;name&gt;``</span>
 
+<span class="sd">    (ZADD_).  The current TIME_ is used to score the items in the sorted set and</span>
 
+<span class="sd">    the time window is moved by removing items with a score lower current time</span>
 
+<span class="sd">    minus *duration* time (ZREMRANGEBYSCORE_).</span>
 
+
 
+<span class="sd">    The EXPIRE_ time (the duration of the sliding window) is refreshed on each</span>
 
+<span class="sd">    call (increment) and if there is no call in this duration, the sorted</span>
 
+<span class="sd">    set expires from the redis DB.</span>
 
+
 
+<span class="sd">    The return value is the amount of items in the sorted set (ZCOUNT_), what</span>
 
+<span class="sd">    means the number of calls in the sliding window.</span>
 
+
 
+<span class="sd">    .. _Sorted sets in Redis:</span>
 
+<span class="sd">       https://redis.com/ebook/part-1-getting-started/chapter-1-getting-to-know-redis/1-2-what-redis-data-structures-look-like/1-2-5-sorted-sets-in-redis/</span>
 
+<span class="sd">    .. _TIME: https://redis.io/commands/time/</span>
 
+<span class="sd">    .. _ZADD: https://redis.io/commands/zadd/</span>
 
+<span class="sd">    .. _EXPIRE: https://redis.io/commands/expire/</span>
 
+<span class="sd">    .. _ZREMRANGEBYSCORE: https://redis.io/commands/zremrangebyscore/</span>
 
+<span class="sd">    .. _ZCOUNT: https://redis.io/commands/zcount/</span>
 
+
 
+<span class="sd">    A simple demo of the sliding window::</span>
 
+
 
+<span class="sd">      &gt;&gt;&gt; for i in range(5):</span>
 
+<span class="sd">      ...   incr_sliding_window(client, &quot;foo&quot;, 3) # duration 3 sec</span>
 
+<span class="sd">      ...   time.sleep(1) # from the third call (second) on the window is moved</span>
 
+<span class="sd">      ...</span>
 
+<span class="sd">      1</span>
 
+<span class="sd">      2</span>
 
+<span class="sd">      3</span>
 
+<span class="sd">      3</span>
 
+<span class="sd">      3</span>
 
+<span class="sd">      &gt;&gt;&gt; time.sleep(3)  # wait until expire</span>
 
+<span class="sd">      &gt;&gt;&gt; incr_sliding_window(client, &quot;foo&quot;, 3)</span>
 
+<span class="sd">      1</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">script</span> <span class="o">=</span> <span class="n">lua_script_storage</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">INCR_SLIDING_WINDOW</span><span class="p">)</span>
 
+    <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;SearXNG_counter_&quot;</span> <span class="o">+</span> <span class="n">secret_hash</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+    <span class="n">c</span> <span class="o">=</span> <span class="n">script</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="n">duration</span><span class="p">],</span> <span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="n">name</span><span class="p">])</span>
 
+    <span class="k">return</span> <span class="n">c</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 175 - 0
_modules/searx/result_types.html
View File 

@@ -0,0 +1,175 @@
 
+<!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.result_types &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.result_types</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.result_types</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Typification of the result items generated by the *engines*, *answerers* and</span>
 
+<span class="sd">*plugins*.</span>
 
+
 
+<span class="sd">.. note::</span>
 
+
 
+<span class="sd">   We are at the beginning of typing the results.  Further typing will follow,</span>
 
+<span class="sd">   but this is a very large task that we will only be able to implement</span>
 
+<span class="sd">   gradually.  For more, please read :ref:`result types`.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=too-few-public-methods</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;Result&quot;</span><span class="p">,</span> <span class="s2">&quot;MainResult&quot;</span><span class="p">,</span> <span class="s2">&quot;KeyValue&quot;</span><span class="p">,</span> <span class="s2">&quot;EngineResults&quot;</span><span class="p">,</span> <span class="s2">&quot;AnswerSet&quot;</span><span class="p">,</span> <span class="s2">&quot;Answer&quot;</span><span class="p">,</span> <span class="s2">&quot;Translations&quot;</span><span class="p">]</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">abc</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">enginelib</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">._base</span><span class="w"> </span><span class="kn">import</span> <span class="n">Result</span><span class="p">,</span> <span class="n">MainResult</span><span class="p">,</span> <span class="n">LegacyResult</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.answer</span><span class="w"> </span><span class="kn">import</span> <span class="n">AnswerSet</span><span class="p">,</span> <span class="n">Answer</span><span class="p">,</span> <span class="n">Translations</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.keyvalue</span><span class="w"> </span><span class="kn">import</span> <span class="n">KeyValue</span>
 
+
 
+
 
+<div class="viewcode-block" id="ResultList">
 
+<a class="viewcode-back" href="../../dev/engines/index.html#searx.result_types.ResultList">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">ResultList</span><span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class of all result lists (abstract).&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">class</span><span class="w"> </span><span class="nc">types</span><span class="p">:</span>  <span class="c1"># pylint: disable=invalid-name</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The collection of result types (which have already been implemented).&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">Answer</span> <span class="o">=</span> <span class="n">Answer</span>
 
+        <span class="n">KeyValue</span> <span class="o">=</span> <span class="n">KeyValue</span>
 
+        <span class="n">MainResult</span> <span class="o">=</span> <span class="n">MainResult</span>
 
+        <span class="n">Result</span> <span class="o">=</span> <span class="n">Result</span>
 
+        <span class="n">Translations</span> <span class="o">=</span> <span class="n">Translations</span>
 
+
 
+        <span class="c1"># for backward compatibility</span>
 
+        <span class="n">LegacyResult</span> <span class="o">=</span> <span class="n">LegacyResult</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="c1"># pylint: disable=useless-parent-delegation</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">:</span> <span class="n">Result</span> <span class="o">|</span> <span class="n">LegacyResult</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Add a :py:`Result` item to the result list.&quot;&quot;&quot;</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="EngineResults">
 
+<a class="viewcode-back" href="../../dev/engines/index.html#searx.result_types.EngineResults">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">EngineResults</span><span class="p">(</span><span class="n">ResultList</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Result list that should be used by engine developers.  For convenience,</span>
 
+<span class="sd">    engine developers don&#39;t need to import types / see :py:obj:`ResultList.types`.</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">       from searx.result_types import EngineResults</span>
 
+<span class="sd">       ...</span>
 
+<span class="sd">       def response(resp) -&gt; EngineResults:</span>
 
+<span class="sd">           res = EngineResults()</span>
 
+<span class="sd">           ...</span>
 
+<span class="sd">           res.add( res.types.Answer(answer=&quot;lorem ipsum ..&quot;, url=&quot;https://example.org&quot;) )</span>
 
+<span class="sd">           ...</span>
 
+<span class="sd">           return res</span>
 
+<span class="sd">    &quot;&quot;&quot;</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 691 - 0
_modules/searx/result_types/_base.html
View File 

@@ -0,0 +1,691 @@
 
+<!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.result_types._base &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../result_types.html" accesskey="U">searx.result_types</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.result_types._base</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.result_types._base</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="c1"># pylint: disable=too-few-public-methods, missing-module-docstring</span>
 
+<span class="sd">&quot;&quot;&quot;Basic types for the typification of results.</span>
 
+
 
+<span class="sd">- :py:obj:`Result` base class</span>
 
+<span class="sd">- :py:obj:`LegacyResult` for internal use only</span>
 
+
 
+<span class="sd">----</span>
 
+
 
+<span class="sd">.. autoclass:: Result</span>
 
+<span class="sd">   :members:</span>
 
+
 
+<span class="sd">.. _LegacyResult:</span>
 
+
 
+<span class="sd">.. autoclass:: LegacyResult</span>
 
+<span class="sd">   :members:</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;Result&quot;</span><span class="p">]</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">urllib.parse</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">warnings</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">time</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">datetime</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Callable</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">msgspec</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="k">as</span> <span class="n">log</span>
 
+
 
+<span class="n">WHITESPACE_REGEX</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="s1">&#39;( |</span><span class="se">\t</span><span class="s1">|</span><span class="se">\n</span><span class="s1">)+&#39;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">M</span> <span class="o">|</span> <span class="n">re</span><span class="o">.</span><span class="n">U</span><span class="p">)</span>
 
+<span class="n">UNKNOWN</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_normalize_url_fields</span><span class="p">(</span><span class="n">result</span><span class="p">:</span> <span class="n">Result</span> <span class="o">|</span> <span class="n">LegacyResult</span><span class="p">):</span>
 
+
 
+    <span class="c1"># As soon we need LegacyResult not any longer, we can move this function to</span>
 
+    <span class="c1"># method Result.normalize_result_fields</span>
 
+
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">url</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+            <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;result: invalid URL: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
 
+            <span class="n">result</span><span class="o">.</span><span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+            <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="p">:</span>
 
+        <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="o">.</span><span class="n">_replace</span><span class="p">(</span>
 
+            <span class="c1"># if the result has no scheme, use http as default</span>
 
+            <span class="n">scheme</span><span class="o">=</span><span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="o">.</span><span class="n">scheme</span> <span class="ow">or</span> <span class="s2">&quot;http&quot;</span><span class="p">,</span>
 
+            <span class="n">path</span><span class="o">=</span><span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
 
+        <span class="p">)</span>
 
+        <span class="n">result</span><span class="o">.</span><span class="n">url</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>
 
+
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">LegacyResult</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;infobox&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
 
+        <span class="c1"># As soon we have InfoboxResult, we can move this function to method</span>
 
+        <span class="c1"># InfoboxResult.normalize_result_fields</span>
 
+
 
+        <span class="n">infobox_urls</span><span class="p">:</span> <span class="nb">list</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="nb">getattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;urls&quot;</span><span class="p">,</span> <span class="p">[])</span>
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">infobox_urls</span><span class="p">:</span>
 
+            <span class="n">_url</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;url&quot;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">_url</span><span class="p">:</span>
 
+                <span class="k">continue</span>
 
+            <span class="n">_url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">_url</span><span class="p">)</span>
 
+            <span class="n">item</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_url</span><span class="o">.</span><span class="n">_replace</span><span class="p">(</span>
 
+                <span class="n">scheme</span><span class="o">=</span><span class="n">_url</span><span class="o">.</span><span class="n">scheme</span> <span class="ow">or</span> <span class="s2">&quot;http&quot;</span><span class="p">,</span>
 
+                <span class="c1"># netloc=_url.netloc.replace(&quot;www.&quot;, &quot;&quot;),</span>
 
+                <span class="n">path</span><span class="o">=</span><span class="n">_url</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
 
+            <span class="p">)</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>
 
+
 
+        <span class="n">infobox_id</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;id&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">infobox_id</span><span class="p">:</span>
 
+            <span class="n">_url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">infobox_id</span><span class="p">)</span>
 
+            <span class="n">result</span><span class="o">.</span><span class="n">id</span> <span class="o">=</span> <span class="n">_url</span><span class="o">.</span><span class="n">_replace</span><span class="p">(</span>
 
+                <span class="n">scheme</span><span class="o">=</span><span class="n">_url</span><span class="o">.</span><span class="n">scheme</span> <span class="ow">or</span> <span class="s2">&quot;http&quot;</span><span class="p">,</span>
 
+                <span class="c1"># netloc=_url.netloc.replace(&quot;www.&quot;, &quot;&quot;),</span>
 
+                <span class="n">path</span><span class="o">=</span><span class="n">_url</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
 
+            <span class="p">)</span><span class="o">.</span><span class="n">geturl</span><span class="p">()</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_normalize_text_fields</span><span class="p">(</span><span class="n">result</span><span class="p">:</span> <span class="n">MainResult</span> <span class="o">|</span> <span class="n">LegacyResult</span><span class="p">):</span>
 
+
 
+    <span class="c1"># As soon we need LegacyResult not any longer, we can move this function to</span>
 
+    <span class="c1"># method MainResult.normalize_result_fields</span>
 
+
 
+    <span class="c1"># Actually, a type check should not be necessary if the engine is</span>
 
+    <span class="c1"># implemented correctly. Historically, however, we have always had a type</span>
 
+    <span class="c1"># check here.</span>
 
+
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">title</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">title</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+        <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;result: invalid type of field &#39;title&#39;: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
 
+        <span class="n">result</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">content</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">content</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+        <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;result: invalid type of field &#39;content&#39;: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">result</span><span class="p">))</span>
 
+        <span class="n">result</span><span class="o">.</span><span class="n">content</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
 
+
 
+    <span class="c1"># normalize title and content</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">title</span><span class="p">:</span>
 
+        <span class="n">result</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="n">WHITESPACE_REGEX</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">,</span> <span class="n">result</span><span class="o">.</span><span class="n">title</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">content</span><span class="p">:</span>
 
+        <span class="n">result</span><span class="o">.</span><span class="n">content</span> <span class="o">=</span> <span class="n">WHITESPACE_REGEX</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">,</span> <span class="n">result</span><span class="o">.</span><span class="n">content</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">content</span> <span class="o">==</span> <span class="n">result</span><span class="o">.</span><span class="n">title</span><span class="p">:</span>
 
+        <span class="c1"># avoid duplicate content between the content and title fields</span>
 
+        <span class="n">result</span><span class="o">.</span><span class="n">content</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_filter_urls</span><span class="p">(</span><span class="n">result</span><span class="p">:</span> <span class="n">Result</span> <span class="o">|</span> <span class="n">LegacyResult</span><span class="p">,</span> <span class="n">filter_func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Result</span> <span class="o">|</span> <span class="n">LegacyResult</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="nb">str</span> <span class="o">|</span> <span class="nb">bool</span><span class="p">]):</span>
 
+    <span class="c1"># pylint: disable=too-many-branches, too-many-statements</span>
 
+
 
+    <span class="c1"># As soon we need LegacyResult not any longer, we can move this function to</span>
 
+    <span class="c1"># method Result.</span>
 
+
 
+    <span class="n">url_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">,</span> <span class="s2">&quot;iframe_src&quot;</span><span class="p">,</span> <span class="s2">&quot;audio_src&quot;</span><span class="p">,</span> <span class="s2">&quot;img_src&quot;</span><span class="p">,</span> <span class="s2">&quot;thumbnail_src&quot;</span><span class="p">,</span> <span class="s2">&quot;thumbnail&quot;</span><span class="p">]</span>
 
+
 
+    <span class="k">for</span> <span class="n">field_name</span> <span class="ow">in</span> <span class="n">url_fields</span><span class="p">:</span>
 
+        <span class="n">url_src</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">url_src</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+
 
+        <span class="n">new_url</span> <span class="o">=</span> <span class="n">filter_func</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">url_src</span><span class="p">)</span>
 
+        <span class="c1"># log.debug(&quot;filter_urls: filter_func(result, %s) &#39;%s&#39; -&gt; &#39;%s&#39;&quot;, field_name, field_value, new_url)</span>
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">new_url</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
 
+            <span class="k">if</span> <span class="n">new_url</span><span class="p">:</span>
 
+                <span class="c1"># log.debug(&quot;filter_urls: unchanged field %s URL %s&quot;, field_name, field_value)</span>
 
+                <span class="k">continue</span>
 
+            <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;filter_urls: drop field </span><span class="si">%s</span><span class="s2"> URL </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">url_src</span><span class="p">)</span>
 
+            <span class="n">new_url</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;filter_urls: modify field </span><span class="si">%s</span><span class="s2"> URL </span><span class="si">%s</span><span class="s2"> -&gt; </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">url_src</span><span class="p">,</span> <span class="n">new_url</span><span class="p">)</span>
 
+
 
+        <span class="nb">setattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">new_url</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">field_name</span> <span class="o">==</span> <span class="s2">&quot;url&quot;</span><span class="p">:</span>
 
+            <span class="c1"># sync parsed_url with new_url</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">new_url</span><span class="p">:</span>
 
+                <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="o">=</span> <span class="kc">None</span>
 
+            <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">new_url</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+                <span class="n">result</span><span class="o">.</span><span class="n">parsed_url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">new_url</span><span class="p">)</span>
 
+
 
+    <span class="c1"># &quot;urls&quot;: are from infobox</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># As soon we have InfoboxResult, we can move this function to method</span>
 
+    <span class="c1"># InfoboxResult.normalize_result_fields</span>
 
+
 
+    <span class="n">infobox_urls</span><span class="p">:</span> <span class="nb">list</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="nb">getattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;urls&quot;</span><span class="p">,</span> <span class="p">[])</span>
 
+
 
+    <span class="k">if</span> <span class="n">infobox_urls</span><span class="p">:</span>
 
+        <span class="c1"># log.debug(&quot;filter_urls: infobox_urls .. %s&quot;, infobox_urls)</span>
 
+        <span class="n">new_infobox_urls</span><span class="p">:</span> <span class="nb">list</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="p">[]</span>
 
+
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">infobox_urls</span><span class="p">:</span>
 
+            <span class="n">url_src</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;url&quot;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">url_src</span><span class="p">:</span>
 
+                <span class="n">new_infobox_urls</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="n">new_url</span> <span class="o">=</span> <span class="n">filter_func</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;infobox_urls&quot;</span><span class="p">,</span> <span class="n">url_src</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">new_url</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
 
+                <span class="k">if</span> <span class="n">new_url</span><span class="p">:</span>
 
+                    <span class="n">new_infobox_urls</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+                    <span class="c1"># log.debug(&quot;filter_urls: leave URL in field &#39;urls&#39; (&#39;infobox_urls&#39;) unchanged -&gt; %s&quot;, _url)</span>
 
+                    <span class="k">continue</span>
 
+                <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;filter_urls: remove URL from field &#39;urls&#39; (&#39;infobox_urls&#39;) URL </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">url_src</span><span class="p">)</span>
 
+                <span class="n">new_url</span> <span class="o">=</span> <span class="kc">None</span>
 
+            <span class="k">if</span> <span class="n">new_url</span><span class="p">:</span>
 
+                <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;filter_urls: modify URL from field &#39;urls&#39; (&#39;infobox_urls&#39;) URL </span><span class="si">%s</span><span class="s2"> -&gt; </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">url_src</span><span class="p">,</span> <span class="n">new_url</span><span class="p">)</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_url</span>
 
+                <span class="n">new_infobox_urls</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+        <span class="nb">setattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;urls&quot;</span><span class="p">,</span> <span class="n">new_infobox_urls</span><span class="p">)</span>
 
+
 
+    <span class="c1"># &quot;attributes&quot;: are from infobox</span>
 
+    <span class="c1">#</span>
 
+    <span class="c1"># The infobox has additional subsections for attributes, urls and relatedTopics:</span>
 
+
 
+    <span class="n">infobox_attributes</span><span class="p">:</span> <span class="nb">list</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="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;attributes&quot;</span><span class="p">,</span> <span class="p">[])</span>
 
+
 
+    <span class="k">if</span> <span class="n">infobox_attributes</span><span class="p">:</span>
 
+        <span class="c1"># log.debug(&quot;filter_urls: infobox_attributes .. %s&quot;, infobox_attributes)</span>
 
+        <span class="n">new_infobox_attributes</span><span class="p">:</span> <span class="nb">list</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="o">=</span> <span class="p">[]</span>
 
+
 
+        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">infobox_attributes</span><span class="p">:</span>
 
+            <span class="n">image</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;image&quot;</span><span class="p">,</span> <span class="p">{})</span>
 
+            <span class="n">url_src</span> <span class="o">=</span> <span class="n">image</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;src&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">url_src</span><span class="p">:</span>
 
+                <span class="n">new_infobox_attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="n">new_url</span> <span class="o">=</span> <span class="n">filter_func</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;infobox_attributes&quot;</span><span class="p">,</span> <span class="n">url_src</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">new_url</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
 
+                <span class="k">if</span> <span class="n">new_url</span><span class="p">:</span>
 
+                    <span class="n">new_infobox_attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+                    <span class="c1"># log.debug(&quot;filter_urls: leave URL in field &#39;image.src&#39; unchanged -&gt; %s&quot;, url_src)</span>
 
+                    <span class="k">continue</span>
 
+                <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;filter_urls: drop field &#39;image.src&#39; (&#39;infobox_attributes&#39;) URL </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">url_src</span><span class="p">)</span>
 
+                <span class="n">new_url</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+            <span class="k">if</span> <span class="n">new_url</span><span class="p">:</span>
 
+                <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
 
+                    <span class="s2">&quot;filter_urls: modify &#39;image.src&#39; (&#39;infobox_attributes&#39;) URL </span><span class="si">%s</span><span class="s2"> -&gt; </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span>
 
+                    <span class="n">url_src</span><span class="p">,</span>
 
+                    <span class="n">new_url</span><span class="p">,</span>
 
+                <span class="p">)</span>
 
+                <span class="n">item</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">][</span><span class="s2">&quot;src&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_url</span>
 
+                <span class="n">new_infobox_attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 
+
 
+        <span class="nb">setattr</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="s2">&quot;attributes&quot;</span><span class="p">,</span> <span class="n">new_infobox_attributes</span><span class="p">)</span>
 
+
 
+    <span class="n">result</span><span class="o">.</span><span class="n">normalize_result_fields</span><span class="p">()</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_normalize_date_fields</span><span class="p">(</span><span class="n">result</span><span class="p">:</span> <span class="n">MainResult</span> <span class="o">|</span> <span class="n">LegacyResult</span><span class="p">):</span>
 
+
 
+    <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">publishedDate</span><span class="p">:</span>  <span class="c1"># do not try to get a date from an empty string or a None type</span>
 
+        <span class="k">try</span><span class="p">:</span>  <span class="c1"># test if publishedDate &gt;= 1900 (datetime module bug)</span>
 
+            <span class="n">result</span><span class="o">.</span><span class="n">pubdate</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">publishedDate</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">&#39;%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S%z&#39;</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
 
+            <span class="n">result</span><span class="o">.</span><span class="n">publishedDate</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+
 
+<div class="viewcode-block" id="Result">
 
+<a class="viewcode-back" href="../../../dev/result_types/base_result.html#searx.result_types._base.Result">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">Result</span><span class="p">(</span><span class="n">msgspec</span><span class="o">.</span><span class="n">Struct</span><span class="p">,</span> <span class="n">kw_only</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class of all result types :ref:`result types`.&quot;&quot;&quot;</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="o">=</span> <span class="kc">None</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A link related to this *result*&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;default.html&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Name of the template used to render the result.</span>
 
+
 
+<span class="sd">    By default :origin:`result_templates/default.html</span>
 
+<span class="sd">    &lt;searx/templates/simple/result_templates/default.html&gt;` is used.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine</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="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Name of the engine *this* result comes from.  In case of *plugins* a</span>
 
+<span class="sd">    prefix ``plugin:`` is set, in case of *answerer* prefix ``answerer:`` is</span>
 
+<span class="sd">    set.</span>
 
+
 
+<span class="sd">    The field is optional and is initialized from the context if necessary.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">parsed_url</span><span class="p">:</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">ParseResult</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;:py:obj:`urllib.parse.ParseResult` of :py:obj:`Result.url`.</span>
 
+
 
+<span class="sd">    The field is optional and is initialized from the context if necessary.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+<div class="viewcode-block" id="Result.normalize_result_fields">
 
+<a class="viewcode-back" href="../../../dev/result_types/base_result.html#searx.result_types._base.Result.normalize_result_fields">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">normalize_result_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Normalize fields ``url`` and ``parse_sql``.</span>
 
+
 
+<span class="sd">        - If field ``url`` is set and field ``parse_url`` is unset, init</span>
 
+<span class="sd">          ``parse_url`` from field ``url``.  The ``url`` field is initialized</span>
 
+<span class="sd">          with the resulting value in ``parse_url``, if ``url`` and</span>
 
+<span class="sd">          ``parse_url`` are not equal.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="n">_normalize_url_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">pass</span>
 
+
 
+<div class="viewcode-block" id="Result.filter_urls">
 
+<a class="viewcode-back" href="../../../dev/result_types/base_result.html#searx.result_types._base.Result.filter_urls">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">filter_urls</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filter_func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Result</span> <span class="o">|</span> <span class="n">LegacyResult</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="nb">str</span> <span class="o">|</span> <span class="nb">bool</span><span class="p">]):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;A filter function is passed in the ``filter_func`` argument to</span>
 
+<span class="sd">        filter and/or modify the URLs.</span>
 
+
 
+<span class="sd">        The filter function receives the :py:obj:`result object &lt;Result&gt;` as</span>
 
+<span class="sd">        the first argument and the field name (``str``) in the second argument.</span>
 
+<span class="sd">        In the third argument the URL string value is passed to the filter function.</span>
 
+
 
+<span class="sd">        The filter function is applied to all fields that contain a URL,</span>
 
+<span class="sd">        in addition to the familiar ``url`` field, these include fields such as::</span>
 
+
 
+<span class="sd">             [&quot;url&quot;, &quot;iframe_src&quot;, &quot;audio_src&quot;, &quot;img_src&quot;, &quot;thumbnail_src&quot;, &quot;thumbnail&quot;]</span>
 
+
 
+<span class="sd">        and the ``urls`` list of items of the infobox.</span>
 
+
 
+<span class="sd">        For each field, the filter function is called and returns a bool or a</span>
 
+<span class="sd">        string value:</span>
 
+
 
+<span class="sd">        - ``True``: leave URL in field unchanged</span>
 
+<span class="sd">        - ``False``: remove URL field from result (or remove entire result)</span>
 
+<span class="sd">        - ``str``: modified URL to be used instead</span>
 
+
 
+<span class="sd">        See :ref:`filter urls example`.</span>
 
+
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="n">_filter_urls</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filter_func</span><span class="o">=</span><span class="n">filter_func</span><span class="p">)</span></div>
 
+
 
+
 
+    <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="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Generates a hash value that uniquely identifies the content of *this*</span>
 
+<span class="sd">        result.  The method can be adapted in the inheritance to compare results</span>
 
+<span class="sd">        from different sources.</span>
 
+
 
+<span class="sd">        If two result objects are not identical but have the same content, their</span>
 
+<span class="sd">        hash values should also be identical.</span>
 
+
 
+<span class="sd">        The hash value is used in contexts, e.g. when checking for equality to</span>
 
+<span class="sd">        identify identical results from different sources (engines).</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="nb">id</span><span class="p">(</span><span class="bp">self</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="w">        </span><span class="sd">&quot;&quot;&quot;py:obj:`Result` objects are equal if the hash values of the two</span>
 
+<span class="sd">        objects are equal.  If needed, its recommended to overwrite</span>
 
+<span class="sd">        &quot;py:obj:`Result.__hash__`.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">hash</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
 
+
 
+    <span class="c1"># for legacy code where a result is treated as a Python dict</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 
+
 
+        <span class="k">return</span> <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_name</span><span class="p">):</span>
 
+
 
+        <span class="k">if</span> <span class="n">field_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__struct_fields__</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">field_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_name</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+
 
+        <span class="k">return</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__struct_fields__</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">as_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="p">{</span><span class="n">f</span><span class="p">:</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__struct_fields__</span><span class="p">}</span>
 
+
 
+<div class="viewcode-block" id="Result.defaults_from">
 
+<a class="viewcode-back" href="../../../dev/result_types/base_result.html#searx.result_types._base.Result.defaults_from">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">defaults_from</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="n">Result</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Fields not set in *self* will be updated from the field values of the</span>
 
+<span class="sd">        *other*.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">for</span> <span class="n">field_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__struct_fields__</span><span class="p">:</span>
 
+            <span class="n">self_val</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
 
+            <span class="n">other_val</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">self_val</span><span class="p">:</span>
 
+                <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_name</span><span class="p">,</span> <span class="n">other_val</span><span class="p">)</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="MainResult">
 
+<a class="viewcode-back" href="../../../dev/result_types/main/mainresult.html#searx.result_types._base.MainResult">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">MainResult</span><span class="p">(</span><span class="n">Result</span><span class="p">):</span>  <span class="c1"># pylint: disable=missing-class-docstring</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class of all result types displayed in :ref:`area main results`.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">title</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Link title of the result item.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">content</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extract or description of the result item&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">img_src</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;URL of a image that is displayed in the result item.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">thumbnail</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;URL of a thumbnail that is displayed in the result item.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">publishedDate</span><span class="p">:</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The date on which the object was published.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">pubdate</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;String representation of :py:obj:`MainResult.publishedDate`&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">length</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">struct_time</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Playing duration in seconds.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">views</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;View count in humanized number format.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">author</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Author of the title.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Miscellaneous metadata.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">priority</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">&quot;&quot;</span><span class="p">,</span> <span class="s2">&quot;high&quot;</span><span class="p">,</span> <span class="s2">&quot;low&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The priority can be set via :ref:`hostnames plugin`, for example.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engines</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;In a merged results list, the names of the engines that found this result</span>
 
+<span class="sd">    are listed in this field.&quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># open_group and close_group should not manged in the Result</span>
 
+    <span class="c1"># class (we should drop it from here!)</span>
 
+    <span class="n">open_group</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
 
+    <span class="n">close_group</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
 
+    <span class="n">positions</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="n">score</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span>
 
+    <span class="n">category</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</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="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Ordinary url-results are equal if their values for</span>
 
+<span class="sd">        :py:obj:`Result.template`, :py:obj:`Result.parsed_url` (without scheme)</span>
 
+<span class="sd">        and :py:obj:`MainResult.img_src` are equal.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parsed_url</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;missing a value in field &#39;parsed_url&#39;: </span><span class="si">{</span><span class="bp">self</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+        <span class="n">url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parsed_url</span>
 
+        <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span>
 
+            <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">template</span><span class="si">}</span><span class="s2">&quot;</span>
 
+            <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">netloc</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">path</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">params</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">query</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">fragment</span><span class="si">}</span><span class="s2">&quot;</span>
 
+            <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;|</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">img_src</span><span class="si">}</span><span class="s2">&quot;</span>
 
+        <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="MainResult.normalize_result_fields">
 
+<a class="viewcode-back" href="../../../dev/result_types/main/mainresult.html#searx.result_types._base.MainResult.normalize_result_fields">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">normalize_result_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">normalize_result_fields</span><span class="p">()</span>
 
+        <span class="n">_normalize_text_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
+        <span class="n">_normalize_date_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">engines</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">)</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="LegacyResult">
 
+<a class="viewcode-back" href="../../../dev/result_types/base_result.html#searx.result_types._base.LegacyResult">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">LegacyResult</span><span class="p">(</span><span class="nb">dict</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A wrapper around a legacy result item.  The SearXNG core uses this class</span>
 
+<span class="sd">    for untyped dictionaries / to be downward compatible.</span>
 
+
 
+<span class="sd">    This class is needed until we have implemented an :py:obj:`Result` class for</span>
 
+<span class="sd">    each result type and the old usages in the codebase have been fully</span>
 
+<span class="sd">    migrated.</span>
 
+
 
+<span class="sd">    There is only one place where this class is used, in the</span>
 
+<span class="sd">    :py:obj:`searx.results.ResultContainer`.</span>
 
+
 
+<span class="sd">    .. attention::</span>
 
+
 
+<span class="sd">       Do not use this class in your own implementations!</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">UNSET</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
 
+
 
+    <span class="c1"># emulate field types from type class Result</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="n">template</span><span class="p">:</span> <span class="nb">str</span>
 
+    <span class="n">engine</span><span class="p">:</span> <span class="nb">str</span>
 
+    <span class="n">parsed_url</span><span class="p">:</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">ParseResult</span> <span class="o">|</span> <span class="kc">None</span>
 
+
 
+    <span class="c1"># emulate field types from type class MainResult</span>
 
+    <span class="n">title</span><span class="p">:</span> <span class="nb">str</span>
 
+    <span class="n">content</span><span class="p">:</span> <span class="nb">str</span>
 
+    <span class="n">img_src</span><span class="p">:</span> <span class="nb">str</span>
 
+    <span class="n">thumbnail</span><span class="p">:</span> <span class="nb">str</span>
 
+    <span class="n">priority</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">&quot;&quot;</span><span class="p">,</span> <span class="s2">&quot;high&quot;</span><span class="p">,</span> <span class="s2">&quot;low&quot;</span><span class="p">]</span>
 
+    <span class="n">engines</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
+    <span class="n">positions</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span>
 
+    <span class="n">score</span><span class="p">:</span> <span class="nb">float</span>
 
+    <span class="n">category</span><span class="p">:</span> <span class="nb">str</span>
 
+    <span class="n">publishedDate</span><span class="p">:</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">pubdate</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+
 
+    <span class="c1"># infobox result</span>
 
+    <span class="n">urls</span><span class="p">:</span> <span class="nb">list</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="n">attributes</span><span class="p">:</span> <span class="nb">list</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="k">def</span><span class="w"> </span><span class="nf">as_dict</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="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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 
+
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 
+
 
+        <span class="c1"># emulate field types from type class Result</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;url&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;template&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;template&quot;</span><span class="p">,</span> <span class="s2">&quot;default.html&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;engine&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;engine&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;parsed_url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;parsed_url&quot;</span><span class="p">)</span>
 
+
 
+        <span class="c1"># emulate field types from type class MainResult</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;title&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;title&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;content&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;content&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;img_src&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;img_src&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;thumbnail&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;thumbnail&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;priority&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;priority&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;engines&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;engines&quot;</span><span class="p">,</span> <span class="nb">set</span><span class="p">())</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;positions&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;positions&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;score&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;score&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;category&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;category&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="s2">&quot;infobox&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;urls&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;urls&quot;</span><span class="p">,</span> <span class="p">[])</span>
 
+            <span class="bp">self</span><span class="p">[</span><span class="s2">&quot;attributes&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;attributes&quot;</span><span class="p">,</span> <span class="p">[])</span>
 
+
 
+        <span class="c1"># Legacy types that have already been ported to a type ..</span>
 
+
 
+        <span class="k">if</span> <span class="s2">&quot;answer&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
 
+            <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
 
+                <span class="sa">f</span><span class="s2">&quot;engine </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="si">}</span><span class="s2"> is using deprecated `dict` for answers&quot;</span>
 
+                <span class="sa">f</span><span class="s2">&quot; / use a class from searx.result_types.answer&quot;</span><span class="p">,</span>
 
+                <span class="ne">DeprecationWarning</span><span class="p">,</span>
 
+            <span class="p">)</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">template</span> <span class="o">=</span> <span class="s2">&quot;answer/legacy.html&quot;</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">template</span> <span class="o">==</span> <span class="s2">&quot;keyvalue.html&quot;</span><span class="p">:</span>
 
+            <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
 
+                <span class="sa">f</span><span class="s2">&quot;engine </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="si">}</span><span class="s2"> is using deprecated `dict` for key/value results&quot;</span>
 
+                <span class="sa">f</span><span class="s2">&quot; / use a class from searx.result_types&quot;</span><span class="p">,</span>
 
+                <span class="ne">DeprecationWarning</span><span class="p">,</span>
 
+            <span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__getattr__</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">default</span><span class="o">=</span><span class="n">UNSET</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">:</span>
 
+        <span class="k">if</span> <span class="n">default</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">UNSET</span> <span class="ow">and</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;LegacyResult object has no field named: </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="bp">self</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__setattr__</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">val</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="o">=</span> <span class="n">val</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="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+
 
+        <span class="k">if</span> <span class="s2">&quot;answer&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
 
+            <span class="c1"># deprecated ..</span>
 
+            <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="p">[</span><span class="s2">&quot;answer&quot;</span><span class="p">])</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">template</span> <span class="o">==</span> <span class="s2">&quot;images.html&quot;</span><span class="p">:</span>
 
+            <span class="c1"># image results are equal if their values for template, the url and</span>
 
+            <span class="c1"># the img_src are equal.</span>
 
+            <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">template</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">img_src</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="bp">cls</span> <span class="ow">in</span> <span class="bp">self</span> <span class="k">for</span> <span class="bp">cls</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;suggestion&quot;</span><span class="p">,</span> <span class="s2">&quot;correction&quot;</span><span class="p">,</span> <span class="s2">&quot;infobox&quot;</span><span class="p">,</span> <span class="s2">&quot;number_of_results&quot;</span><span class="p">,</span> <span class="s2">&quot;engine_data&quot;</span><span class="p">]):</span>
 
+            <span class="c1"># Ordinary url-results are equal if their values for template,</span>
 
+            <span class="c1"># parsed_url (without schema) and img_src` are equal.</span>
 
+
 
+            <span class="c1"># Code copied from with MainResult.__hash__:</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">parsed_url</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;missing a value in field &#39;parsed_url&#39;: </span><span class="si">{</span><span class="bp">self</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+
 
+            <span class="n">url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parsed_url</span>
 
+            <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span>
 
+                <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">template</span><span class="si">}</span><span class="s2">&quot;</span>
 
+                <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">netloc</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">path</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">params</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">query</span><span class="si">}</span><span class="s2">|</span><span class="si">{</span><span class="n">url</span><span class="o">.</span><span class="n">fragment</span><span class="si">}</span><span class="s2">&quot;</span>
 
+                <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;|</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">img_src</span><span class="si">}</span><span class="s2">&quot;</span>
 
+            <span class="p">)</span>
 
+
 
+        <span class="k">return</span> <span class="nb">id</span><span class="p">(</span><span class="bp">self</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="nb">hash</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">==</span> <span class="nb">hash</span><span class="p">(</span><span class="n">other</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="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+
 
+        <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;LegacyResult: </span><span class="si">{</span><span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__repr__</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">normalize_result_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="n">_normalize_date_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
+        <span class="n">_normalize_url_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
+        <span class="n">_normalize_text_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">engines</span><span class="o">.</span><span class="n">add</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="k">def</span><span class="w"> </span><span class="nf">defaults_from</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="n">LegacyResult</span><span class="p">):</span>
 
+        <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">other</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">k</span><span class="p">):</span>
 
+                <span class="bp">self</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
 
+
 
+<div class="viewcode-block" id="LegacyResult.filter_urls">
 
+<a class="viewcode-back" href="../../../dev/result_types/base_result.html#searx.result_types._base.LegacyResult.filter_urls">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">filter_urls</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filter_func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Result</span> <span class="o">|</span> <span class="n">LegacyResult</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="nb">str</span> <span class="o">|</span> <span class="nb">bool</span><span class="p">]):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;See :py:obj:`Result.filter_urls`&quot;&quot;&quot;</span>
 
+        <span class="n">_filter_urls</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filter_func</span><span class="o">=</span><span class="n">filter_func</span><span class="p">)</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="../result_types.html">searx.result_types</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 268 - 0
_modules/searx/result_types/answer.html
View File 

@@ -0,0 +1,268 @@
 
+<!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.result_types.answer &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../result_types.html" accesskey="U">searx.result_types</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.result_types.answer</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.result_types.answer</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">Typification of the *answer* results.  Results of this type are rendered in</span>
 
+<span class="sd">the :origin:`answers.html &lt;searx/templates/simple/elements/answers.html&gt;`</span>
 
+<span class="sd">template.</span>
 
+
 
+<span class="sd">----</span>
 
+
 
+<span class="sd">.. autoclass:: BaseAnswer</span>
 
+<span class="sd">   :members:</span>
 
+<span class="sd">   :show-inheritance:</span>
 
+
 
+<span class="sd">.. autoclass:: Answer</span>
 
+<span class="sd">   :members:</span>
 
+<span class="sd">   :show-inheritance:</span>
 
+
 
+<span class="sd">.. autoclass:: Translations</span>
 
+<span class="sd">   :members:</span>
 
+<span class="sd">   :show-inheritance:</span>
 
+
 
+<span class="sd">.. autoclass:: AnswerSet</span>
 
+<span class="sd">   :members:</span>
 
+<span class="sd">   :show-inheritance:</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=too-few-public-methods</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;AnswerSet&quot;</span><span class="p">,</span> <span class="s2">&quot;Answer&quot;</span><span class="p">,</span> <span class="s2">&quot;Translations&quot;</span><span class="p">]</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">msgspec</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">._base</span><span class="w"> </span><span class="kn">import</span> <span class="n">Result</span>
 
+
 
+
 
+<div class="viewcode-block" id="BaseAnswer">
 
+<a class="viewcode-back" href="../../../dev/result_types/answer.html#searx.result_types.answer.BaseAnswer">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">BaseAnswer</span><span class="p">(</span><span class="n">Result</span><span class="p">,</span> <span class="n">kw_only</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class of all answer types.  It is not intended to build instances of</span>
 
+<span class="sd">    this class (aka *abstract*).&quot;&quot;&quot;</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="AnswerSet">
 
+<a class="viewcode-back" href="../../../dev/result_types/answer.html#searx.result_types.answer.AnswerSet">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">AnswerSet</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Aggregator for :py:obj:`BaseAnswer` items in a result container.&quot;&quot;&quot;</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">_answerlist</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_answerlist</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__bool__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_answerlist</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">answer</span><span class="p">:</span> <span class="n">BaseAnswer</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">a_hash</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">answer</span><span class="p">)</span>
 
+        <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_answerlist</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="nb">hash</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="o">==</span> <span class="n">a_hash</span><span class="p">:</span>
 
+                <span class="k">return</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_answerlist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">answer</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Sort items in this set and iterate over the items.&quot;&quot;&quot;</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_answerlist</span><span class="o">.</span><span class="n">sort</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">answer</span><span class="p">:</span> <span class="n">answer</span><span class="o">.</span><span class="n">template</span><span class="p">)</span>
 
+        <span class="k">yield from</span> <span class="bp">self</span><span class="o">.</span><span class="n">_answerlist</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">answer</span><span class="p">:</span> <span class="n">BaseAnswer</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 
+        <span class="n">a_hash</span> <span class="o">=</span> <span class="nb">hash</span><span class="p">(</span><span class="n">answer</span><span class="p">)</span>
 
+        <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_answerlist</span><span class="p">:</span>
 
+            <span class="k">if</span> <span class="nb">hash</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="o">==</span> <span class="n">a_hash</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>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="Answer">
 
+<a class="viewcode-back" href="../../../dev/result_types/answer.html#searx.result_types.answer.Answer">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">Answer</span><span class="p">(</span><span class="n">BaseAnswer</span><span class="p">,</span> <span class="n">kw_only</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Simple answer type where the *answer* is a simple string with an optional</span>
 
+<span class="sd">    :py:obj:`url field &lt;Result.url&gt;` field to link a resource (article, map, ..)</span>
 
+<span class="sd">    related to the answer.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;answer/legacy.html&quot;</span>
 
+
 
+    <span class="n">answer</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Text of the answer.&quot;&quot;&quot;</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="w">        </span><span class="sd">&quot;&quot;&quot;The hash value of field *answer* is the hash value of the</span>
 
+<span class="sd">        :py:obj:`Answer` object.  :py:obj:`Answer &lt;Result.__eq__&gt;` objects are</span>
 
+<span class="sd">        equal, when the hash values of both objects are equal.&quot;&quot;&quot;</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">answer</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="Translations">
 
+<a class="viewcode-back" href="../../../dev/result_types/answer.html#searx.result_types.answer.Translations">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">Translations</span><span class="p">(</span><span class="n">BaseAnswer</span><span class="p">,</span> <span class="n">kw_only</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Answer type with a list of translations.</span>
 
+
 
+<span class="sd">    The items in the list of :py:obj:`Translations.translations` are of type</span>
 
+<span class="sd">    :py:obj:`Translations.Item`:</span>
 
+
 
+<span class="sd">    .. code:: python</span>
 
+
 
+<span class="sd">       def response(resp):</span>
 
+<span class="sd">           results = []</span>
 
+<span class="sd">           ...</span>
 
+<span class="sd">           foo_1 = Translations.Item(</span>
 
+<span class="sd">               text=&quot;foobar&quot;,</span>
 
+<span class="sd">               synonyms=[&quot;bar&quot;, &quot;foo&quot;],</span>
 
+<span class="sd">               examples=[&quot;foo and bar are placeholders&quot;],</span>
 
+<span class="sd">           )</span>
 
+<span class="sd">           foo_url=&quot;https://www.deepl.com/de/translator#en/de/foo&quot;</span>
 
+<span class="sd">           ...</span>
 
+<span class="sd">           Translations(results=results, translations=[foo], url=foo_url)</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;answer/translations.html&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;The template in :origin:`answer/translations.html</span>
 
+<span class="sd">    &lt;searx/templates/simple/answer/translations.html&gt;`&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">translations</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Translations</span><span class="o">.</span><span class="n">Item</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;List of translations.&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">translations</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Translation does not have an item in the list translations&quot;</span><span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="Translations.Item">
 
+<a class="viewcode-back" href="../../../dev/result_types/answer.html#searx.result_types.answer.Translations.Item">[docs]</a>
 
+    <span class="k">class</span><span class="w"> </span><span class="nc">Item</span><span class="p">(</span><span class="n">msgspec</span><span class="o">.</span><span class="n">Struct</span><span class="p">,</span> <span class="n">kw_only</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;A single element of the translations / a translation.  A translation</span>
 
+<span class="sd">        consists of at least a mandatory ``text`` property (the translation) ,</span>
 
+<span class="sd">        optional properties such as *definitions*, *synonyms* and *examples* are</span>
 
+<span class="sd">        possible.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">text</span><span class="p">:</span> <span class="nb">str</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Translated text.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">transliteration</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Transliteration_ of the requested translation.</span>
 
+
 
+<span class="sd">        .. _Transliteration: https://en.wikipedia.org/wiki/Transliteration</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="n">examples</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;List of examples for the requested translation.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">definitions</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;List of definitions for the requested translation.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">synonyms</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;List of synonyms for the requested translation.&quot;&quot;&quot;</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="../result_types.html">searx.result_types</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 160 - 0
_modules/searx/result_types/keyvalue.html
View File 

@@ -0,0 +1,160 @@
 
+<!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.result_types.keyvalue &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../result_types.html" accesskey="U">searx.result_types</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.result_types.keyvalue</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.result_types.keyvalue</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">Typification of the *keyvalue* results.  Results of this type are rendered in</span>
 
+<span class="sd">the :origin:`keyvalue.html &lt;searx/templates/simple/result_templates/keyvalue.html&gt;`</span>
 
+<span class="sd">template.</span>
 
+
 
+<span class="sd">----</span>
 
+
 
+<span class="sd">.. autoclass:: KeyValue</span>
 
+<span class="sd">   :members:</span>
 
+<span class="sd">   :show-inheritance:</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=too-few-public-methods</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;KeyValue&quot;</span><span class="p">]</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">collections</span><span class="w"> </span><span class="kn">import</span> <span class="n">OrderedDict</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">._base</span><span class="w"> </span><span class="kn">import</span> <span class="n">MainResult</span>
 
+
 
+
 
+<div class="viewcode-block" id="KeyValue">
 
+<a class="viewcode-back" href="../../../dev/result_types/main/keyvalue.html#searx.result_types.keyvalue.KeyValue">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">KeyValue</span><span class="p">(</span><span class="n">MainResult</span><span class="p">,</span> <span class="n">kw_only</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Simple table view which maps *key* names (first col) to *values*</span>
 
+<span class="sd">    (second col).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;keyvalue.html&quot;</span>
 
+
 
+    <span class="n">kvmap</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">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="n">OrderedDict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Dictionary with keys and values. To sort keys, use :py:obj:`OrderedDict`.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">caption</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Optional caption for this result.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">key_title</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Optional title for the *key column*.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">value_title</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Optional title for the *value column*.&quot;&quot;&quot;</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="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;The KeyValues objects are checked for object identity, even if all</span>
 
+<span class="sd">        fields of two results have the same values, they are different from each</span>
 
+<span class="sd">        other.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">return</span> <span class="nb">id</span><span class="p">(</span><span class="bp">self</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="../result_types.html">searx.result_types</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 324 - 0
_modules/searx/search.html
View File 

@@ -0,0 +1,324 @@
 
+<!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 &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.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</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, too-few-public-methods</span>
 
+
 
+<span class="c1"># the public namespace has not yet been finally defined ..</span>
 
+<span class="c1"># __all__ = [&quot;EngineRef&quot;, &quot;SearchQuery&quot;]</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">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">uuid</span><span class="w"> </span><span class="kn">import</span> <span class="n">uuid4</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">flask</span><span class="w"> </span><span class="kn">import</span> <span class="n">copy_current_request_context</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</span><span class="w"> </span><span class="kn">import</span> <span class="n">settings</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">searx.answerers</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">searx.plugins</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">load_engines</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Request</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.external_bang</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_bang_url</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">initialize</span> <span class="k">as</span> <span class="n">initialize_metrics</span><span class="p">,</span> <span class="n">counter_inc</span><span class="p">,</span> <span class="n">histogram_observe_time</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">initialize</span> <span class="k">as</span> <span class="n">initialize_network</span><span class="p">,</span> <span class="n">check_network_configuration</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.search.checker</span><span class="w"> </span><span class="kn">import</span> <span class="n">initialize</span> <span class="k">as</span> <span class="n">initialize_checker</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.search.processors</span><span class="w"> </span><span class="kn">import</span> <span class="n">PROCESSORS</span><span class="p">,</span> <span class="n">initialize</span> <span class="k">as</span> <span class="n">initialize_processors</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineRef</span><span class="p">,</span> <span class="n">SearchQuery</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="s1">&#39;search&#39;</span><span class="p">)</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">settings_engines</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">enable_checker</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">check_network</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">enable_metrics</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 
+    <span class="n">settings_engines</span> <span class="o">=</span> <span class="n">settings_engines</span> <span class="ow">or</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;engines&#39;</span><span class="p">]</span>
 
+    <span class="n">load_engines</span><span class="p">(</span><span class="n">settings_engines</span><span class="p">)</span>
 
+    <span class="n">initialize_network</span><span class="p">(</span><span class="n">settings_engines</span><span class="p">,</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;outgoing&#39;</span><span class="p">])</span>
 
+    <span class="k">if</span> <span class="n">check_network</span><span class="p">:</span>
 
+        <span class="n">check_network_configuration</span><span class="p">()</span>
 
+    <span class="n">initialize_metrics</span><span class="p">([</span><span class="n">engine</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">engine</span> <span class="ow">in</span> <span class="n">settings_engines</span><span class="p">],</span> <span class="n">enable_metrics</span><span class="p">)</span>
 
+    <span class="n">initialize_processors</span><span class="p">(</span><span class="n">settings_engines</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">enable_checker</span><span class="p">:</span>
 
+        <span class="n">initialize_checker</span><span class="p">()</span>
 
+
 
+
 
+<div class="viewcode-block" id="Search">
 
+<a class="viewcode-back" href="../../src/searx.search.html#searx.search.Search">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">Search</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Search information container&quot;&quot;&quot;</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="s2">&quot;search_query&quot;</span><span class="p">,</span> <span class="s2">&quot;result_container&quot;</span><span class="p">,</span> <span class="s2">&quot;start_time&quot;</span><span class="p">,</span> <span class="s2">&quot;actual_timeout&quot;</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">search_query</span><span class="p">:</span> <span class="n">SearchQuery</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Initialize the Search&quot;&quot;&quot;</span>
 
+        <span class="c1"># init vars</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">search_query</span> <span class="o">=</span> <span class="n">search_query</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span> <span class="o">=</span> <span class="n">ResultContainer</span><span class="p">()</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">start_time</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">actual_timeout</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">search_external_bang</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">        Check if there is a external bang.</span>
 
+<span class="sd">        If yes, update self.result_container and return True</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_query</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">result_container</span><span class="o">.</span><span class="n">redirect_url</span> <span class="o">=</span> <span class="n">get_bang_url</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="p">)</span>
 
+
 
+            <span class="c1"># This means there was a valid bang and the</span>
 
+            <span class="c1"># rest of the search does not need to be continued</span>
 
+            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">redirect_url</span><span class="p">,</span> <span class="nb">str</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>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">search_answerers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+
 
+        <span class="n">results</span> <span class="o">=</span> <span class="n">searx</span><span class="o">.</span><span class="n">answerers</span><span class="o">.</span><span class="n">STORAGE</span><span class="o">.</span><span class="n">ask</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">search_query</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">result_container</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">results</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
 
+
 
+    <span class="c1"># do search-request</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_get_requests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="c1"># init vars</span>
 
+        <span class="n">requests</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+        <span class="c1"># max of all selected engine timeout</span>
 
+        <span class="n">default_timeout</span> <span class="o">=</span> <span class="mi">0</span>
 
+
 
+        <span class="c1"># start search-request for all selected engines</span>
 
+        <span class="k">for</span> <span class="n">engineref</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">:</span>
 
+            <span class="n">processor</span> <span class="o">=</span> <span class="n">PROCESSORS</span><span class="p">[</span><span class="n">engineref</span><span class="o">.</span><span class="n">name</span><span class="p">]</span>
 
+
 
+            <span class="c1"># stop the request now if the engine is suspend</span>
 
+            <span class="k">if</span> <span class="n">processor</span><span class="o">.</span><span class="n">extend_container_if_suspended</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="p">):</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="c1"># set default request parameters</span>
 
+            <span class="n">request_params</span> <span class="o">=</span> <span class="n">processor</span><span class="o">.</span><span class="n">get_params</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">search_query</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="k">if</span> <span class="n">request_params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+                <span class="k">continue</span>
 
+
 
+            <span class="n">counter_inc</span><span class="p">(</span><span class="s1">&#39;engine&#39;</span><span class="p">,</span> <span class="n">engineref</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">&#39;search&#39;</span><span class="p">,</span> <span class="s1">&#39;count&#39;</span><span class="p">,</span> <span class="s1">&#39;sent&#39;</span><span class="p">)</span>
 
+
 
+            <span class="c1"># append request to list</span>
 
+            <span class="n">requests</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">engineref</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">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">,</span> <span class="n">request_params</span><span class="p">))</span>
 
+
 
+            <span class="c1"># update default_timeout</span>
 
+            <span class="n">default_timeout</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">default_timeout</span><span class="p">,</span> <span class="n">processor</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="c1"># adjust timeout</span>
 
+        <span class="n">max_request_timeout</span> <span class="o">=</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;outgoing&#39;</span><span class="p">][</span><span class="s1">&#39;max_request_timeout&#39;</span><span class="p">]</span>
 
+        <span class="n">actual_timeout</span> <span class="o">=</span> <span class="n">default_timeout</span>
 
+        <span class="n">query_timeout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">timeout_limit</span>
 
+
 
+        <span class="k">if</span> <span class="n">max_request_timeout</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">query_timeout</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="c1"># No max, no user query: default_timeout</span>
 
+            <span class="k">pass</span>
 
+        <span class="k">elif</span> <span class="n">max_request_timeout</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">query_timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="c1"># No max, but user query: From user query except if above default</span>
 
+            <span class="n">actual_timeout</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">default_timeout</span><span class="p">,</span> <span class="n">query_timeout</span><span class="p">)</span>
 
+        <span class="k">elif</span> <span class="n">max_request_timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">query_timeout</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="c1"># Max, no user query: Default except if above max</span>
 
+            <span class="n">actual_timeout</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">default_timeout</span><span class="p">,</span> <span class="n">max_request_timeout</span><span class="p">)</span>
 
+        <span class="k">elif</span> <span class="n">max_request_timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">query_timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="c1"># Max &amp; user query: From user query except if above max</span>
 
+            <span class="n">actual_timeout</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">query_timeout</span><span class="p">,</span> <span class="n">max_request_timeout</span><span class="p">)</span>
 
+
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
 
+            <span class="s2">&quot;actual_timeout=</span><span class="si">{0}</span><span class="s2"> (default_timeout=</span><span class="si">{1}</span><span class="s2">, ?timeout_limit=</span><span class="si">{2}</span><span class="s2">, max_request_timeout=</span><span class="si">{3}</span><span class="s2">)&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
 
+                <span class="n">actual_timeout</span><span class="p">,</span> <span class="n">default_timeout</span><span class="p">,</span> <span class="n">query_timeout</span><span class="p">,</span> <span class="n">max_request_timeout</span>
 
+            <span class="p">)</span>
 
+        <span class="p">)</span>
 
+
 
+        <span class="k">return</span> <span class="n">requests</span><span class="p">,</span> <span class="n">actual_timeout</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">search_multiple_requests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">requests</span><span class="p">):</span>
 
+        <span class="c1"># pylint: disable=protected-access</span>
 
+        <span class="n">search_id</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid4</span><span class="p">())</span>
 
+
 
+        <span class="k">for</span> <span class="n">engine_name</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">request_params</span> <span class="ow">in</span> <span class="n">requests</span><span class="p">:</span>
 
+            <span class="n">_search</span> <span class="o">=</span> <span class="n">copy_current_request_context</span><span class="p">(</span><span class="n">PROCESSORS</span><span class="p">[</span><span class="n">engine_name</span><span class="p">]</span><span class="o">.</span><span class="n">search</span><span class="p">)</span>
 
+            <span class="n">th</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span>  <span class="c1"># pylint: disable=invalid-name</span>
 
+                <span class="n">target</span><span class="o">=</span><span class="n">_search</span><span class="p">,</span>
 
+                <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">request_params</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_time</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">actual_timeout</span><span class="p">),</span>
 
+                <span class="n">name</span><span class="o">=</span><span class="n">search_id</span><span class="p">,</span>
 
+            <span class="p">)</span>
 
+            <span class="n">th</span><span class="o">.</span><span class="n">_timeout</span> <span class="o">=</span> <span class="kc">False</span>
 
+            <span class="n">th</span><span class="o">.</span><span class="n">_engine_name</span> <span class="o">=</span> <span class="n">engine_name</span>
 
+            <span class="n">th</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
 
+
 
+        <span class="k">for</span> <span class="n">th</span> <span class="ow">in</span> <span class="n">threading</span><span class="o">.</span><span class="n">enumerate</span><span class="p">():</span>  <span class="c1"># pylint: disable=invalid-name</span>
 
+            <span class="k">if</span> <span class="n">th</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">search_id</span><span class="p">:</span>
 
+                <span class="n">remaining_time</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">actual_timeout</span> <span class="o">-</span> <span class="p">(</span><span class="n">default_timer</span><span class="p">()</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_time</span><span class="p">))</span>
 
+                <span class="n">th</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">remaining_time</span><span class="p">)</span>
 
+                <span class="k">if</span> <span class="n">th</span><span class="o">.</span><span class="n">is_alive</span><span class="p">():</span>
 
+                    <span class="n">th</span><span class="o">.</span><span class="n">_timeout</span> <span class="o">=</span> <span class="kc">True</span>
 
+                    <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">add_unresponsive_engine</span><span class="p">(</span><span class="n">th</span><span class="o">.</span><span class="n">_engine_name</span><span class="p">,</span> <span class="s1">&#39;timeout&#39;</span><span class="p">)</span>
 
+                    <span class="n">PROCESSORS</span><span class="p">[</span><span class="n">th</span><span class="o">.</span><span class="n">_engine_name</span><span class="p">]</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="s1">&#39;engine timeout&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">search_standard</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">        Update self.result_container, self.actual_timeout</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="n">requests</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">actual_timeout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_requests</span><span class="p">()</span>
 
+
 
+        <span class="c1"># send all search-request</span>
 
+        <span class="k">if</span> <span class="n">requests</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">search_multiple_requests</span><span class="p">(</span><span class="n">requests</span><span class="p">)</span>
 
+
 
+        <span class="c1"># return results, suggestions, answers and infoboxes</span>
 
+        <span class="k">return</span> <span class="kc">True</span>
 
+
 
+    <span class="c1"># do search-request</span>
 
+<div class="viewcode-block" id="Search.search">
 
+<a class="viewcode-back" href="../../src/searx.search.html#searx.search.Search.search">[docs]</a>
 
+    <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="o">-&gt;</span> <span class="n">ResultContainer</span><span class="p">:</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">start_time</span> <span class="o">=</span> <span class="n">default_timer</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_external_bang</span><span class="p">():</span>
 
+            <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">search_answerers</span><span class="p">():</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">search_standard</span><span class="p">()</span>
 
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span></div>
 
+</div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SearchWithPlugins">
 
+<a class="viewcode-back" href="../../src/searx.search.html#searx.search.SearchWithPlugins">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SearchWithPlugins</span><span class="p">(</span><span class="n">Search</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Inherit from the Search class, add calls to the plugins.&quot;&quot;&quot;</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">&#39;user_plugins&#39;</span><span class="p">,</span> <span class="s1">&#39;request&#39;</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">search_query</span><span class="p">:</span> <span class="n">SearchQuery</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">SXNG_Request</span><span class="p">,</span> <span class="n">user_plugins</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">search_query</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">user_plugins</span> <span class="o">=</span> <span class="n">user_plugins</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">result_container</span><span class="o">.</span><span class="n">on_result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_on_result</span>
 
+        <span class="c1"># pylint: disable=line-too-long</span>
 
+        <span class="c1"># get the &quot;real&quot; request to use it outside the Flask context.</span>
 
+        <span class="c1"># see</span>
 
+        <span class="c1"># * https://github.com/pallets/flask/blob/d01d26e5210e3ee4cbbdef12f05c886e08e92852/src/flask/globals.py#L55</span>
 
+        <span class="c1"># * https://github.com/pallets/werkzeug/blob/3c5d3c9bd0d9ce64590f0af8997a38f3823b368d/src/werkzeug/local.py#L548-L559</span>
 
+        <span class="c1"># * https://werkzeug.palletsprojects.com/en/2.0.x/local/#werkzeug.local.LocalProxy._get_current_object</span>
 
+        <span class="c1"># pylint: enable=line-too-long</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">request</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">_get_current_object</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_on_result</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">searx</span><span class="o">.</span><span class="n">plugins</span><span class="o">.</span><span class="n">STORAGE</span><span class="o">.</span><span class="n">on_result</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="SearchWithPlugins.search">
 
+<a class="viewcode-back" href="../../src/searx.search.html#searx.search.SearchWithPlugins.search">[docs]</a>
 
+    <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="o">-&gt;</span> <span class="n">ResultContainer</span><span class="p">:</span>
 
+
 
+        <span class="k">if</span> <span class="n">searx</span><span class="o">.</span><span class="n">plugins</span><span class="o">.</span><span class="n">STORAGE</span><span class="o">.</span><span class="n">pre_search</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="bp">self</span><span class="p">):</span>
 
+            <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">search</span><span class="p">()</span>
 
+
 
+        <span class="n">searx</span><span class="o">.</span><span class="n">plugins</span><span class="o">.</span><span class="n">STORAGE</span><span class="o">.</span><span class="n">post_search</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</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">result_container</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
 
+
 
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">result_container</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 246 - 0
_modules/searx/search/models.html
View File 

@@ -0,0 +1,246 @@
 
+<!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 &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../search.html" accesskey="U">searx.search</a> &#187;</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.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">&quot;&quot;&quot;Reference by names to an engine and category&quot;&quot;&quot;</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="s1">&#39;category&#39;</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">&quot;EngineRef(</span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">)&quot;</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.SearchQuery">[docs]</a>
 
+<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">&quot;&quot;&quot;container for all the search parameters (query, language, etc...)&quot;&quot;&quot;</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s1">&#39;query&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;engineref_list&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;lang&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;locale&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;safesearch&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;pageno&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;time_range&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;timeout_limit&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;external_bang&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;engine_data&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;redirect_to_first_result&#39;</span><span class="p">,</span>
 
+    <span class="p">)</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="n">typing</span><span class="o">.</span><span class="n">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">&#39;all&#39;</span><span class="p">,</span>
 
+        <span class="n">safesearch</span><span class="p">:</span> <span class="nb">int</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">Optional</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="p">,</span>
 
+        <span class="n">timeout_limit</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</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="n">typing</span><span class="o">.</span><span class="n">Optional</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="p">,</span>
 
+        <span class="n">engine_data</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="n">typing</span><span class="o">.</span><span class="n">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="p">,</span>
 
+        <span class="n">redirect_to_first_result</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</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="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="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">&#39;-&#39;</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">&quot;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">)&quot;</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 312 - 0
_modules/searx/search/processors/abstract.html
View File 

@@ -0,0 +1,312 @@
 
+<!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 &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../../search.html" accesskey="U">searx.search</a> &#187;</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">&quot;&quot;&quot;Abstract base classes for engine request processors.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</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">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Union</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">settings</span><span class="p">,</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="p">,</span> <span class="n">SearxEngineResponseException</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="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="s1">&#39;searx.search.processor&#39;</span><span class="p">)</span>
 
+<span class="n">SUSPENDED_STATUS</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="s1">&#39;SuspendedStatus&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+
 
+<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">&quot;&quot;&quot;Class to handle suspend state.&quot;&quot;&quot;</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">&#39;suspend_end_time&#39;</span><span class="p">,</span> <span class="s1">&#39;suspend_reason&#39;</span><span class="p">,</span> <span class="s1">&#39;continuous_errors&#39;</span><span class="p">,</span> <span class="s1">&#39;lock&#39;</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="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="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="kc">None</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">&gt;=</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="n">suspend_reason</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">suspended_time</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span>
 
+                    <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;search&#39;</span><span class="p">][</span><span class="s1">&#39;max_ban_time_on_fail&#39;</span><span class="p">],</span>
 
+                    <span class="bp">self</span><span class="o">.</span><span class="n">continuous_errors</span> <span class="o">*</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;search&#39;</span><span class="p">][</span><span class="s1">&#39;ban_time_on_fail&#39;</span><span class="p">],</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="s1">&#39;Suspend for </span><span class="si">%i</span><span class="s1"> seconds&#39;</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="kc">None</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">&quot;&quot;&quot;Base classes used for all types of request processors.&quot;&quot;&quot;</span>
 
+
 
+    <span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">&#39;engine&#39;</span><span class="p">,</span> <span class="s1">&#39;engine_name&#39;</span><span class="p">,</span> <span class="s1">&#39;lock&#39;</span><span class="p">,</span> <span class="s1">&#39;suspended_status&#39;</span><span class="p">,</span> <span class="s1">&#39;logger&#39;</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="n">engine_name</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">engine</span> <span class="o">=</span> <span class="n">engine</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">engine_name</span> <span class="o">=</span> <span class="n">engine_name</span>
 
+        <span class="bp">self</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_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_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_name</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">suspended_status</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>
 
+
 
+    <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="k">try</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">get_engine_from_settings</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine_name</span><span class="p">))</span>
 
+        <span class="k">except</span> <span class="n">SearxEngineResponseException</span> <span class="k">as</span> <span class="n">exc</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">warning</span><span class="p">(</span><span class="s1">&#39;Fail to initialize // </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">exc</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="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">&#39;Fail to initialize&#39;</span><span class="p">)</span>
 
+        <span class="k">else</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">debug</span><span class="p">(</span><span class="s1">&#39;Initialized&#39;</span><span class="p">)</span>
 
+
 
+    <span class="nd">@property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">has_initialize_function</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</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="s1">&#39;init&#39;</span><span class="p">)</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="n">exception_or_message</span><span class="p">,</span> <span class="n">suspend</span><span class="o">=</span><span class="kc">False</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">&#39;__module__&#39;</span><span class="p">,</span> <span class="s1">&#39;builtins&#39;</span><span class="p">)</span>
 
+            <span class="n">module_name</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span> <span class="k">if</span> <span class="n">module_name</span> <span class="o">==</span> <span class="s1">&#39;builtins&#39;</span> <span class="k">else</span> <span class="n">module_name</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</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_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">&#39;engine&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine_name</span><span class="p">,</span> <span class="s1">&#39;search&#39;</span><span class="p">,</span> <span class="s1">&#39;count&#39;</span><span class="p">,</span> <span class="s1">&#39;error&#39;</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_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_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="n">start_time</span><span class="p">,</span> <span class="n">search_results</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_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_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">&#39;engine&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine_name</span><span class="p">,</span> <span class="s1">&#39;search&#39;</span><span class="p">,</span> <span class="s1">&#39;count&#39;</span><span class="p">,</span> <span class="s1">&#39;successful&#39;</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">&#39;engine&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine_name</span><span class="p">,</span> <span class="s1">&#39;time&#39;</span><span class="p">,</span> <span class="s1">&#39;total&#39;</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">&#39;engine&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine_name</span><span class="p">,</span> <span class="s1">&#39;time&#39;</span><span class="p">,</span> <span class="s1">&#39;http&#39;</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="n">start_time</span><span class="p">,</span> <span class="n">search_results</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">&#39;_timeout&#39;</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">&#39;timeout&#39;</span><span class="p">,</span> <span class="kc">None</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="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_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="n">engine_category</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a set of (see :ref:`request params &lt;engine request arguments&gt;`) or</span>
 
+<span class="sd">        ``None`` if request is not supported.</span>
 
+
 
+<span class="sd">        Not supported conditions (``None`` is returned):</span>
 
+
 
+<span class="sd">        - A page-number &gt; 1 when engine does not support paging.</span>
 
+<span class="sd">        - A time range when the engine does not support time range.</span>
 
+<span class="sd">        &quot;&quot;&quot;</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">&gt;</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">settings</span><span class="p">[</span><span class="s1">&#39;search&#39;</span><span class="p">][</span><span class="s1">&#39;max_page&#39;</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">&lt;</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="o">=</span> <span class="p">{}</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s2">&quot;query&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_query</span><span class="o">.</span><span class="n">query</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;category&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engine_category</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_query</span><span class="o">.</span><span class="n">safesearch</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_query</span><span class="o">.</span><span class="n">time_range</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;engine_data&#39;</span><span class="p">]</span> <span class="o">=</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_name</span><span class="p">,</span> <span class="p">{})</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</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"># deprecated / vintage --&gt; use params[&#39;searxng_locale&#39;]</span>
 
+        <span class="c1">#</span>
 
+        <span class="c1"># Conditions related to engine&#39;s traits are implemented in engine.traits</span>
 
+        <span class="c1"># module. Don&#39;t do &#39;locale&#39; decisions here in the abstract layer of the</span>
 
+        <span class="c1"># search processor, just pass the value from user&#39;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="s1">&#39;language&#39;</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="s1">&#39;language&#39;</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="k">else</span><span class="p">:</span>
 
+            <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</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="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="n">params</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">timeout_limit</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="n">tests</span> <span class="o">=</span> <span class="nb">getattr</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="s1">&#39;tests&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">tests</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">tests</span> <span class="o">=</span> <span class="nb">getattr</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="s1">&#39;additional_tests&#39;</span><span class="p">,</span> <span class="p">{})</span>
 
+            <span class="n">tests</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_default_tests</span><span class="p">())</span>
 
+        <span class="k">return</span> <span class="n">tests</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="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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 137 - 0
_modules/searx/search/processors/offline.html
View File 

@@ -0,0 +1,137 @@
 
+<!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 &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../../search.html" accesskey="U">searx.search</a> &#187;</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">&quot;&quot;&quot;Processors for engine-type: ``offline``</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</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>
 
+
 
+
 
+<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">&quot;&quot;&quot;Processor class used by ``offline`` engines&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;offline&#39;</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="n">params</span><span class="p">):</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">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="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="n">params</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">timeout_limit</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">_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="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">&#39;engine </span><span class="si">{0}</span><span class="s1"> : invalid input : </span><span class="si">{1}</span><span class="s1">&#39;</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_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">&#39;engine </span><span class="si">{0}</span><span class="s1"> : exception : </span><span class="si">{1}</span><span class="s1">&#39;</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_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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 350 - 0
_modules/searx/search/processors/online.html
View File 

@@ -0,0 +1,350 @@
 
+<!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 &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../../search.html" accesskey="U">searx.search</a> &#187;</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">&quot;&quot;&quot;Processors for engine-type: ``online``</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="c1"># pylint: disable=use-dict-literal</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>
 
+
 
+
 
+<div class="viewcode-block" id="default_request_params">
 
+<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online.default_request_params">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">default_request_params</span><span class="p">():</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Default request parameters for ``online`` engines.&quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="p">{</span>
 
+        <span class="c1"># fmt: off</span>
 
+        <span class="s1">&#39;method&#39;</span><span class="p">:</span> <span class="s1">&#39;GET&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;headers&#39;</span><span class="p">:</span> <span class="p">{},</span>
 
+        <span class="s1">&#39;data&#39;</span><span class="p">:</span> <span class="p">{},</span>
 
+        <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
 
+        <span class="s1">&#39;cookies&#39;</span><span class="p">:</span> <span class="p">{},</span>
 
+        <span class="s1">&#39;auth&#39;</span><span class="p">:</span> <span class="kc">None</span>
 
+        <span class="c1"># fmt: on</span>
 
+    <span class="p">}</span></div>
 
+
 
+
 
+
 
+<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">&quot;&quot;&quot;Processor class for ``online`` engines.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;online&#39;</span>
 
+
 
+    <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="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="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="n">start_time</span><span class="o">=</span><span class="n">default_timer</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_name</span><span class="p">)</span>
 
+        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">initialize</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="n">engine_category</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a set of :ref:`request params &lt;engine request online&gt;` or ``None``</span>
 
+<span class="sd">        if request is not supported.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="n">params</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">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="c1"># add default params</span>
 
+        <span class="n">params</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">default_request_params</span><span class="p">())</span>
 
+
 
+        <span class="c1"># add an user agent</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;User-Agent&#39;</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">&quot;</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&quot;</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">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">][</span><span class="s1">&#39;Accept-Language&#39;</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="s1">&#39;HTTP Accept-Language: </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Accept-Language&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">))</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="c1"># create dictionary which contain all</span>
 
+        <span class="c1"># information about the request</span>
 
+        <span class="n">request_args</span> <span class="o">=</span> <span class="nb">dict</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="s1">&#39;headers&#39;</span><span class="p">],</span> <span class="n">cookies</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">],</span> <span class="n">auth</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;auth&#39;</span><span class="p">])</span>
 
+
 
+        <span class="c1"># verify</span>
 
+        <span class="c1"># if not None, it overrides the verify value defined in the network.</span>
 
+        <span class="c1"># use False to accept any server certificate</span>
 
+        <span class="c1"># use a path to file to specify a server certificate</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="s1">&#39;verify&#39;</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="s1">&#39;verify&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;verify&#39;</span><span class="p">]</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="s1">&#39;max_redirects&#39;</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="s1">&#39;max_redirects&#39;</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="s1">&#39;allow_redirects&#39;</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="s1">&#39;allow_redirects&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;allow_redirects&#39;</span><span class="p">]</span>
 
+
 
+        <span class="c1"># soft_max_redirects</span>
 
+        <span class="n">soft_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="s1">&#39;soft_max_redirects&#39;</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="s1">&#39;raise_for_httperror&#39;</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="s1">&#39;raise_for_httperror&#39;</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="s1">&#39;method&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;GET&#39;</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="n">request_args</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</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="s1">&#39;url&#39;</span><span class="p">],</span> <span class="o">**</span><span class="n">request_args</span><span class="p">)</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">&gt;</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="s1">&#39;&#39;</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="s1">&#39;&#39;</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_name</span><span class="p">,</span>
 
+                <span class="s1">&#39;</span><span class="si">{}</span><span class="s1"> redirects, maximum: </span><span class="si">{}</span><span class="s1">&#39;</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="n">params</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="s1">&#39;url&#39;</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="bp">self</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="n">result_container</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="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_name</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">&quot;SSLError </span><span class="si">{}</span><span class="s2">, verify=</span><span class="si">{}</span><span class="s2">&quot;</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_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">&quot;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">&quot;</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">&quot;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">&quot;</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="n">SearxEngineCaptchaException</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="s1">&#39;CAPTCHA&#39;</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="n">SearxEngineTooManyRequestsException</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="s1">&#39;Too many requests&#39;</span><span class="p">)</span>
 
+        <span class="k">except</span> <span class="n">SearxEngineAccessDeniedException</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="s1">&#39;SearXNG is blocked&#39;</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">&#39;exception : </span><span class="si">{0}</span><span class="s1">&#39;</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="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="n">tests</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+        <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;simple&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;life&#39;</span><span class="p">,</span> <span class="s1">&#39;computer&#39;</span><span class="p">)},</span>
 
+            <span class="s1">&#39;result_container&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;not_empty&#39;</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="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;paging&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
 
+            <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;paging&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+                <span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="s1">&#39;time&#39;</span><span class="p">,</span> <span class="s1">&#39;pageno&#39;</span><span class="p">:</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="mi">3</span><span class="p">)},</span>
 
+                <span class="s1">&#39;result_container&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;not_empty&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;test&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;unique_results&#39;</span><span class="p">],</span>
 
+            <span class="p">}</span>
 
+            <span class="k">if</span> <span class="s1">&#39;general&#39;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">categories</span><span class="p">:</span>
 
+                <span class="c1"># avoid documentation about HTML tags (&lt;time&gt; and &lt;input type=&quot;time&quot;&gt;)</span>
 
+                <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;paging&#39;</span><span class="p">][</span><span class="s1">&#39;matrix&#39;</span><span class="p">][</span><span class="s1">&#39;query&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;news&#39;</span>
 
+
 
+        <span class="k">if</span> <span class="nb">getattr</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="s1">&#39;time_range&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
 
+            <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;time_range&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+                <span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="s1">&#39;news&#39;</span><span class="p">,</span> <span class="s1">&#39;time_range&#39;</span><span class="p">:</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;day&#39;</span><span class="p">)},</span>
 
+                <span class="s1">&#39;result_container&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;not_empty&#39;</span><span class="p">],</span>
 
+                <span class="s1">&#39;test&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;unique_results&#39;</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="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;traits&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
 
+            <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;lang_fr&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+                <span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="s1">&#39;paris&#39;</span><span class="p">,</span> <span class="s1">&#39;lang&#39;</span><span class="p">:</span> <span class="s1">&#39;fr&#39;</span><span class="p">},</span>
 
+                <span class="s1">&#39;result_container&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;not_empty&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;has_language&#39;</span><span class="p">,</span> <span class="s1">&#39;fr&#39;</span><span class="p">)],</span>
 
+            <span class="p">}</span>
 
+            <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;lang_en&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+                <span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="s1">&#39;paris&#39;</span><span class="p">,</span> <span class="s1">&#39;lang&#39;</span><span class="p">:</span> <span class="s1">&#39;en&#39;</span><span class="p">},</span>
 
+                <span class="s1">&#39;result_container&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;not_empty&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;has_language&#39;</span><span class="p">,</span> <span class="s1">&#39;en&#39;</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="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">,</span> <span class="s1">&#39;safesearch&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
 
+            <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="s1">&#39;porn&#39;</span><span class="p">,</span> <span class="s1">&#39;safesearch&#39;</span><span class="p">:</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="s1">&#39;test&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;unique_results&#39;</span><span class="p">]}</span>
 
+
 
+        <span class="k">return</span> <span class="n">tests</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 187 - 0
_modules/searx/search/processors/online_currency.html
View File 

@@ -0,0 +1,187 @@
 
+<!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 &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../../search.html" accesskey="U">searx.search</a> &#187;</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">&quot;&quot;&quot;Processors for engine-type: ``online_currency``</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</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">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="n">parser_re</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="s1">&#39;.*?(</span><span class="se">\\</span><span class="s1">d+(?:</span><span class="se">\\</span><span class="s1">.</span><span class="se">\\</span><span class="s1">d+)?) ([^.0-9]+) (?:in|to) ([^.0-9]+)&#39;</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="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="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="s1">&#39;-&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="p">)</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s1">&#39;s&#39;</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="s1">&#39; +&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</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="s1">&#39;NFKD&#39;</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>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">name_to_iso4217</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
 
+    <span class="n">name</span> <span class="o">=</span> <span class="n">normalize_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+    <span class="n">currency</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="p">[</span><span class="s1">&#39;names&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="p">[</span><span class="n">name</span><span class="p">])</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">currency</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">currency</span>
 
+    <span class="k">return</span> <span class="n">currency</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">iso4217_to_name</span><span class="p">(</span><span class="n">iso4217</span><span class="p">,</span> <span class="n">language</span><span class="p">):</span>
 
+    <span class="k">return</span> <span class="n">CURRENCIES</span><span class="p">[</span><span class="s1">&#39;iso4217&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">iso4217</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">language</span><span class="p">,</span> <span class="n">iso4217</span><span class="p">)</span>
 
+
 
+
 
+<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">&quot;&quot;&quot;Processor class used by ``online_currency`` engines.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;online_currency&#39;</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="n">engine_category</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a set of :ref:`request params &lt;engine request online_currency&gt;`</span>
 
+<span class="sd">        or ``None`` if search query does not match to :py:obj:`parser_re`.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">params</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">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">parser_re</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="n">from_currency</span> <span class="o">=</span> <span class="n">name_to_iso4217</span><span class="p">(</span><span class="n">from_currency</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
 
+        <span class="n">to_currency</span> <span class="o">=</span> <span class="n">name_to_iso4217</span><span class="p">(</span><span class="n">to_currency</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
 
+
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;amount&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">amount</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;from&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">from_currency</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;to&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">to_currency</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;from_name&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">iso4217_to_name</span><span class="p">(</span><span class="n">from_currency</span><span class="p">,</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;to_name&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">iso4217_to_name</span><span class="p">(</span><span class="n">to_currency</span><span class="p">,</span> <span class="s1">&#39;en&#39;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+    <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="n">tests</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+        <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;currency&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+            <span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="s1">&#39;1337 usd in rmb&#39;</span><span class="p">},</span>
 
+            <span class="s1">&#39;result_container&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;has_answer&#39;</span><span class="p">],</span>
 
+        <span class="p">}</span>
 
+
 
+        <span class="k">return</span> <span class="n">tests</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 174 - 0
_modules/searx/search/processors/online_dictionary.html
View File 

@@ -0,0 +1,174 @@
 
+<!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 &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../../search.html" accesskey="U">searx.search</a> &#187;</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">&quot;&quot;&quot;Processors for engine-type: ``online_dictionary``</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</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.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">is_valid_lang</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="n">parser_re</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="s1">&#39;.*?([a-z]+)-([a-z]+) (.+)$&#39;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">I</span><span class="p">)</span>
 
+
 
+
 
+<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">&quot;&quot;&quot;Processor class used by ``online_dictionary`` engines.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;online_dictionary&#39;</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="n">engine_category</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a set of :ref:`request params &lt;engine request online_dictionary&gt;` or</span>
 
+<span class="sd">        ``None`` if search query does not match to :py:obj:`parser_re`.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="n">params</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">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">parser_re</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">is_valid_lang</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">is_valid_lang</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="s1">&#39;from_lang&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">from_lang</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;to_lang&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">to_lang</span>
 
+        <span class="n">params</span><span class="p">[</span><span class="s1">&#39;query&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span>
 
+
 
+        <span class="k">return</span> <span class="n">params</span></div>
 
+
 
+
 
+    <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="n">tests</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+        <span class="k">if</span> <span class="nb">getattr</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="s1">&#39;paging&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
 
+            <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;translation_paging&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+                <span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="s1">&#39;en-es house&#39;</span><span class="p">,</span> <span class="s1">&#39;pageno&#39;</span><span class="p">:</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="mi">3</span><span class="p">)},</span>
 
+                <span class="s1">&#39;result_container&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;not_empty&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;one_title_contains&#39;</span><span class="p">,</span> <span class="s1">&#39;house&#39;</span><span class="p">)],</span>
 
+                <span class="s1">&#39;test&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;unique_results&#39;</span><span class="p">],</span>
 
+            <span class="p">}</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">tests</span><span class="p">[</span><span class="s1">&#39;translation&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
 
+                <span class="s1">&#39;matrix&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="s1">&#39;en-es house&#39;</span><span class="p">},</span>
 
+                <span class="s1">&#39;result_container&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;not_empty&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;one_title_contains&#39;</span><span class="p">,</span> <span class="s1">&#39;house&#39;</span><span class="p">)],</span>
 
+            <span class="p">}</span>
 
+
 
+        <span class="k">return</span> <span class="n">tests</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 159 - 0
_modules/searx/search/processors/online_url_search.html
View File 

@@ -0,0 +1,159 @@
 
+<!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 &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
 
+          <li class="nav-item nav-item-2"><a href="../../search.html" accesskey="U">searx.search</a> &#187;</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">&quot;&quot;&quot;Processors for engine-type: ``online_url_search``</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</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="n">re_search_urls</span> <span class="o">=</span> <span class="p">{</span>
 
+    <span class="s1">&#39;http&#39;</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="s1">&#39;https?:\/\/[^ ]*&#39;</span><span class="p">),</span>
 
+    <span class="s1">&#39;ftp&#39;</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="s1">&#39;ftps?:\/\/[^ ]*&#39;</span><span class="p">),</span>
 
+    <span class="s1">&#39;data:image&#39;</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="s1">&#39;data:image/[^; ]*;base64,[^ ]*&#39;</span><span class="p">),</span>
 
+<span class="p">}</span>
 
+
 
+
 
+<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">&quot;&quot;&quot;Processor class used by ``online_url_search`` engines.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">engine_type</span> <span class="o">=</span> <span class="s1">&#39;online_url_search&#39;</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="n">engine_category</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns a set of :ref:`request params &lt;engine request online&gt;` or ``None`` if</span>
 
+<span class="sd">        search query does not match to :py:obj:`re_search_urls`.</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="n">params</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">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">url_match</span> <span class="o">=</span> <span class="kc">False</span>
 
+        <span class="n">search_urls</span> <span class="o">=</span> <span class="p">{}</span>
 
+
 
+        <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">re_search_urls</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+            <span class="n">m</span> <span class="o">=</span> <span class="n">v</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="n">v</span> <span class="o">=</span> <span class="kc">None</span>
 
+            <span class="k">if</span> <span class="n">m</span><span class="p">:</span>
 
+                <span class="n">url_match</span> <span class="o">=</span> <span class="kc">True</span>
 
+                <span class="n">v</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="n">search_urls</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">url_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="s1">&#39;search_urls&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_urls</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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 337 - 0
_modules/searx/settings_loader.html
View File 

@@ -0,0 +1,337 @@
 
+<!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.settings_loader &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.settings_loader</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.settings_loader</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Implementations for loading configurations from YAML files.  This essentially</span>
 
+<span class="sd">includes the configuration of the (:ref:`SearXNG appl &lt;searxng settings.yml&gt;`)</span>
 
+<span class="sd">server. The default configuration for the application server is loaded from the</span>
 
+<span class="sd">:origin:`DEFAULT_SETTINGS_FILE &lt;searx/settings.yml&gt;`.  This default</span>
 
+<span class="sd">configuration can be completely replaced or :ref:`customized individually</span>
 
+<span class="sd">&lt;use_default_settings.yml&gt;` and the ``SEARXNG_SETTINGS_PATH`` environment</span>
 
+<span class="sd">variable can be used to set the location from which the local customizations are</span>
 
+<span class="sd">to be loaded. The rules used for this can be found in the</span>
 
+<span class="sd">:py:obj:`get_user_cfg_folder` function.</span>
 
+
 
+<span class="sd">- By default, local configurations are expected in folder ``/etc/searxng`` from</span>
 
+<span class="sd">  where applications can load them with the :py:obj:`get_yaml_cfg` function.</span>
 
+
 
+<span class="sd">- By default, customized :ref:`SearXNG appl &lt;searxng settings.yml&gt;` settings are</span>
 
+<span class="sd">  expected in a file named ``settings.yml``.</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">os.path</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Mapping</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">itertools</span><span class="w"> </span><span class="kn">import</span> <span class="n">filterfalse</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">yaml</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">SearxSettingsException</span>
 
+
 
+<span class="n">searx_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
 
+
 
+<span class="n">SETTINGS_YAML</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s2">&quot;settings.yml&quot;</span><span class="p">)</span>
 
+<span class="n">DEFAULT_SETTINGS_FILE</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">searx_dir</span><span class="p">)</span> <span class="o">/</span> <span class="n">SETTINGS_YAML</span>
 
+<span class="sd">&quot;&quot;&quot;The :origin:`searx/settings.yml` file with all the default settings.&quot;&quot;&quot;</span>
 
+
 
+
 
+<div class="viewcode-block" id="load_yaml">
 
+<a class="viewcode-back" href="../../src/searx.settings.html#searx.settings_loader.load_yaml">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">load_yaml</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Path</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Load YAML config from a file.&quot;&quot;&quot;</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">settings_yaml</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">yaml</span><span class="o">.</span><span class="n">safe_load</span><span class="p">(</span><span class="n">settings_yaml</span><span class="p">)</span> <span class="ow">or</span> <span class="p">{}</span>
 
+    <span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="n">SearxSettingsException</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">file_name</span><span class="p">))</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span>
 
+    <span class="k">except</span> <span class="n">yaml</span><span class="o">.</span><span class="n">YAMLError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="n">SearxSettingsException</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">file_name</span><span class="p">))</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_yaml_cfg">
 
+<a class="viewcode-back" href="../../src/searx.settings.html#searx.settings_loader.get_yaml_cfg">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_yaml_cfg</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Shortcut to load a YAML config from a file, located in the</span>
 
+
 
+<span class="sd">    - :py:obj:`get_user_cfg_folder` or</span>
 
+<span class="sd">    - in the ``searx`` folder of the SearXNG installation</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">folder</span> <span class="o">=</span> <span class="n">get_user_cfg_folder</span><span class="p">()</span> <span class="ow">or</span> <span class="n">Path</span><span class="p">(</span><span class="n">searx_dir</span><span class="p">)</span>
 
+    <span class="n">fname</span> <span class="o">=</span> <span class="n">folder</span> <span class="o">/</span> <span class="n">file_name</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">fname</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
 
+        <span class="k">raise</span> <span class="ne">FileNotFoundError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;File </span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s2"> does not exist!&quot;</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">load_yaml</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_user_cfg_folder">
 
+<a class="viewcode-back" href="../../src/searx.settings.html#searx.settings_loader.get_user_cfg_folder">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_user_cfg_folder</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns folder where the local configurations are located.</span>
 
+
 
+<span class="sd">    1. If the ``SEARXNG_SETTINGS_PATH`` environment is set and points to a</span>
 
+<span class="sd">       folder (e.g. ``/etc/mysxng/``), all local configurations are expected in</span>
 
+<span class="sd">       this folder.  The settings of the :ref:`SearXNG appl &lt;searxng</span>
 
+<span class="sd">       settings.yml&gt;` then expected in ``settings.yml``</span>
 
+<span class="sd">       (e.g. ``/etc/mysxng/settings.yml``).</span>
 
+
 
+<span class="sd">    2. If the ``SEARXNG_SETTINGS_PATH`` environment is set and points to a file</span>
 
+<span class="sd">       (e.g. ``/etc/mysxng/myinstance.yml``), this file contains the settings of</span>
 
+<span class="sd">       the :ref:`SearXNG appl &lt;searxng settings.yml&gt;` and the folder</span>
 
+<span class="sd">       (e.g. ``/etc/mysxng/``) is used for all other configurations.</span>
 
+
 
+<span class="sd">       This type (``SEARXNG_SETTINGS_PATH`` points to a file) is suitable for</span>
 
+<span class="sd">       use cases in which different profiles of the :ref:`SearXNG appl &lt;searxng</span>
 
+<span class="sd">       settings.yml&gt;` are to be managed, such as in test scenarios.</span>
 
+
 
+<span class="sd">    3. If folder ``/etc/searxng`` exists, it is used.</span>
 
+
 
+<span class="sd">    In case none of the above path exists, ``None`` is returned.  In case of</span>
 
+<span class="sd">    environment ``SEARXNG_SETTINGS_PATH`` is set, but the (folder or file) does</span>
 
+<span class="sd">    not exists, a :py:obj:`EnvironmentError` is raised.</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">folder</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">settings_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;SEARXNG_SETTINGS_PATH&quot;</span><span class="p">)</span>
 
+
 
+    <span class="c1"># Disable default /etc/searxng is intended exclusively for internal testing purposes</span>
 
+    <span class="c1"># and is therefore not documented!</span>
 
+    <span class="n">disable_etc</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;SEARXNG_DISABLE_ETC_SETTINGS&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;1&#39;</span><span class="p">,</span> <span class="s1">&#39;true&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">settings_path</span><span class="p">:</span>
 
+        <span class="c1"># rule 1. and 2.</span>
 
+        <span class="n">settings_path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">settings_path</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">settings_path</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
 
+            <span class="n">folder</span> <span class="o">=</span> <span class="n">settings_path</span>
 
+        <span class="k">elif</span> <span class="n">settings_path</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
 
+            <span class="n">folder</span> <span class="o">=</span> <span class="n">settings_path</span><span class="o">.</span><span class="n">parent</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="k">raise</span> <span class="ne">EnvironmentError</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">settings_path</span><span class="si">}</span><span class="s2"> not exists!&quot;</span><span class="p">,</span> <span class="n">settings_path</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">folder</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">disable_etc</span><span class="p">:</span>
 
+        <span class="c1"># default: rule 3.</span>
 
+        <span class="n">folder</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s2">&quot;/etc/searxng&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">folder</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
 
+            <span class="n">folder</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+    <span class="k">return</span> <span class="n">folder</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">update_dict</span><span class="p">(</span><span class="n">default_dict</span><span class="p">,</span> <span class="n">user_dict</span><span class="p">):</span>
 
+    <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">user_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
 
+            <span class="n">default_dict</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">update_dict</span><span class="p">(</span><span class="n">default_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="p">{}),</span> <span class="n">v</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">default_dict</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
 
+    <span class="k">return</span> <span class="n">default_dict</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">update_settings</span><span class="p">(</span><span class="n">default_settings</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">user_settings</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
 
+    <span class="c1"># pylint: disable=too-many-branches</span>
 
+
 
+    <span class="c1"># merge everything except the engines</span>
 
+    <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+        <span class="k">if</span> <span class="n">k</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;use_default_settings&#39;</span><span class="p">,</span> <span class="s1">&#39;engines&#39;</span><span class="p">):</span>
 
+            <span class="k">if</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">default_settings</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
 
+                <span class="n">update_dict</span><span class="p">(</span><span class="n">default_settings</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="n">v</span><span class="p">)</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">default_settings</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
 
+
 
+    <span class="n">categories_as_tabs</span> <span class="o">=</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;categories_as_tabs&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">categories_as_tabs</span><span class="p">:</span>
 
+        <span class="n">default_settings</span><span class="p">[</span><span class="s1">&#39;categories_as_tabs&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">categories_as_tabs</span>
 
+
 
+    <span class="c1"># parse the engines</span>
 
+    <span class="n">remove_engines</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">keep_only_engines</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="n">use_default_settings</span> <span class="o">=</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;use_default_settings&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">use_default_settings</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+        <span class="n">remove_engines</span> <span class="o">=</span> <span class="n">use_default_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;engines&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;remove&#39;</span><span class="p">)</span>
 
+        <span class="n">keep_only_engines</span> <span class="o">=</span> <span class="n">use_default_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;engines&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;keep_only&#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;engines&#39;</span> <span class="ow">in</span> <span class="n">user_settings</span> <span class="ow">or</span> <span class="n">remove_engines</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">keep_only_engines</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="n">engines</span> <span class="o">=</span> <span class="n">default_settings</span><span class="p">[</span><span class="s1">&#39;engines&#39;</span><span class="p">]</span>
 
+
 
+        <span class="c1"># parse &quot;use_default_settings.engines.remove&quot;</span>
 
+        <span class="k">if</span> <span class="n">remove_engines</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">engines</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">filterfalse</span><span class="p">(</span><span class="k">lambda</span> <span class="n">engine</span><span class="p">:</span> <span class="p">(</span><span class="n">engine</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">))</span> <span class="ow">in</span> <span class="n">remove_engines</span><span class="p">,</span> <span class="n">engines</span><span class="p">))</span>
 
+
 
+        <span class="c1"># parse &quot;use_default_settings.engines.keep_only&quot;</span>
 
+        <span class="k">if</span> <span class="n">keep_only_engines</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="n">engines</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">engine</span><span class="p">:</span> <span class="p">(</span><span class="n">engine</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">))</span> <span class="ow">in</span> <span class="n">keep_only_engines</span><span class="p">,</span> <span class="n">engines</span><span class="p">))</span>
 
+
 
+        <span class="c1"># parse &quot;engines&quot;</span>
 
+        <span class="n">user_engines</span> <span class="o">=</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;engines&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">user_engines</span><span class="p">:</span>
 
+            <span class="n">engines_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">definition</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span> <span class="n">definition</span><span class="p">)</span> <span class="k">for</span> <span class="n">definition</span> <span class="ow">in</span> <span class="n">engines</span><span class="p">)</span>
 
+            <span class="k">for</span> <span class="n">user_engine</span> <span class="ow">in</span> <span class="n">user_engines</span><span class="p">:</span>
 
+                <span class="n">default_engine</span> <span class="o">=</span> <span class="n">engines_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">user_engine</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">])</span>
 
+                <span class="k">if</span> <span class="n">default_engine</span><span class="p">:</span>
 
+                    <span class="n">update_dict</span><span class="p">(</span><span class="n">default_engine</span><span class="p">,</span> <span class="n">user_engine</span><span class="p">)</span>
 
+                <span class="k">else</span><span class="p">:</span>
 
+                    <span class="n">engines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">user_engine</span><span class="p">)</span>
 
+
 
+        <span class="c1"># store the result</span>
 
+        <span class="n">default_settings</span><span class="p">[</span><span class="s1">&#39;engines&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engines</span>
 
+
 
+    <span class="k">return</span> <span class="n">default_settings</span>
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">is_use_default_settings</span><span class="p">(</span><span class="n">user_settings</span><span class="p">):</span>
 
+
 
+    <span class="n">use_default_settings</span> <span class="o">=</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;use_default_settings&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">use_default_settings</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">True</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">use_default_settings</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="kc">True</span>
 
+    <span class="k">if</span> <span class="n">use_default_settings</span> <span class="ow">is</span> <span class="kc">False</span> <span class="ow">or</span> <span class="n">use_default_settings</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">False</span>
 
+    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Invalid value for use_default_settings&#39;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="load_settings">
 
+<a class="viewcode-back" href="../../src/searx.settings.html#searx.settings_loader.load_settings">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">load_settings</span><span class="p">(</span><span class="n">load_user_settings</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</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="w">    </span><span class="sd">&quot;&quot;&quot;Function for loading the settings of the SearXNG application</span>
 
+<span class="sd">    (:ref:`settings.yml &lt;searxng settings.yml&gt;`).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;load the default settings from </span><span class="si">{</span><span class="n">DEFAULT_SETTINGS_FILE</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="n">cfg</span> <span class="o">=</span> <span class="n">load_yaml</span><span class="p">(</span><span class="n">DEFAULT_SETTINGS_FILE</span><span class="p">)</span>
 
+    <span class="n">cfg_folder</span> <span class="o">=</span> <span class="n">get_user_cfg_folder</span><span class="p">()</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">load_user_settings</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">cfg_folder</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">cfg</span><span class="p">,</span> <span class="n">msg</span>
 
+
 
+    <span class="n">settings_yml</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;SEARXNG_SETTINGS_PATH&quot;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">settings_yml</span> <span class="ow">and</span> <span class="n">Path</span><span class="p">(</span><span class="n">settings_yml</span><span class="p">)</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
 
+        <span class="c1"># see get_user_cfg_folder() --&gt; SEARXNG_SETTINGS_PATH points to a file</span>
 
+        <span class="n">settings_yml</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">settings_yml</span><span class="p">)</span><span class="o">.</span><span class="n">name</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="c1"># see get_user_cfg_folder() --&gt; SEARXNG_SETTINGS_PATH points to a folder</span>
 
+        <span class="n">settings_yml</span> <span class="o">=</span> <span class="n">SETTINGS_YAML</span>
 
+
 
+    <span class="n">cfg_file</span> <span class="o">=</span> <span class="n">cfg_folder</span> <span class="o">/</span> <span class="n">settings_yml</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">cfg_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
 
+        <span class="k">return</span> <span class="n">cfg</span><span class="p">,</span> <span class="n">msg</span>
 
+
 
+    <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;load the user settings from </span><span class="si">{</span><span class="n">cfg_file</span><span class="si">}</span><span class="s2">&quot;</span>
 
+    <span class="n">user_cfg</span> <span class="o">=</span> <span class="n">load_yaml</span><span class="p">(</span><span class="n">cfg_file</span><span class="p">)</span>
 
+
 
+    <span class="k">if</span> <span class="n">is_use_default_settings</span><span class="p">(</span><span class="n">user_cfg</span><span class="p">):</span>
 
+        <span class="c1"># the user settings are merged with the default configuration</span>
 
+        <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;merge the default settings ( </span><span class="si">{</span><span class="n">DEFAULT_SETTINGS_FILE</span><span class="si">}</span><span class="s2"> ) and the user settings ( </span><span class="si">{</span><span class="n">cfg_file</span><span class="si">}</span><span class="s2"> )&quot;</span>
 
+        <span class="n">update_settings</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">user_cfg</span><span class="p">)</span>
 
+    <span class="k">else</span><span class="p">:</span>
 
+        <span class="n">cfg</span> <span class="o">=</span> <span class="n">user_cfg</span>
 
+
 
+    <span class="k">return</span> <span class="n">cfg</span><span class="p">,</span> <span class="n">msg</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 454 - 0
_modules/searx/sqlitedb.html
View File 

@@ -0,0 +1,454 @@
 
+<!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.sqlitedb &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.sqlitedb</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.sqlitedb</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Implementations to make access to SQLite databases a little more convenient.</span>
 
+
 
+<span class="sd">:py:obj:`SQLiteAppl`</span>
 
+<span class="sd">  Abstract class with which DB applications can be implemented.</span>
 
+
 
+<span class="sd">:py:obj:`SQLiteProperties`:</span>
 
+<span class="sd">  Class to manage properties stored in a database.</span>
 
+
 
+<span class="sd">----</span>
 
+
 
+<span class="sd">&quot;&quot;&quot;</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
+
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">sys</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">sqlite3</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">threading</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">abc</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="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="s1">&#39;sqlitedb&#39;</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="SQLiteAppl">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SQLiteAppl</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Abstract base class for implementing convenient DB access in SQLite</span>
 
+<span class="sd">    applications.  In the constructor, a :py:obj:`SQLiteProperties` instance is</span>
 
+<span class="sd">    already aggregated under ``self.properties``.&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">DDL_CREATE_TABLES</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="p">{}</span>
 
+
 
+    <span class="n">DB_SCHEMA</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;As soon as changes are made to the DB schema, the version number must be</span>
 
+<span class="sd">    increased.  Changes to the version number require the DB to be recreated (or</span>
 
+<span class="sd">    migrated / if an migration path exists and is implemented).&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">SQLITE_THREADING_MODE</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="mi">0</span><span class="p">:</span> <span class="s2">&quot;single-thread&quot;</span><span class="p">,</span>
 
+        <span class="mi">1</span><span class="p">:</span> <span class="s2">&quot;multi-thread&quot;</span><span class="p">,</span>
 
+        <span class="mi">3</span><span class="p">:</span> <span class="s2">&quot;serialized&quot;</span><span class="p">}[</span><span class="n">sqlite3</span><span class="o">.</span><span class="n">threadsafety</span><span class="p">]</span>  <span class="c1"># fmt:skip</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Threading mode of the SQLite library.  Depends on the options used at</span>
 
+<span class="sd">    compile time and is different for different distributions and architectures.</span>
 
+
 
+<span class="sd">    Possible values are 0:``single-thread``, 1:``multi-thread``,</span>
 
+<span class="sd">    3:``serialized`` (see :py:obj:`sqlite3.threadsafety`).  Pre- Python 3.11</span>
 
+<span class="sd">    this value was hard coded to 1.</span>
 
+
 
+<span class="sd">    Depending on this value, optimizations are made, e.g. in “serialized” mode</span>
 
+<span class="sd">    it is not necessary to create a separate DB connector for each thread.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">SQLITE_JOURNAL_MODE</span> <span class="o">=</span> <span class="s2">&quot;WAL&quot;</span>
 
+    <span class="n">SQLITE_CONNECT_ARGS</span> <span class="o">=</span> <span class="p">{</span>
 
+        <span class="c1"># &quot;timeout&quot;: 5.0,</span>
 
+        <span class="c1"># &quot;detect_types&quot;: 0,</span>
 
+        <span class="s2">&quot;check_same_thread&quot;</span><span class="p">:</span> <span class="nb">bool</span><span class="p">(</span><span class="n">SQLITE_THREADING_MODE</span> <span class="o">!=</span> <span class="s2">&quot;serialized&quot;</span><span class="p">),</span>
 
+        <span class="s2">&quot;cached_statements&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>  <span class="c1"># https://github.com/python/cpython/issues/118172</span>
 
+        <span class="c1"># &quot;uri&quot;: False,</span>
 
+        <span class="s2">&quot;autocommit&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
 
+    <span class="p">}</span>  <span class="c1"># fmt:skip</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Connection arguments (:py:obj:`sqlite3.connect`)</span>
 
+
 
+<span class="sd">    ``check_same_thread``:</span>
 
+<span class="sd">      Is disabled by default when :py:obj:`SQLITE_THREADING_MODE` is</span>
 
+<span class="sd">      ``serialized``.  The check is more of a hindrance in this case because it</span>
 
+<span class="sd">      would prevent a DB connector from being used in multiple threads.</span>
 
+
 
+<span class="sd">    ``autocommit``:</span>
 
+<span class="sd">      Is disabled by default.  Note: autocommit option has been added in Python</span>
 
+<span class="sd">      3.12.</span>
 
+
 
+<span class="sd">    ``cached_statements``:</span>
 
+<span class="sd">      Is set to ``0`` by default.  Note: Python 3.12+ fetch result are not</span>
 
+<span class="sd">      consistent in multi-threading application and causing an API misuse error.</span>
 
+
 
+<span class="sd">      The multithreading use in SQLiteAppl is intended and supported if</span>
 
+<span class="sd">      threadsafety is set to 3 (aka &quot;serialized&quot;). CPython supports “serialized”</span>
 
+<span class="sd">      from version 3.12 on, but unfortunately only with errors:</span>
 
+
 
+<span class="sd">      - https://github.com/python/cpython/issues/118172</span>
 
+<span class="sd">      - https://github.com/python/cpython/issues/123873</span>
 
+
 
+<span class="sd">      The workaround for SQLite3 multithreading cache inconsistency ist to set</span>
 
+<span class="sd">      option ``cached_statements`` to ``0`` by default.</span>
 
+<span class="sd">    &quot;&quot;&quot;</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">db_url</span><span class="p">):</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span> <span class="o">=</span> <span class="n">db_url</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">properties</span> <span class="o">=</span> <span class="n">SQLiteProperties</span><span class="p">(</span><span class="n">db_url</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">local</span><span class="p">()</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">False</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_compatibility</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">_compatibility</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_THREADING_MODE</span> <span class="o">==</span> <span class="s2">&quot;serialized&quot;</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">_DB</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
 
+                <span class="sa">f</span><span class="s2">&quot;SQLite library is compiled with </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_THREADING_MODE</span><span class="si">}</span><span class="s2"> mode,&quot;</span>
 
+                <span class="s2">&quot; read https://docs.python.org/3/library/sqlite3.html#sqlite3.threadsafety&quot;</span>
 
+            <span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">threading</span><span class="o">.</span><span class="n">active_count</span><span class="p">()</span> <span class="o">&gt;</span> <span class="mi">1</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="n">msg</span><span class="p">)</span>
 
+            <span class="k">else</span><span class="p">:</span>
 
+                <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 
+
 
+        <span class="k">if</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">sqlite_version_info</span> <span class="o">&lt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">35</span><span class="p">):</span>
 
+            <span class="c1"># See &quot;Generalize UPSERT:&quot; in https://sqlite.org/releaselog/3_35_0.html</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
 
+                <span class="s2">&quot;SQLite runtime library version </span><span class="si">%s</span><span class="s2"> is not supported (require &gt;= 3.35)&quot;</span><span class="p">,</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">sqlite_version</span>
 
+            <span class="p">)</span>
 
+
 
+<div class="viewcode-block" id="SQLiteAppl.connect">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.connect">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">connect</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Creates a new DB connection (:py:obj:`SQLITE_CONNECT_ARGS`).  If not</span>
 
+<span class="sd">        already done, the DB schema is set up</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+        <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&lt;</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">12</span><span class="p">):</span>
 
+            <span class="c1"># Prior Python 3.12 there is no &quot;autocommit&quot; option</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_CONNECT_ARGS</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;autocommit&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+
 
+        <span class="bp">self</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">debug</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: connect to DB: </span><span class="si">%s</span><span class="s2"> // </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</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="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_CONNECT_ARGS</span><span class="p">)</span>
 
+        <span class="n">conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_CONNECT_ARGS</span><span class="p">)</span>  <span class="c1"># type: ignore</span>
 
+        <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;PRAGMA journal_mode=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">SQLITE_JOURNAL_MODE</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">register_functions</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">conn</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="SQLiteAppl.register_functions">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.register_functions">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">register_functions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Create user-defined_ SQL functions.</span>
 
+
 
+<span class="sd">        ``REGEXP(&lt;pattern&gt;, &lt;field&gt;)`` : 0 | 1</span>
 
+<span class="sd">           `re.search`_ returns (int) 1 for a match and 0 for none match of</span>
 
+<span class="sd">           ``&lt;pattern&gt;`` in ``&lt;field&gt;``.</span>
 
+
 
+<span class="sd">           .. code:: sql</span>
 
+
 
+<span class="sd">              SELECT &#39;12&#39; AS field WHERE REGEXP(&#39;^[0-9][0-9]$&#39;, field)</span>
 
+<span class="sd">              -- 12</span>
 
+
 
+<span class="sd">              SELECT REGEXP(&#39;[0-9][0-9]&#39;, &#39;X12Y&#39;)</span>
 
+<span class="sd">              -- 1</span>
 
+<span class="sd">              SELECT REGEXP(&#39;[0-9][0-9]&#39;, &#39;X1Y&#39;)</span>
 
+<span class="sd">              -- 0</span>
 
+
 
+<span class="sd">        .. _user-defined: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.create_function</span>
 
+<span class="sd">        .. _deterministic: https://sqlite.org/deterministic.html</span>
 
+<span class="sd">        .. _re.search: https://docs.python.org/3/library/re.html#re.search</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="n">conn</span><span class="o">.</span><span class="n">create_function</span><span class="p">(</span><span class="s1">&#39;regexp&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">:</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span> <span class="k">else</span> <span class="mi">0</span><span class="p">,</span> <span class="n">deterministic</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
 
+
 
+
 
+    <span class="nd">@property</span>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">DB</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Connection</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Provides a DB connection.  The connection is a *singleton* and</span>
 
+<span class="sd">        therefore well suited for read access.  If</span>
 
+<span class="sd">        :py:obj:`SQLITE_THREADING_MODE` is ``serialized`` only one DB connection</span>
 
+<span class="sd">        is created for all threads.</span>
 
+
 
+<span class="sd">        .. note::</span>
 
+
 
+<span class="sd">           For dedicated `transaction control`_, it is recommended to create a</span>
 
+<span class="sd">           new connection (:py:obj:`SQLiteAppl.connect`).</span>
 
+
 
+<span class="sd">        .. _transaction control:</span>
 
+<span class="sd">            https://docs.python.org/3/library/sqlite3.html#sqlite3-controlling-transactions</span>
 
+<span class="sd">        &quot;&quot;&quot;</span>
 
+
 
+        <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span><span class="p">,</span> <span class="s1">&#39;DB&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span><span class="o">.</span><span class="n">DB</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
 
+
 
+        <span class="c1"># Theoretically it is possible to reuse the DB cursor across threads as</span>
 
+        <span class="c1"># of Python 3.12, in practice the threading of the cursor seems to me to</span>
 
+        <span class="c1"># be so faulty that I prefer to establish one connection per thread</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
 
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span><span class="o">.</span><span class="n">DB</span>
 
+
 
+        <span class="c1"># In &quot;serialized&quot; mode, SQLite can be safely used by multiple threads</span>
 
+        <span class="c1"># with no restriction.</span>
 
+        <span class="c1">#</span>
 
+        <span class="c1"># if self.SQLITE_THREADING_MODE != &quot;serialized&quot;:</span>
 
+        <span class="c1">#     if getattr(self.thread_local, &#39;DB&#39;, None) is None:</span>
 
+        <span class="c1">#         self.thread_local.DB = self.connect()</span>
 
+        <span class="c1">#     return self.thread_local.DB</span>
 
+        <span class="c1">#</span>
 
+        <span class="c1"># if self._DB is None:</span>
 
+        <span class="c1">#     self._DB = self.connect()  # pylint: disable=attribute-defined-outside-init</span>
 
+        <span class="c1"># return self._DB</span>
 
+
 
+<div class="viewcode-block" id="SQLiteAppl.init">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteAppl.init">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Initializes the DB schema and properties, is only executed once even</span>
 
+<span class="sd">        if called several times.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span><span class="p">:</span>
 
+            <span class="k">return</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">True</span>
 
+
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;init DB: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">init</span><span class="p">()</span>
 
+        <span class="n">ver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="p">(</span><span class="s2">&quot;DB_SCHEMA&quot;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">ver</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">DB</span><span class="p">:</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">create_schema</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">DB</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">ver</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">ver</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">ver</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB_SCHEMA</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">DatabaseError</span><span class="p">(</span><span class="s2">&quot;Expected DB schema v</span><span class="si">%s</span><span class="s2">, DB schema is v</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">DB_SCHEMA</span><span class="p">,</span> <span class="n">ver</span><span class="p">))</span>
 
+            <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;DB_SCHEMA = </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">ver</span><span class="p">)</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">create_schema</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
 
+
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;create schema ..&quot;</span><span class="p">)</span>
 
+        <span class="k">with</span> <span class="n">conn</span><span class="p">:</span>
 
+            <span class="k">for</span> <span class="n">table_name</span><span class="p">,</span> <span class="n">sql</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">DDL_CREATE_TABLES</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
 
+                <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Table </span><span class="si">{</span><span class="n">table_name</span><span class="si">}</span><span class="s2"> created&quot;</span><span class="p">,</span> <span class="n">table_name</span><span class="p">)</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;DB_SCHEMA&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB_SCHEMA</span><span class="p">)</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">&quot;LAST_MAINTENANCE&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="SQLiteProperties">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties">[docs]</a>
 
+<span class="k">class</span><span class="w"> </span><span class="nc">SQLiteProperties</span><span class="p">(</span><span class="n">SQLiteAppl</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Simple class to manage properties of a DB application in the DB.  The</span>
 
+<span class="sd">    object has its own DB connection and transaction area.</span>
 
+
 
+<span class="sd">    .. code:: sql</span>
 
+
 
+<span class="sd">       CREATE TABLE IF NOT EXISTS properties (</span>
 
+<span class="sd">         name       TEXT,</span>
 
+<span class="sd">         value      TEXT,</span>
 
+<span class="sd">         m_time     INTEGER DEFAULT (strftime(&#39;%s&#39;, &#39;now&#39;)),</span>
 
+<span class="sd">         PRIMARY KEY (name))</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">SQLITE_JOURNAL_MODE</span> <span class="o">=</span> <span class="s2">&quot;WAL&quot;</span>
 
+
 
+    <span class="n">DDL_PROPERTIES</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
 
+<span class="s2">CREATE TABLE IF NOT EXISTS properties (</span>
 
+<span class="s2">  name       TEXT,</span>
 
+<span class="s2">  value      TEXT,</span>
 
+<span class="s2">  m_time     INTEGER DEFAULT (strftime(&#39;</span><span class="si">%s</span><span class="s2">&#39;, &#39;now&#39;)),  -- last modified (unix epoch) time in sec.</span>
 
+<span class="s2">  PRIMARY KEY (name))&quot;&quot;&quot;</span>
 
+
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Table to store properties of the DB application&quot;&quot;&quot;</span>
 
+
 
+    <span class="n">SQL_GET</span> <span class="o">=</span> <span class="s2">&quot;SELECT value FROM properties WHERE name = ?&quot;</span>
 
+    <span class="n">SQL_M_TIME</span> <span class="o">=</span> <span class="s2">&quot;SELECT m_time FROM properties WHERE name = ?&quot;</span>
 
+    <span class="n">SQL_SET</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s2">&quot;INSERT INTO properties (name, value) VALUES (?, ?)&quot;</span>
 
+        <span class="s2">&quot;    ON CONFLICT(name) DO UPDATE&quot;</span>
 
+        <span class="s2">&quot;   SET value=excluded.value, m_time=strftime(&#39;</span><span class="si">%s</span><span class="s2">&#39;, &#39;now&#39;)&quot;</span>
 
+    <span class="p">)</span>
 
+    <span class="n">SQL_TABLE_EXISTS</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="s2">&quot;SELECT name FROM sqlite_master&quot;</span>
 
+        <span class="s2">&quot; WHERE type=&#39;table&#39; AND name=&#39;properties&#39;&quot;</span>
 
+    <span class="p">)</span>  <span class="c1"># fmt:skip</span>
 
+    <span class="n">SQLITE_CONNECT_ARGS</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">SQLiteAppl</span><span class="o">.</span><span class="n">SQLITE_CONNECT_ARGS</span><span class="p">)</span>
 
+    <span class="n">SQLITE_CONNECT_ARGS</span><span class="p">[</span><span class="s2">&quot;autocommit&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>  <span class="c1"># This option has no effect before Python 3.12</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">db_url</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>  <span class="c1"># pylint: disable=super-init-not-called</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span> <span class="o">=</span> <span class="n">db_url</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">thread_local</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">local</span><span class="p">()</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">False</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_compatibility</span><span class="p">()</span>
 
+
 
+<div class="viewcode-block" id="SQLiteProperties.init">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.init">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Initializes DB schema of the properties in the DB.&quot;&quot;&quot;</span>
 
+
 
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span><span class="p">:</span>
 
+            <span class="k">return</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_init_done</span> <span class="o">=</span> <span class="kc">True</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;init properties of DB: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_url</span><span class="p">)</span>
 
+        <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
 
+            <span class="n">res</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_TABLE_EXISTS</span><span class="p">)</span>
 
+            <span class="k">if</span> <span class="n">res</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>  <span class="c1"># DB schema needs to be be created</span>
 
+                <span class="bp">self</span><span class="o">.</span><span class="n">create_schema</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="fm">__call__</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="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the value of the property ``name`` or ``default`` if property</span>
 
+<span class="sd">        not exists in DB.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_GET</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,))</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">default</span>
 
+        <span class="k">return</span> <span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+
 
+<div class="viewcode-block" id="SQLiteProperties.set">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.set">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">set</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="n">value</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Set ``value`` of property ``name`` in DB.  If property already</span>
 
+<span class="sd">        exists, update the ``m_time`` (and the value).&quot;&quot;&quot;</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_SET</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
 
+
 
+        <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&lt;=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">12</span><span class="p">):</span>
 
+            <span class="c1"># Prior Python 3.12 there is no &quot;autocommit&quot; option / lets commit</span>
 
+            <span class="c1"># explicitely.</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="SQLiteProperties.row">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.row">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">row</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="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the DB row of property ``name`` or ``default`` if property</span>
 
+<span class="sd">        not exists in DB.&quot;&quot;&quot;</span>
 
+
 
+        <span class="n">cur</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
 
+        <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">&quot;SELECT * FROM properties WHERE name = ?&quot;</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,))</span>
 
+        <span class="n">res</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">default</span>
 
+        <span class="n">col_names</span> <span class="o">=</span> <span class="p">[</span><span class="n">column</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">description</span><span class="p">]</span>
 
+        <span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">col_names</span><span class="p">,</span> <span class="n">res</span><span class="p">))</span></div>
 
+
 
+
 
+<div class="viewcode-block" id="SQLiteProperties.m_time">
 
+<a class="viewcode-back" href="../../src/searx.sqlitedb.html#searx.sqlitedb.SQLiteProperties.m_time">[docs]</a>
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">m_time</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="n">default</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Last modification time of this property.&quot;&quot;&quot;</span>
 
+        <span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">DB</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SQL_M_TIME</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,))</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
 
+        <span class="k">if</span> <span class="n">res</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="n">default</span>
 
+        <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">res</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span></div>
 
+
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">create_schema</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
 
+        <span class="k">with</span> <span class="n">conn</span><span class="p">:</span>
 
+            <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">DDL_PROPERTIES</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

+ 1038 - 0
_modules/searx/utils.html
View File 

@@ -0,0 +1,1038 @@
 
+<!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.utils &#8212; SearXNG Documentation (2025.5.2+590b21165)</title>
 
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
 
+    <script src="../../_static/documentation_options.js?v=8c00f3b4"></script>
 
+    <script src="../../_static/doctools.js?v=9a2dae69"></script>
 
+    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
 
+    <script data-project="searxng" data-version="2025.5.2+590b21165" src="../../_static/describe_version.js?v=fa7f30d0"></script>
 
+    <link rel="index" title="Index" href="../../genindex.html" />
 
+    <link rel="search" title="Search" href="../../search.html" /> 
+  </head><body>
 
+    <div class="related" role="navigation" aria-label="Related">
 
+      <h3>Navigation</h3>
 
+      <ul>
 
+        <li class="right" style="margin-right: 10px">
 
+          <a href="../../genindex.html" title="General Index"
 
+             accesskey="I">index</a></li>
 
+        <li class="right" >
 
+          <a href="../../py-modindex.html" title="Python Module Index"
 
+             >modules</a> |</li>
 
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> &#187;</li>
 
+          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
 
+        <li class="nav-item nav-item-this"><a href="">searx.utils</a></li> 
+      </ul>
 
+    </div>  
+
 
+    <div class="document">
 
+      <div class="documentwrapper">
 
+        <div class="bodywrapper">
 
+          <div class="body" role="main">
 
+            
+  <h1>Source code for searx.utils</h1><div class="highlight"><pre>
 
+<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
 
+<span class="sd">&quot;&quot;&quot;Utility functions for the engines&quot;&quot;&quot;</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</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">importlib</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">importlib.util</span>
 
+<span class="kn">import</span><span class="w"> </span><span class="nn">json</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">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Set</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">MutableMapping</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Callable</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">numbers</span><span class="w"> </span><span class="kn">import</span> <span class="n">Number</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">os.path</span><span class="w"> </span><span class="kn">import</span> <span class="n">splitext</span><span class="p">,</span> <span class="n">join</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">random</span><span class="w"> </span><span class="kn">import</span> <span class="n">choice</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">html.parser</span><span class="w"> </span><span class="kn">import</span> <span class="n">HTMLParser</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">html</span><span class="w"> </span><span class="kn">import</span> <span class="n">escape</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urljoin</span><span class="p">,</span> <span class="n">urlparse</span><span class="p">,</span> <span class="n">parse_qs</span><span class="p">,</span> <span class="n">urlencode</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">timedelta</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">markdown_it</span><span class="w"> </span><span class="kn">import</span> <span class="n">MarkdownIt</span>
 
+
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">lxml.etree</span><span class="w"> </span><span class="kn">import</span> <span class="n">ElementBase</span><span class="p">,</span> <span class="n">XPath</span><span class="p">,</span> <span class="n">XPathError</span><span class="p">,</span> <span class="n">XPathSyntaxError</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">settings</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">USER_AGENTS</span><span class="p">,</span> <span class="n">data_dir</span>
 
+<span class="kn">from</span><span class="w"> </span><span class="nn">searx.version</span><span class="w"> </span><span class="kn">import</span> <span class="n">VERSION_TAG</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">searx.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearxXPathSyntaxException</span><span class="p">,</span> <span class="n">SearxEngineXPathException</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="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="s1">&#39;utils&#39;</span><span class="p">)</span>
 
+
 
+<span class="n">XPathSpecType</span> <span class="o">=</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">XPath</span><span class="p">]</span>
 
+
 
+<span class="n">_BLOCKED_TAGS</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;script&#39;</span><span class="p">,</span> <span class="s1">&#39;style&#39;</span><span class="p">)</span>
 
+
 
+<span class="n">_ECMA_UNESCAPE4_RE</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="s1">&#39;</span><span class="si">%u</span><span class="s1">([0-9a-fA-F]</span><span class="si">{4}</span><span class="s1">)&#39;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">UNICODE</span><span class="p">)</span>
 
+<span class="n">_ECMA_UNESCAPE2_RE</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="s1">&#39;%([0-9a-fA-F]</span><span class="si">{2}</span><span class="s1">)&#39;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">UNICODE</span><span class="p">)</span>
 
+
 
+<span class="n">_JS_QUOTE_KEYS_RE</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="s1">&#39;([\{\s,])(\w+)(:)&#39;</span><span class="p">)</span>
 
+<span class="n">_JS_VOID_RE</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="s1">&#39;void\s+[0-9]+|void\s*\([0-9]+\)&#39;</span><span class="p">)</span>
 
+<span class="n">_JS_DECIMAL_RE</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">&quot;:\s*\.&quot;</span><span class="p">)</span>
 
+
 
+<span class="n">_XPATH_CACHE</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">XPath</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 
+<span class="n">_LANG_TO_LC_CACHE</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">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="p">{}</span>
 
+
 
+<span class="n">_FASTTEXT_MODEL</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="s2">&quot;fasttext.FastText._FastText&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>  <span class="c1"># type: ignore</span>
 
+<span class="sd">&quot;&quot;&quot;fasttext model to predict language of a search term&quot;&quot;&quot;</span>
 
+
 
+<span class="n">SEARCH_LANGUAGE_CODES</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span><span class="n">searxng_locale</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">searxng_locale</span> <span class="ow">in</span> <span class="n">sxng_locales</span><span class="p">])</span>
 
+<span class="sd">&quot;&quot;&quot;Languages supported by most searxng engines (:py:obj:`searx.sxng_locales.sxng_locales`).&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">_NotSetClass</span><span class="p">:</span>  <span class="c1"># pylint: disable=too-few-public-methods</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Internal class for this module, do not create instance of this class.</span>
 
+<span class="sd">    Replace the None value, allow explicitly pass None as a function argument&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="n">_NOTSET</span> <span class="o">=</span> <span class="n">_NotSetClass</span><span class="p">()</span>
 
+
 
+
 
+<div class="viewcode-block" id="searx_useragent">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.searx_useragent">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">searx_useragent</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the searx User Agent&quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="s1">&#39;searx/</span><span class="si">{searx_version}</span><span class="s1"> </span><span class="si">{suffix}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
 
+        <span class="n">searx_version</span><span class="o">=</span><span class="n">VERSION_TAG</span><span class="p">,</span> <span class="n">suffix</span><span class="o">=</span><span class="n">settings</span><span class="p">[</span><span class="s1">&#39;outgoing&#39;</span><span class="p">][</span><span class="s1">&#39;useragent_suffix&#39;</span><span class="p">]</span>
 
+    <span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="gen_useragent">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.gen_useragent">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">gen_useragent</span><span class="p">(</span><span class="n">os_string</span><span class="p">:</span> <span class="n">Optional</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="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return a random browser User Agent</span>
 
+
 
+<span class="sd">    See searx/data/useragents.json</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="n">USER_AGENTS</span><span class="p">[</span><span class="s1">&#39;ua&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">os</span><span class="o">=</span><span class="n">os_string</span> <span class="ow">or</span> <span class="n">choice</span><span class="p">(</span><span class="n">USER_AGENTS</span><span class="p">[</span><span class="s1">&#39;os&#39;</span><span class="p">]),</span> <span class="n">version</span><span class="o">=</span><span class="n">choice</span><span class="p">(</span><span class="n">USER_AGENTS</span><span class="p">[</span><span class="s1">&#39;versions&#39;</span><span class="p">]))</span></div>
 
+
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">_HTMLTextExtractorException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Internal exception raised when the HTML is invalid&quot;&quot;&quot;</span>
 
+
 
+
 
+<span class="k">class</span><span class="w"> </span><span class="nc">_HTMLTextExtractor</span><span class="p">(</span><span class="n">HTMLParser</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Internal class to extract text from HTML&quot;&quot;&quot;</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">HTMLParser</span><span class="o">.</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">result</span> <span class="o">=</span> <span class="p">[]</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">tags</span> <span class="o">=</span> <span class="p">[]</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">handle_starttag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">attrs</span><span class="p">):</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">tag</span> <span class="o">==</span> <span class="s1">&#39;br&#39;</span><span class="p">:</span>
 
+            <span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39; &#39;</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">handle_endtag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tag</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">tags</span><span class="p">:</span>
 
+            <span class="k">return</span>
 
+
 
+        <span class="k">if</span> <span class="n">tag</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tags</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
 
+            <span class="k">raise</span> <span class="n">_HTMLTextExtractorException</span><span class="p">()</span>
 
+
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">is_valid_tag</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">tags</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">tags</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_BLOCKED_TAGS</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">handle_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_valid_tag</span><span class="p">():</span>
 
+            <span class="k">return</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">handle_charref</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="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_valid_tag</span><span class="p">():</span>
 
+            <span class="k">return</span>
 
+        <span class="k">if</span> <span class="n">name</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;x&#39;</span><span class="p">,</span> <span class="s1">&#39;X&#39;</span><span class="p">):</span>
 
+            <span class="n">codepoint</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">name</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span> <span class="mi">16</span><span class="p">)</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">codepoint</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">chr</span><span class="p">(</span><span class="n">codepoint</span><span class="p">))</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">handle_entityref</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="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_valid_tag</span><span class="p">():</span>
 
+            <span class="k">return</span>
 
+        <span class="c1"># codepoint = htmlentitydefs.name2codepoint[name]</span>
 
+        <span class="c1"># self.result.append(chr(codepoint))</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_text</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
 
+        <span class="c1"># error handle is needed in &lt;py3.10</span>
 
+        <span class="c1"># https://github.com/python/cpython/pull/8562/files</span>
 
+        <span class="k">raise</span> <span class="ne">AssertionError</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
 
+
 
+
 
+<div class="viewcode-block" id="html_to_text">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.html_to_text">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">html_to_text</span><span class="p">(</span><span class="n">html_str</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extract text from a HTML string</span>
 
+
 
+<span class="sd">    Args:</span>
 
+<span class="sd">        * html_str (str): string HTML</span>
 
+
 
+<span class="sd">    Returns:</span>
 
+<span class="sd">        * str: extracted text</span>
 
+
 
+<span class="sd">    Examples:</span>
 
+<span class="sd">        &gt;&gt;&gt; html_to_text(&#39;Example &lt;span id=&quot;42&quot;&gt;#2&lt;/span&gt;&#39;)</span>
 
+<span class="sd">        &#39;Example #2&#39;</span>
 
+
 
+<span class="sd">        &gt;&gt;&gt; html_to_text(&#39;&lt;style&gt;.span { color: red; }&lt;/style&gt;&lt;span&gt;Example&lt;/span&gt;&#39;)</span>
 
+<span class="sd">        &#39;Example&#39;</span>
 
+
 
+<span class="sd">        &gt;&gt;&gt; html_to_text(r&#39;regexp: (?&lt;![a-zA-Z]&#39;)</span>
 
+<span class="sd">        &#39;regexp: (?&lt;![a-zA-Z]&#39;</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">html_str</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="s2">&quot;&quot;</span>
 
+    <span class="n">html_str</span> <span class="o">=</span> <span class="n">html_str</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\r</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="p">)</span>
 
+    <span class="n">html_str</span> <span class="o">=</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">html_str</span><span class="o">.</span><span class="n">split</span><span class="p">())</span>
 
+    <span class="n">s</span> <span class="o">=</span> <span class="n">_HTMLTextExtractor</span><span class="p">()</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">s</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">html_str</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="ne">AssertionError</span><span class="p">:</span>
 
+        <span class="n">s</span> <span class="o">=</span> <span class="n">_HTMLTextExtractor</span><span class="p">()</span>
 
+        <span class="n">s</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">escape</span><span class="p">(</span><span class="n">html_str</span><span class="p">,</span> <span class="n">quote</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
 
+    <span class="k">except</span> <span class="n">_HTMLTextExtractorException</span><span class="p">:</span>
 
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;HTMLTextExtractor: invalid HTML</span><span class="se">\n</span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">html_str</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">get_text</span><span class="p">()</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="markdown_to_text">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.markdown_to_text">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">markdown_to_text</span><span class="p">(</span><span class="n">markdown_str</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extract text from a Markdown string</span>
 
+
 
+<span class="sd">    Args:</span>
 
+<span class="sd">        * markdown_str (str): string Markdown</span>
 
+
 
+<span class="sd">    Returns:</span>
 
+<span class="sd">        * str: extracted text</span>
 
+
 
+<span class="sd">    Examples:</span>
 
+<span class="sd">        &gt;&gt;&gt; markdown_to_text(&#39;[example](https://example.com)&#39;)</span>
 
+<span class="sd">        &#39;example&#39;</span>
 
+
 
+<span class="sd">        &gt;&gt;&gt; markdown_to_text(&#39;## Headline&#39;)</span>
 
+<span class="sd">        &#39;Headline&#39;</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="n">html_str</span> <span class="o">=</span> <span class="p">(</span>
 
+        <span class="n">MarkdownIt</span><span class="p">(</span><span class="s2">&quot;commonmark&quot;</span><span class="p">,</span> <span class="p">{</span><span class="s2">&quot;typographer&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">})</span><span class="o">.</span><span class="n">enable</span><span class="p">([</span><span class="s2">&quot;replacements&quot;</span><span class="p">,</span> <span class="s2">&quot;smartquotes&quot;</span><span class="p">])</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">markdown_str</span><span class="p">)</span>
 
+    <span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">html_to_text</span><span class="p">(</span><span class="n">html_str</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="extract_text">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.extract_text">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">extract_text</span><span class="p">(</span><span class="n">xpath_results</span><span class="p">,</span> <span class="n">allow_none</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="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extract text from a lxml result</span>
 
+
 
+<span class="sd">    * if xpath_results is list, extract the text from each result and concat the list</span>
 
+<span class="sd">    * if xpath_results is a xml element, extract all the text node from it</span>
 
+<span class="sd">      ( text_content() method from lxml )</span>
 
+<span class="sd">    * if xpath_results is a string element, then it&#39;s already done</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xpath_results</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 
+        <span class="c1"># it&#39;s list of result : concat everything using recursive call</span>
 
+        <span class="n">result</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
 
+        <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">xpath_results</span><span class="p">:</span>
 
+            <span class="n">result</span> <span class="o">=</span> <span class="n">result</span> <span class="o">+</span> <span class="p">(</span><span class="n">extract_text</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">result</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xpath_results</span><span class="p">,</span> <span class="n">ElementBase</span><span class="p">):</span>
 
+        <span class="c1"># it&#39;s a element</span>
 
+        <span class="n">text</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">tostring</span><span class="p">(</span><span class="n">xpath_results</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;unicode&#39;</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s1">&#39;text&#39;</span><span class="p">,</span> <span class="n">with_tail</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 
+        <span class="n">text</span> <span class="o">=</span> <span class="n">text</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">text</span><span class="o">.</span><span class="n">split</span><span class="p">())</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xpath_results</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Number</span><span class="p">,</span> <span class="nb">bool</span><span class="p">)):</span>
 
+        <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">xpath_results</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">xpath_results</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">allow_none</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+    <span class="k">if</span> <span class="n">xpath_results</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">allow_none</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;extract_text(None, allow_none=False)&#39;</span><span class="p">)</span>
 
+    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;unsupported type&#39;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="normalize_url">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.normalize_url">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">normalize_url</span><span class="p">(</span><span class="n">url</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">base_url</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Normalize URL: add protocol, join URL with base_url, add trailing slash if there is no path</span>
 
+
 
+<span class="sd">    Args:</span>
 
+<span class="sd">        * url (str): Relative URL</span>
 
+<span class="sd">        * base_url (str): Base URL, it must be an absolute URL.</span>
 
+
 
+<span class="sd">    Example:</span>
 
+<span class="sd">        &gt;&gt;&gt; normalize_url(&#39;https://example.com&#39;, &#39;http://example.com/&#39;)</span>
 
+<span class="sd">        &#39;https://example.com/&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; normalize_url(&#39;//example.com&#39;, &#39;http://example.com/&#39;)</span>
 
+<span class="sd">        &#39;http://example.com/&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; normalize_url(&#39;//example.com&#39;, &#39;https://example.com/&#39;)</span>
 
+<span class="sd">        &#39;https://example.com/&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; normalize_url(&#39;/path?a=1&#39;, &#39;https://example.com&#39;)</span>
 
+<span class="sd">        &#39;https://example.com/path?a=1&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; normalize_url(&#39;&#39;, &#39;https://example.com&#39;)</span>
 
+<span class="sd">        &#39;https://example.com/&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; normalize_url(&#39;/test&#39;, &#39;/path&#39;)</span>
 
+<span class="sd">        raise ValueError</span>
 
+
 
+<span class="sd">    Raises:</span>
 
+<span class="sd">        * lxml.etree.ParserError</span>
 
+
 
+<span class="sd">    Returns:</span>
 
+<span class="sd">        * str: normalized URL</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="n">url</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;//&#39;</span><span class="p">):</span>
 
+        <span class="c1"># add http or https to this kind of url //example.com/</span>
 
+        <span class="n">parsed_search_url</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">base_url</span><span class="p">)</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">{0}</span><span class="s1">:</span><span class="si">{1}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">parsed_search_url</span><span class="o">.</span><span class="n">scheme</span> <span class="ow">or</span> <span class="s1">&#39;http&#39;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+    <span class="k">elif</span> <span class="n">url</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">):</span>
 
+        <span class="c1"># fix relative url to the search engine</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">urljoin</span><span class="p">(</span><span class="n">base_url</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="c1"># fix relative urls that fall through the crack</span>
 
+    <span class="k">if</span> <span class="s1">&#39;://&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
 
+        <span class="n">url</span> <span class="o">=</span> <span class="n">urljoin</span><span class="p">(</span><span class="n">base_url</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="n">parsed_url</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+
 
+    <span class="c1"># add a / at this end of the url if there is no path</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Cannot parse url&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
 
+        <span class="n">url</span> <span class="o">+=</span> <span class="s1">&#39;/&#39;</span>
 
+
 
+    <span class="k">return</span> <span class="n">url</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="extract_url">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.extract_url">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">extract_url</span><span class="p">(</span><span class="n">xpath_results</span><span class="p">,</span> <span class="n">base_url</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extract and normalize URL from lxml Element</span>
 
+
 
+<span class="sd">    Args:</span>
 
+<span class="sd">        * xpath_results (Union[List[html.HtmlElement], html.HtmlElement]): lxml Element(s)</span>
 
+<span class="sd">        * base_url (str): Base URL</span>
 
+
 
+<span class="sd">    Example:</span>
 
+<span class="sd">        &gt;&gt;&gt; def f(s, search_url):</span>
 
+<span class="sd">        &gt;&gt;&gt;    return searx.utils.extract_url(html.fromstring(s), search_url)</span>
 
+<span class="sd">        &gt;&gt;&gt; f(&#39;&lt;span id=&quot;42&quot;&gt;https://example.com&lt;/span&gt;&#39;, &#39;http://example.com/&#39;)</span>
 
+<span class="sd">        &#39;https://example.com/&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; f(&#39;https://example.com&#39;, &#39;http://example.com/&#39;)</span>
 
+<span class="sd">        &#39;https://example.com/&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; f(&#39;//example.com&#39;, &#39;http://example.com/&#39;)</span>
 
+<span class="sd">        &#39;http://example.com/&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; f(&#39;//example.com&#39;, &#39;https://example.com/&#39;)</span>
 
+<span class="sd">        &#39;https://example.com/&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; f(&#39;/path?a=1&#39;, &#39;https://example.com&#39;)</span>
 
+<span class="sd">        &#39;https://example.com/path?a=1&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; f(&#39;&#39;, &#39;https://example.com&#39;)</span>
 
+<span class="sd">        raise lxml.etree.ParserError</span>
 
+<span class="sd">        &gt;&gt;&gt; searx.utils.extract_url([], &#39;https://example.com&#39;)</span>
 
+<span class="sd">        raise ValueError</span>
 
+
 
+<span class="sd">    Raises:</span>
 
+<span class="sd">        * ValueError</span>
 
+<span class="sd">        * lxml.etree.ParserError</span>
 
+
 
+<span class="sd">    Returns:</span>
 
+<span class="sd">        * str: normalized URL</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="n">xpath_results</span> <span class="o">==</span> <span class="p">[]:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Empty url resultset&#39;</span><span class="p">)</span>
 
+
 
+    <span class="n">url</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">xpath_results</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">url</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">normalize_url</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">base_url</span><span class="p">)</span>
 
+    <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;URL not found&#39;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="dict_subset">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.dict_subset">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">dict_subset</span><span class="p">(</span><span class="n">dictionary</span><span class="p">:</span> <span class="n">MutableMapping</span><span class="p">,</span> <span class="n">properties</span><span class="p">:</span> <span class="n">Set</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extract a subset of a dict</span>
 
+
 
+<span class="sd">    Examples:</span>
 
+<span class="sd">        &gt;&gt;&gt; dict_subset({&#39;A&#39;: &#39;a&#39;, &#39;B&#39;: &#39;b&#39;, &#39;C&#39;: &#39;c&#39;}, [&#39;A&#39;, &#39;C&#39;])</span>
 
+<span class="sd">        {&#39;A&#39;: &#39;a&#39;, &#39;C&#39;: &#39;c&#39;}</span>
 
+<span class="sd">        &gt;&gt;&gt; &gt;&gt; dict_subset({&#39;A&#39;: &#39;a&#39;, &#39;B&#39;: &#39;b&#39;, &#39;C&#39;: &#39;c&#39;}, [&#39;A&#39;, &#39;D&#39;])</span>
 
+<span class="sd">        {&#39;A&#39;: &#39;a&#39;}</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">return</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">dictionary</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">properties</span> <span class="k">if</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">dictionary</span><span class="p">}</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="humanize_bytes">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.humanize_bytes">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">humanize_bytes</span><span class="p">(</span><span class="n">size</span><span class="p">,</span> <span class="n">precision</span><span class="o">=</span><span class="mi">2</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Determine the *human readable* value of bytes on 1024 base (1KB=1024B).&quot;&quot;&quot;</span>
 
+    <span class="n">s</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;B &#39;</span><span class="p">,</span> <span class="s1">&#39;KB&#39;</span><span class="p">,</span> <span class="s1">&#39;MB&#39;</span><span class="p">,</span> <span class="s1">&#39;GB&#39;</span><span class="p">,</span> <span class="s1">&#39;TB&#39;</span><span class="p">]</span>
 
+
 
+    <span class="n">x</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
 
+    <span class="n">p</span> <span class="o">=</span> <span class="mi">0</span>
 
+    <span class="k">while</span> <span class="n">size</span> <span class="o">&gt;</span> <span class="mi">1024</span> <span class="ow">and</span> <span class="n">p</span> <span class="o">&lt;</span> <span class="n">x</span><span class="p">:</span>
 
+        <span class="n">p</span> <span class="o">+=</span> <span class="mi">1</span>
 
+        <span class="n">size</span> <span class="o">=</span> <span class="n">size</span> <span class="o">/</span> <span class="mf">1024.0</span>
 
+    <span class="k">return</span> <span class="s2">&quot;</span><span class="si">%.*f</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">precision</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">s</span><span class="p">[</span><span class="n">p</span><span class="p">])</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="humanize_number">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.humanize_number">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">humanize_number</span><span class="p">(</span><span class="n">size</span><span class="p">,</span> <span class="n">precision</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Determine the *human readable* value of a decimal number.&quot;&quot;&quot;</span>
 
+    <span class="n">s</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;K&#39;</span><span class="p">,</span> <span class="s1">&#39;M&#39;</span><span class="p">,</span> <span class="s1">&#39;B&#39;</span><span class="p">,</span> <span class="s1">&#39;T&#39;</span><span class="p">]</span>
 
+
 
+    <span class="n">x</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
 
+    <span class="n">p</span> <span class="o">=</span> <span class="mi">0</span>
 
+    <span class="k">while</span> <span class="n">size</span> <span class="o">&gt;</span> <span class="mi">1000</span> <span class="ow">and</span> <span class="n">p</span> <span class="o">&lt;</span> <span class="n">x</span><span class="p">:</span>
 
+        <span class="n">p</span> <span class="o">+=</span> <span class="mi">1</span>
 
+        <span class="n">size</span> <span class="o">=</span> <span class="n">size</span> <span class="o">/</span> <span class="mf">1000.0</span>
 
+    <span class="k">return</span> <span class="s2">&quot;</span><span class="si">%.*f%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">precision</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">s</span><span class="p">[</span><span class="n">p</span><span class="p">])</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="convert_str_to_int">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.convert_str_to_int">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">convert_str_to_int</span><span class="p">(</span><span class="n">number_str</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Convert number_str to int or 0 if number_str is not a number.&quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="n">number_str</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
 
+        <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">number_str</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="mi">0</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="extr">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.extr">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">extr</span><span class="p">(</span><span class="n">txt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">begin</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">end</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extract the string between ``begin`` and ``end`` from ``txt``</span>
 
+
 
+<span class="sd">    :param txt:     String to search in</span>
 
+<span class="sd">    :param begin:   First string to be searched for</span>
 
+<span class="sd">    :param end:     Second string to be searched for after ``begin``</span>
 
+<span class="sd">    :param default: Default value if one of ``begin`` or ``end`` is not</span>
 
+<span class="sd">                    found.  Defaults to an empty string.</span>
 
+<span class="sd">    :return: The string between the two search-strings ``begin`` and ``end``.</span>
 
+<span class="sd">             If at least one of ``begin`` or ``end`` is not found, the value of</span>
 
+<span class="sd">             ``default`` is returned.</span>
 
+
 
+<span class="sd">    Examples:</span>
 
+<span class="sd">      &gt;&gt;&gt; extr(&quot;abcde&quot;, &quot;a&quot;, &quot;e&quot;)</span>
 
+<span class="sd">      &quot;bcd&quot;</span>
 
+<span class="sd">      &gt;&gt;&gt; extr(&quot;abcde&quot;, &quot;a&quot;, &quot;z&quot;, deafult=&quot;nothing&quot;)</span>
 
+<span class="sd">      &quot;nothing&quot;</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+
 
+    <span class="c1"># From https://github.com/mikf/gallery-dl/blob/master/gallery_dl/text.py#L129</span>
 
+
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="n">first</span> <span class="o">=</span> <span class="n">txt</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">begin</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">begin</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">txt</span><span class="p">[</span><span class="n">first</span> <span class="p">:</span> <span class="n">txt</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">end</span><span class="p">,</span> <span class="n">first</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="n">default</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="int_or_zero">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.int_or_zero">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">int_or_zero</span><span class="p">(</span><span class="n">num</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">List</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">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Convert num to int or 0. num can be either a str or a list.</span>
 
+<span class="sd">    If num is a list, the first element is converted to int (or return 0 if the list is empty).</span>
 
+<span class="sd">    If num is a str, see convert_str_to_int</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">num</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">num</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">1</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="mi">0</span>
 
+        <span class="n">num</span> <span class="o">=</span> <span class="n">num</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+    <span class="k">return</span> <span class="n">convert_str_to_int</span><span class="p">(</span><span class="n">num</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="is_valid_lang">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.is_valid_lang">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">is_valid_lang</span><span class="p">(</span><span class="n">lang</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">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="w">    </span><span class="sd">&quot;&quot;&quot;Return language code and name if lang describe a language.</span>
 
+
 
+<span class="sd">    Examples:</span>
 
+<span class="sd">        &gt;&gt;&gt; is_valid_lang(&#39;zz&#39;)</span>
 
+<span class="sd">        None</span>
 
+<span class="sd">        &gt;&gt;&gt; is_valid_lang(&#39;uk&#39;)</span>
 
+<span class="sd">        (True, &#39;uk&#39;, &#39;ukrainian&#39;)</span>
 
+<span class="sd">        &gt;&gt;&gt; is_valid_lang(b&#39;uk&#39;)</span>
 
+<span class="sd">        (True, &#39;uk&#39;, &#39;ukrainian&#39;)</span>
 
+<span class="sd">        &gt;&gt;&gt; is_valid_lang(&#39;en&#39;)</span>
 
+<span class="sd">        (True, &#39;en&#39;, &#39;english&#39;)</span>
 
+<span class="sd">        &gt;&gt;&gt; searx.utils.is_valid_lang(&#39;Español&#39;)</span>
 
+<span class="sd">        (True, &#39;es&#39;, &#39;spanish&#39;)</span>
 
+<span class="sd">        &gt;&gt;&gt; searx.utils.is_valid_lang(&#39;Spanish&#39;)</span>
 
+<span class="sd">        (True, &#39;es&#39;, &#39;spanish&#39;)</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">lang</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
 
+        <span class="n">lang</span> <span class="o">=</span> <span class="n">lang</span><span class="o">.</span><span class="n">decode</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="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="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></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">load_module</span><span class="p">(</span><span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">module_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">types</span><span class="o">.</span><span class="n">ModuleType</span><span class="p">:</span>
 
+    <span class="n">modname</span> <span class="o">=</span> <span class="n">splitext</span><span class="p">(</span><span class="n">filename</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 
+    <span class="n">modpath</span> <span class="o">=</span> <span class="n">join</span><span class="p">(</span><span class="n">module_dir</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
 
+    <span class="c1"># and https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly</span>
 
+    <span class="n">spec</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">spec_from_file_location</span><span class="p">(</span><span class="n">modname</span><span class="p">,</span> <span class="n">modpath</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">spec</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error loading &#39;</span><span class="si">{</span><span class="n">modpath</span><span class="si">}</span><span class="s2">&#39; module&quot;</span><span class="p">)</span>
 
+    <span class="n">module</span> <span class="o">=</span> <span class="n">importlib</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">module_from_spec</span><span class="p">(</span><span class="n">spec</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">spec</span><span class="o">.</span><span class="n">loader</span><span class="p">:</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error loading &#39;</span><span class="si">{</span><span class="n">modpath</span><span class="si">}</span><span class="s2">&#39; module&quot;</span><span class="p">)</span>
 
+    <span class="n">spec</span><span class="o">.</span><span class="n">loader</span><span class="o">.</span><span class="n">exec_module</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">module</span>
 
+
 
+
 
+<div class="viewcode-block" id="to_string">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.to_string">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">to_string</span><span class="p">(</span><span class="n">obj</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Convert obj to its string representation.&quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">obj</span>
 
+    <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s1">&#39;__str__&#39;</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="ecma_unescape">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.ecma_unescape">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">ecma_unescape</span><span class="p">(</span><span class="n">string</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Python implementation of the unescape javascript function</span>
 
+
 
+<span class="sd">    https://www.ecma-international.org/ecma-262/6.0/#sec-unescape-string</span>
 
+<span class="sd">    https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Objets_globaux/unescape</span>
 
+
 
+<span class="sd">    Examples:</span>
 
+<span class="sd">        &gt;&gt;&gt; ecma_unescape(&#39;%u5409&#39;)</span>
 
+<span class="sd">        &#39;吉&#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; ecma_unescape(&#39;%20&#39;)</span>
 
+<span class="sd">        &#39; &#39;</span>
 
+<span class="sd">        &gt;&gt;&gt; ecma_unescape(&#39;%F3&#39;)</span>
 
+<span class="sd">        &#39;ó&#39;</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># &quot;%u5409&quot; becomes &quot;吉&quot;</span>
 
+    <span class="n">string</span> <span class="o">=</span> <span class="n">_ECMA_UNESCAPE4_RE</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="k">lambda</span> <span class="n">e</span><span class="p">:</span> <span class="nb">chr</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="mi">16</span><span class="p">)),</span> <span class="n">string</span><span class="p">)</span>
 
+    <span class="c1"># &quot;%20&quot; becomes &quot; &quot;, &quot;%F3&quot; becomes &quot;ó&quot;</span>
 
+    <span class="n">string</span> <span class="o">=</span> <span class="n">_ECMA_UNESCAPE2_RE</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="k">lambda</span> <span class="n">e</span><span class="p">:</span> <span class="nb">chr</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="mi">16</span><span class="p">)),</span> <span class="n">string</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">string</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="remove_pua_from_str">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.remove_pua_from_str">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">remove_pua_from_str</span><span class="p">(</span><span class="n">string</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Removes unicode&#39;s &quot;PRIVATE USE CHARACTER&quot;s (PUA_) from a string.</span>
 
+
 
+<span class="sd">    .. _PUA: https://en.wikipedia.org/wiki/Private_Use_Areas</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">pua_ranges</span> <span class="o">=</span> <span class="p">((</span><span class="mh">0xE000</span><span class="p">,</span> <span class="mh">0xF8FF</span><span class="p">),</span> <span class="p">(</span><span class="mh">0xF0000</span><span class="p">,</span> <span class="mh">0xFFFFD</span><span class="p">),</span> <span class="p">(</span><span class="mh">0x100000</span><span class="p">,</span> <span class="mh">0x10FFFD</span><span class="p">))</span>
 
+    <span class="n">s</span> <span class="o">=</span> <span class="p">[]</span>
 
+    <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">string</span><span class="p">:</span>
 
+        <span class="n">i</span> <span class="o">=</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">a</span> <span class="o">&lt;=</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="n">b</span> <span class="k">for</span> <span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span> <span class="ow">in</span> <span class="n">pua_ranges</span><span class="p">):</span>
 
+            <span class="k">continue</span>
 
+        <span class="n">s</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="s2">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_string_replaces_function</span><span class="p">(</span><span class="n">replaces</span><span class="p">:</span> <span class="n">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">-&gt;</span> <span class="n">Callable</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="n">rep</span> <span class="o">=</span> <span class="p">{</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">k</span><span class="p">):</span> <span class="n">v</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">replaces</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
 
+    <span class="n">pattern</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="s2">&quot;|&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">rep</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
 
+
 
+    <span class="k">def</span><span class="w"> </span><span class="nf">func</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">pattern</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="k">lambda</span> <span class="n">m</span><span class="p">:</span> <span class="n">rep</span><span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">))],</span> <span class="n">text</span><span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">func</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_engine_from_settings">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.get_engine_from_settings">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_engine_from_settings</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="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return engine configuration from settings.yml of a given engine name&quot;&quot;&quot;</span>
 
+
 
+    <span class="k">if</span> <span class="s1">&#39;engines&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">settings</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="p">{}</span>
 
+
 
+    <span class="k">for</span> <span class="n">engine</span> <span class="ow">in</span> <span class="n">settings</span><span class="p">[</span><span class="s1">&#39;engines&#39;</span><span class="p">]:</span>
 
+        <span class="k">if</span> <span class="s1">&#39;name&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">engine</span><span class="p">:</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="n">engine</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]:</span>
 
+            <span class="k">return</span> <span class="n">engine</span>
 
+
 
+    <span class="k">return</span> <span class="p">{}</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="get_xpath">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.get_xpath">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_xpath</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">:</span> <span class="n">XPathSpecType</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">XPath</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return cached compiled XPath</span>
 
+
 
+<span class="sd">    There is no thread lock.</span>
 
+<span class="sd">    Worst case scenario, xpath_str is compiled more than one time.</span>
 
+
 
+<span class="sd">    Args:</span>
 
+<span class="sd">        * xpath_spec (str|lxml.etree.XPath): XPath as a str or lxml.etree.XPath</span>
 
+
 
+<span class="sd">    Returns:</span>
 
+<span class="sd">        * result (bool, float, list, str): Results.</span>
 
+
 
+<span class="sd">    Raises:</span>
 
+<span class="sd">        * TypeError: Raise when xpath_spec is neither a str nor a lxml.etree.XPath</span>
 
+<span class="sd">        * SearxXPathSyntaxException: Raise when there is a syntax error in the XPath</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+        <span class="n">result</span> <span class="o">=</span> <span class="n">_XPATH_CACHE</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="n">result</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+            <span class="k">try</span><span class="p">:</span>
 
+                <span class="n">result</span> <span class="o">=</span> <span class="n">XPath</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span>
 
+            <span class="k">except</span> <span class="n">XPathSyntaxError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
 
+                <span class="k">raise</span> <span class="n">SearxXPathSyntaxException</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">msg</span><span class="p">))</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span>
 
+            <span class="n">_XPATH_CACHE</span><span class="p">[</span><span class="n">xpath_spec</span><span class="p">]</span> <span class="o">=</span> <span class="n">result</span>
 
+        <span class="k">return</span> <span class="n">result</span>
 
+
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">,</span> <span class="n">XPath</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">xpath_spec</span>
 
+
 
+    <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;xpath_spec must be either a str or a lxml.etree.XPath&#39;</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="eval_xpath">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.eval_xpath">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">eval_xpath</span><span class="p">(</span><span class="n">element</span><span class="p">:</span> <span class="n">ElementBase</span><span class="p">,</span> <span class="n">xpath_spec</span><span class="p">:</span> <span class="n">XPathSpecType</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Equivalent of element.xpath(xpath_str) but compile xpath_str once for all.</span>
 
+<span class="sd">    See https://lxml.de/xpathxslt.html#xpath-return-values</span>
 
+
 
+<span class="sd">    Args:</span>
 
+<span class="sd">        * element (ElementBase): [description]</span>
 
+<span class="sd">        * xpath_spec (str|lxml.etree.XPath): XPath as a str or lxml.etree.XPath</span>
 
+
 
+<span class="sd">    Returns:</span>
 
+<span class="sd">        * result (bool, float, list, str): Results.</span>
 
+
 
+<span class="sd">    Raises:</span>
 
+<span class="sd">        * TypeError: Raise when xpath_spec is neither a str nor a lxml.etree.XPath</span>
 
+<span class="sd">        * SearxXPathSyntaxException: Raise when there is a syntax error in the XPath</span>
 
+<span class="sd">        * SearxEngineXPathException: Raise when the XPath can&#39;t be evaluated.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">xpath</span> <span class="o">=</span> <span class="n">get_xpath</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span>
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="n">xpath</span><span class="p">(</span><span class="n">element</span><span class="p">)</span>
 
+    <span class="k">except</span> <span class="n">XPathError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
 
+        <span class="n">arg</span> <span class="o">=</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">])</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineXPathException</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">,</span> <span class="n">arg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="eval_xpath_list">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.eval_xpath_list">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">eval_xpath_list</span><span class="p">(</span><span class="n">element</span><span class="p">:</span> <span class="n">ElementBase</span><span class="p">,</span> <span class="n">xpath_spec</span><span class="p">:</span> <span class="n">XPathSpecType</span><span class="p">,</span> <span class="n">min_len</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Same as eval_xpath, check if the result is a list</span>
 
+
 
+<span class="sd">    Args:</span>
 
+<span class="sd">        * element (ElementBase): [description]</span>
 
+<span class="sd">        * xpath_spec (str|lxml.etree.XPath): XPath as a str or lxml.etree.XPath</span>
 
+<span class="sd">        * min_len (int, optional): [description]. Defaults to None.</span>
 
+
 
+<span class="sd">    Raises:</span>
 
+<span class="sd">        * TypeError: Raise when xpath_spec is neither a str nor a lxml.etree.XPath</span>
 
+<span class="sd">        * SearxXPathSyntaxException: Raise when there is a syntax error in the XPath</span>
 
+<span class="sd">        * SearxEngineXPathException: raise if the result is not a list</span>
 
+
 
+<span class="sd">    Returns:</span>
 
+<span class="sd">        * result (bool, float, list, str): Results.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">result</span> <span class="o">=</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="n">xpath_spec</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineXPathException</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">,</span> <span class="s1">&#39;the result is not a list&#39;</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="n">min_len</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">min_len</span> <span class="o">&gt;</span> <span class="nb">len</span><span class="p">(</span><span class="n">result</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineXPathException</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">,</span> <span class="s1">&#39;len(xpath_str) &lt; &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">min_len</span><span class="p">))</span>
 
+    <span class="k">return</span> <span class="n">result</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="eval_xpath_getindex">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.eval_xpath_getindex">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">eval_xpath_getindex</span><span class="p">(</span><span class="n">elements</span><span class="p">:</span> <span class="n">ElementBase</span><span class="p">,</span> <span class="n">xpath_spec</span><span class="p">:</span> <span class="n">XPathSpecType</span><span class="p">,</span> <span class="n">index</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">_NOTSET</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Call eval_xpath_list then get one element using the index parameter.</span>
 
+<span class="sd">    If the index does not exist, either raise an exception is default is not set,</span>
 
+<span class="sd">    other return the default value (can be None).</span>
 
+
 
+<span class="sd">    Args:</span>
 
+<span class="sd">        * elements (ElementBase): lxml element to apply the xpath.</span>
 
+<span class="sd">        * xpath_spec (str|lxml.etree.XPath): XPath as a str or lxml.etree.XPath.</span>
 
+<span class="sd">        * index (int): index to get</span>
 
+<span class="sd">        * default (Object, optional): Defaults if index doesn&#39;t exist.</span>
 
+
 
+<span class="sd">    Raises:</span>
 
+<span class="sd">        * TypeError: Raise when xpath_spec is neither a str nor a lxml.etree.XPath</span>
 
+<span class="sd">        * SearxXPathSyntaxException: Raise when there is a syntax error in the XPath</span>
 
+<span class="sd">        * SearxEngineXPathException: if the index is not found. Also see eval_xpath.</span>
 
+
 
+<span class="sd">    Returns:</span>
 
+<span class="sd">        * result (bool, float, list, str): Results.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">result</span> <span class="o">=</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">elements</span><span class="p">,</span> <span class="n">xpath_spec</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="n">index</span> <span class="o">&lt;</span> <span class="nb">len</span><span class="p">(</span><span class="n">result</span><span class="p">):</span>
 
+        <span class="k">return</span> <span class="n">result</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
 
+    <span class="k">if</span> <span class="n">default</span> <span class="o">==</span> <span class="n">_NOTSET</span><span class="p">:</span>
 
+        <span class="c1"># raise an SearxEngineXPathException instead of IndexError</span>
 
+        <span class="c1"># to record xpath_spec</span>
 
+        <span class="k">raise</span> <span class="n">SearxEngineXPathException</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">,</span> <span class="s1">&#39;index &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">index</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39; not found&#39;</span><span class="p">)</span>
 
+    <span class="k">return</span> <span class="n">default</span></div>
 
+
 
+
 
+
 
+<span class="k">def</span><span class="w"> </span><span class="nf">_get_fasttext_model</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="s2">&quot;fasttext.FastText._FastText&quot;</span><span class="p">:</span>  <span class="c1"># type: ignore</span>
 
+    <span class="k">global</span> <span class="n">_FASTTEXT_MODEL</span>  <span class="c1"># pylint: disable=global-statement</span>
 
+    <span class="k">if</span> <span class="n">_FASTTEXT_MODEL</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 
+        <span class="kn">import</span><span class="w"> </span><span class="nn">fasttext</span>  <span class="c1"># pylint: disable=import-outside-toplevel</span>
 
+
 
+        <span class="c1"># Monkey patch: prevent fasttext from showing a (useless) warning when loading a model.</span>
 
+        <span class="n">fasttext</span><span class="o">.</span><span class="n">FastText</span><span class="o">.</span><span class="n">eprint</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="kc">None</span>
 
+        <span class="n">_FASTTEXT_MODEL</span> <span class="o">=</span> <span class="n">fasttext</span><span class="o">.</span><span class="n">load_model</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">data_dir</span> <span class="o">/</span> <span class="s1">&#39;lid.176.ftz&#39;</span><span class="p">))</span>
 
+    <span class="k">return</span> <span class="n">_FASTTEXT_MODEL</span>
 
+
 
+
 
+<div class="viewcode-block" id="get_embeded_stream_url">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.get_embeded_stream_url">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">get_embeded_stream_url</span><span class="p">(</span><span class="n">url</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 
+<span class="sd">    Converts a standard video URL into its embed format. Supported services include Youtube,</span>
 
+<span class="sd">    Facebook, Instagram, TikTok, Dailymotion, and Bilibili.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">parsed_url</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
 
+    <span class="n">iframe_src</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+    <span class="c1"># YouTube</span>
 
+    <span class="k">if</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;www.youtube.com&#39;</span><span class="p">,</span> <span class="s1">&#39;youtube.com&#39;</span><span class="p">]</span> <span class="ow">and</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span> <span class="o">==</span> <span class="s1">&#39;/watch&#39;</span> <span class="ow">and</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">query</span><span class="p">:</span>
 
+        <span class="n">video_id</span> <span class="o">=</span> <span class="n">parse_qs</span><span class="p">(</span><span class="n">parsed_url</span><span class="o">.</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;v&#39;</span><span class="p">,</span> <span class="p">[])</span>
 
+        <span class="k">if</span> <span class="n">video_id</span><span class="p">:</span>
 
+            <span class="n">iframe_src</span> <span class="o">=</span> <span class="s1">&#39;https://www.youtube-nocookie.com/embed/&#39;</span> <span class="o">+</span> <span class="n">video_id</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
+
 
+    <span class="c1"># Facebook</span>
 
+    <span class="k">elif</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;www.facebook.com&#39;</span><span class="p">,</span> <span class="s1">&#39;facebook.com&#39;</span><span class="p">]:</span>
 
+        <span class="n">encoded_href</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;href&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">})</span>
 
+        <span class="n">iframe_src</span> <span class="o">=</span> <span class="s1">&#39;https://www.facebook.com/plugins/video.php?allowfullscreen=true&amp;&#39;</span> <span class="o">+</span> <span class="n">encoded_href</span>
 
+
 
+    <span class="c1"># Instagram</span>
 
+    <span class="k">elif</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;www.instagram.com&#39;</span><span class="p">,</span> <span class="s1">&#39;instagram.com&#39;</span><span class="p">]</span> <span class="ow">and</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/p/&#39;</span><span class="p">):</span>
 
+        <span class="k">if</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">):</span>
 
+            <span class="n">iframe_src</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s1">&#39;embed&#39;</span>
 
+        <span class="k">else</span><span class="p">:</span>
 
+            <span class="n">iframe_src</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s1">&#39;/embed&#39;</span>
 
+
 
+    <span class="c1"># TikTok</span>
 
+    <span class="k">elif</span> <span class="p">(</span>
 
+        <span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;www.tiktok.com&#39;</span><span class="p">,</span> <span class="s1">&#39;tiktok.com&#39;</span><span class="p">]</span>
 
+        <span class="ow">and</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/@&#39;</span><span class="p">)</span>
 
+        <span class="ow">and</span> <span class="s1">&#39;/video/&#39;</span> <span class="ow">in</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span>
 
+    <span class="p">):</span>
 
+        <span class="n">path_parts</span> <span class="o">=</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/video/&#39;</span><span class="p">)</span>
 
+        <span class="n">video_id</span> <span class="o">=</span> <span class="n">path_parts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
 
+        <span class="n">iframe_src</span> <span class="o">=</span> <span class="s1">&#39;https://www.tiktok.com/embed/&#39;</span> <span class="o">+</span> <span class="n">video_id</span>
 
+
 
+    <span class="c1"># Dailymotion</span>
 
+    <span class="k">elif</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;www.dailymotion.com&#39;</span><span class="p">,</span> <span class="s1">&#39;dailymotion.com&#39;</span><span class="p">]</span> <span class="ow">and</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/video/&#39;</span><span class="p">):</span>
 
+        <span class="n">path_parts</span> <span class="o">=</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>
 
+        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">path_parts</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
 
+            <span class="n">video_id</span> <span class="o">=</span> <span class="n">path_parts</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
 
+            <span class="n">iframe_src</span> <span class="o">=</span> <span class="s1">&#39;https://www.dailymotion.com/embed/video/&#39;</span> <span class="o">+</span> <span class="n">video_id</span>
 
+
 
+    <span class="c1"># Bilibili</span>
 
+    <span class="k">elif</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">netloc</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;www.bilibili.com&#39;</span><span class="p">,</span> <span class="s1">&#39;bilibili.com&#39;</span><span class="p">]</span> <span class="ow">and</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;/video/&#39;</span><span class="p">):</span>
 
+        <span class="n">path_parts</span> <span class="o">=</span> <span class="n">parsed_url</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span>
 
+
 
+        <span class="n">video_id</span> <span class="o">=</span> <span class="n">path_parts</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
 
+        <span class="n">param_key</span> <span class="o">=</span> <span class="kc">None</span>
 
+        <span class="k">if</span> <span class="n">video_id</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;av&#39;</span><span class="p">):</span>
 
+            <span class="n">video_id</span> <span class="o">=</span> <span class="n">video_id</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span>
 
+            <span class="n">param_key</span> <span class="o">=</span> <span class="s1">&#39;aid&#39;</span>
 
+        <span class="k">elif</span> <span class="n">video_id</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;BV&#39;</span><span class="p">):</span>
 
+            <span class="n">param_key</span> <span class="o">=</span> <span class="s1">&#39;bvid&#39;</span>
 
+
 
+        <span class="n">iframe_src</span> <span class="o">=</span> <span class="p">(</span>
 
+            <span class="sa">f</span><span class="s1">&#39;https://player.bilibili.com/player.html?</span><span class="si">{</span><span class="n">param_key</span><span class="si">}</span><span class="s1">=</span><span class="si">{</span><span class="n">video_id</span><span class="si">}</span><span class="s1">&amp;high_quality=1&amp;autoplay=false&amp;danmaku=0&#39;</span>
 
+        <span class="p">)</span>
 
+
 
+    <span class="k">return</span> <span class="n">iframe_src</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="detect_language">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.detect_language">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">detect_language</span><span class="p">(</span><span class="n">text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">threshold</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.3</span><span class="p">,</span> <span class="n">only_search_languages</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="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Detect the language of the ``text`` parameter.</span>
 
+
 
+<span class="sd">    :param str text: The string whose language is to be detected.</span>
 
+
 
+<span class="sd">    :param float threshold: Threshold filters the returned labels by a threshold</span>
 
+<span class="sd">        on probability.  A choice of 0.3 will return labels with at least 0.3</span>
 
+<span class="sd">        probability.</span>
 
+
 
+<span class="sd">    :param bool only_search_languages: If ``True``, returns only supported</span>
 
+<span class="sd">        SearXNG search languages.  see :py:obj:`searx.languages`</span>
 
+
 
+<span class="sd">    :rtype: str, None</span>
 
+<span class="sd">    :returns:</span>
 
+<span class="sd">        The detected language code or ``None``. See below.</span>
 
+
 
+<span class="sd">    :raises ValueError: If ``text`` is not a string.</span>
 
+
 
+<span class="sd">    The language detection is done by using `a fork`_ of the fastText_ library</span>
 
+<span class="sd">    (`python fasttext`_). fastText_ distributes the `language identification</span>
 
+<span class="sd">    model`_, for reference:</span>
 
+
 
+<span class="sd">    - `FastText.zip: Compressing text classification models`_</span>
 
+<span class="sd">    - `Bag of Tricks for Efficient Text Classification`_</span>
 
+
 
+<span class="sd">    The `language identification model`_ support the language codes</span>
 
+<span class="sd">    (ISO-639-3)::</span>
 
+
 
+<span class="sd">        af als am an ar arz as ast av az azb ba bar bcl be bg bh bn bo bpy br bs</span>
 
+<span class="sd">        bxr ca cbk ce ceb ckb co cs cv cy da de diq dsb dty dv el eml en eo es</span>
 
+<span class="sd">        et eu fa fi fr frr fy ga gd gl gn gom gu gv he hi hif hr hsb ht hu hy ia</span>
 
+<span class="sd">        id ie ilo io is it ja jbo jv ka kk km kn ko krc ku kv kw ky la lb lez li</span>
 
+<span class="sd">        lmo lo lrc lt lv mai mg mhr min mk ml mn mr mrj ms mt mwl my myv mzn nah</span>
 
+<span class="sd">        nap nds ne new nl nn no oc or os pa pam pfl pl pms pnb ps pt qu rm ro ru</span>
 
+<span class="sd">        rue sa sah sc scn sco sd sh si sk sl so sq sr su sv sw ta te tg th tk tl</span>
 
+<span class="sd">        tr tt tyv ug uk ur uz vec vep vi vls vo wa war wuu xal xmf yi yo yue zh</span>
 
+
 
+<span class="sd">    By using ``only_search_languages=True`` the `language identification model`_</span>
 
+<span class="sd">    is harmonized with the SearXNG&#39;s language (locale) model.  General</span>
 
+<span class="sd">    conditions of SearXNG&#39;s locale model are:</span>
 
+
 
+<span class="sd">    a. SearXNG&#39;s locale of a query is passed to the</span>
 
+<span class="sd">       :py:obj:`searx.locales.get_engine_locale` to get a language and/or region</span>
 
+<span class="sd">       code that is used by an engine.</span>
 
+
 
+<span class="sd">    b. Most of SearXNG&#39;s engines do not support all the languages from `language</span>
 
+<span class="sd">       identification model`_ and there is also a discrepancy in the ISO-639-3</span>
 
+<span class="sd">       (fasttext) and ISO-639-2 (SearXNG)handling.  Further more, in SearXNG the</span>
 
+<span class="sd">       locales like ``zh-TH`` (``zh-CN``) are mapped to ``zh_Hant``</span>
 
+<span class="sd">       (``zh_Hans``) while the `language identification model`_ reduce both to</span>
 
+<span class="sd">       ``zh``.</span>
 
+
 
+<span class="sd">    .. _a fork: https://github.com/searxng/fasttext-predict</span>
 
+<span class="sd">    .. _fastText: https://fasttext.cc/</span>
 
+<span class="sd">    .. _python fasttext: https://pypi.org/project/fasttext/</span>
 
+<span class="sd">    .. _language identification model: https://fasttext.cc/docs/en/language-identification.html</span>
 
+<span class="sd">    .. _Bag of Tricks for Efficient Text Classification: https://arxiv.org/abs/1607.01759</span>
 
+<span class="sd">    .. _`FastText.zip: Compressing text classification models`: https://arxiv.org/abs/1612.03651</span>
 
+
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;text must a str&#39;</span><span class="p">)</span>
 
+    <span class="n">r</span> <span class="o">=</span> <span class="n">_get_fasttext_model</span><span class="p">()</span><span class="o">.</span><span class="n">predict</span><span class="p">(</span><span class="n">text</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="p">),</span> <span class="n">k</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">threshold</span><span class="o">=</span><span class="n">threshold</span><span class="p">)</span>
 
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">r</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">r</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">r</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 
+        <span class="n">language</span> <span class="o">=</span> <span class="n">r</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;__label__&#39;</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
 
+        <span class="k">if</span> <span class="n">only_search_languages</span> <span class="ow">and</span> <span class="n">language</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">SEARCH_LANGUAGE_CODES</span><span class="p">:</span>
 
+            <span class="k">return</span> <span class="kc">None</span>
 
+        <span class="k">return</span> <span class="n">language</span>
 
+    <span class="k">return</span> <span class="kc">None</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="js_variable_to_python">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.js_variable_to_python">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">js_variable_to_python</span><span class="p">(</span><span class="n">js_variable</span><span class="p">):</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Convert a javascript variable into JSON and then load the value</span>
 
+
 
+<span class="sd">    It does not deal with all cases, but it is good enough for now.</span>
 
+<span class="sd">    chompjs has a better implementation.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="c1"># when in_string is not None, it contains the character that has opened the string</span>
 
+    <span class="c1"># either simple quote or double quote</span>
 
+    <span class="n">in_string</span> <span class="o">=</span> <span class="kc">None</span>
 
+    <span class="c1"># cut the string:</span>
 
+    <span class="c1"># r&quot;&quot;&quot;{ a:&quot;f\&quot;irst&quot;, c:&#39;sec&quot;ond&#39;}&quot;&quot;&quot;</span>
 
+    <span class="c1"># becomes</span>
 
+    <span class="c1"># [&#39;{ a:&#39;, &#39;&quot;&#39;, &#39;f\\&#39;, &#39;&quot;&#39;, &#39;irst&#39;, &#39;&quot;&#39;, &#39;, c:&#39;, &quot;&#39;&quot;, &#39;sec&#39;, &#39;&quot;&#39;, &#39;ond&#39;, &quot;&#39;&quot;, &#39;}&#39;]</span>
 
+    <span class="n">parts</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="sa">r</span><span class="s1">&#39;([&quot;</span><span class="se">\&#39;</span><span class="s1">])&#39;</span><span class="p">,</span> <span class="n">js_variable</span><span class="p">)</span>
 
+    <span class="c1"># previous part (to check the escape character antislash)</span>
 
+    <span class="n">previous_p</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 
+    <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">p</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">parts</span><span class="p">):</span>
 
+        <span class="c1"># parse characters inside a ECMA string</span>
 
+        <span class="k">if</span> <span class="n">in_string</span><span class="p">:</span>
 
+            <span class="c1"># we are in a JS string: replace the colon by a temporary character</span>
 
+            <span class="c1"># so quote_keys_regex doesn&#39;t have to deal with colon inside the JS strings</span>
 
+            <span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;:&#39;</span><span class="p">,</span> <span class="nb">chr</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
 
+            <span class="k">if</span> <span class="n">in_string</span> <span class="o">==</span> <span class="s2">&quot;&#39;&quot;</span><span class="p">:</span>
 
+                <span class="c1"># the JS string is delimited by simple quote.</span>
 
+                <span class="c1"># This is not supported by JSON.</span>
 
+                <span class="c1"># simple quote delimited string are converted to double quote delimited string</span>
 
+                <span class="c1"># here, inside a JS string, we escape the double quote</span>
 
+                <span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;&quot;&#39;</span><span class="p">,</span> <span class="sa">r</span><span class="s1">&#39;\&quot;&#39;</span><span class="p">)</span>
 
+
 
+        <span class="c1"># deal with delimiters and escape character</span>
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">in_string</span> <span class="ow">and</span> <span class="n">p</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;&quot;&#39;</span><span class="p">,</span> <span class="s2">&quot;&#39;&quot;</span><span class="p">):</span>
 
+            <span class="c1"># we are not in string</span>
 
+            <span class="c1"># but p is double or simple quote</span>
 
+            <span class="c1"># that&#39;s the start of a new string</span>
 
+            <span class="c1"># replace simple quote by double quote</span>
 
+            <span class="c1"># (JSON doesn&#39;t support simple quote)</span>
 
+            <span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&quot;&#39;</span>
 
+            <span class="n">in_string</span> <span class="o">=</span> <span class="n">p</span>
 
+            <span class="k">continue</span>
 
+        <span class="k">if</span> <span class="n">p</span> <span class="o">==</span> <span class="n">in_string</span><span class="p">:</span>
 
+            <span class="c1"># we are in a string and the current part MAY close the string</span>
 
+            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">previous_p</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">previous_p</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;</span><span class="se">\\</span><span class="s1">&#39;</span><span class="p">:</span>
 
+                <span class="c1"># there is an antislash just before: the ECMA string continue</span>
 
+                <span class="k">continue</span>
 
+            <span class="c1"># the current p close the string</span>
 
+            <span class="c1"># replace simple quote by double quote</span>
 
+            <span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&quot;&#39;</span>
 
+            <span class="n">in_string</span> <span class="o">=</span> <span class="kc">None</span>
 
+
 
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">in_string</span><span class="p">:</span>
 
+            <span class="c1"># replace void 0 by null</span>
 
+            <span class="c1"># https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void</span>
 
+            <span class="c1"># we are sure there is no string in p</span>
 
+            <span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">_JS_VOID_RE</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">&quot;null&quot;</span><span class="p">,</span> <span class="n">p</span><span class="p">)</span>
 
+        <span class="c1"># update previous_p</span>
 
+        <span class="n">previous_p</span> <span class="o">=</span> <span class="n">p</span>
 
+    <span class="c1"># join the string</span>
 
+    <span class="n">s</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts</span><span class="p">)</span>
 
+    <span class="c1"># add quote around the key</span>
 
+    <span class="c1"># { a: 12 }</span>
 
+    <span class="c1"># becomes</span>
 
+    <span class="c1"># { &quot;a&quot;: 12 }</span>
 
+    <span class="n">s</span> <span class="o">=</span> <span class="n">_JS_QUOTE_KEYS_RE</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s1">&#39;\1&quot;\2&quot;\3&#39;</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
 
+    <span class="n">s</span> <span class="o">=</span> <span class="n">_JS_DECIMAL_RE</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">&quot;:0.&quot;</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
 
+    <span class="c1"># replace the surogate character by colon</span>
 
+    <span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="nb">chr</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="s1">&#39;:&#39;</span><span class="p">)</span>
 
+    <span class="c1"># load the JSON and return the result</span>
 
+    <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>
 
+
 
+
 
+
 
+<div class="viewcode-block" id="parse_duration_string">
 
+<a class="viewcode-back" href="../../src/searx.utils.html#searx.utils.parse_duration_string">[docs]</a>
 
+<span class="k">def</span><span class="w"> </span><span class="nf">parse_duration_string</span><span class="p">(</span><span class="n">duration_str</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">timedelta</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Parse a time string in format MM:SS or HH:MM:SS and convert it to a `timedelta` object.</span>
 
+
 
+<span class="sd">    Returns None if the provided string doesn&#39;t match any of the formats.</span>
 
+<span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="n">duration_str</span> <span class="o">=</span> <span class="n">duration_str</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
+
 
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">duration_str</span><span class="p">:</span>
 
+        <span class="k">return</span> <span class="kc">None</span>
 
+
 
+    <span class="k">try</span><span class="p">:</span>
 
+        <span class="c1"># prepending [&quot;00&quot;] here inits hours to 0 if they are not provided</span>
 
+        <span class="n">time_parts</span> <span class="o">=</span> <span class="p">([</span><span class="s2">&quot;00&quot;</span><span class="p">]</span> <span class="o">+</span> <span class="n">duration_str</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;:&quot;</span><span class="p">))[:</span><span class="mi">3</span><span class="p">]</span>
 
+        <span class="n">hours</span><span class="p">,</span> <span class="n">minutes</span><span class="p">,</span> <span class="n">seconds</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">time_parts</span><span class="p">)</span>
 
+        <span class="k">return</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">hours</span><span class="o">=</span><span class="n">hours</span><span class="p">,</span> <span class="n">minutes</span><span class="o">=</span><span class="n">minutes</span><span class="p">,</span> <span class="n">seconds</span><span class="o">=</span><span class="n">seconds</span><span class="p">)</span>
 
+
 
+    <span class="k">except</span> <span class="p">(</span><span class="ne">ValueError</span><span class="p">,</span> <span class="ne">TypeError</span><span class="p">):</span>
 
+        <span class="k">pass</span>
 
+
 
+    <span class="k">return</span> <span class="kc">None</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>
 
+    </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">
 
+    &#169; Copyright SearXNG team.
 
+    </div>
 
+  </body>
 
+</html>

Some files were not shown because too many files changed in this diff

© 2025 NTab仓库
Page: 1780ms Template: 1239ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website