NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Tree: 043602d6dd
Branches Tags
searxng
/
_modules
/
searx
/
enginelib.html

enginelib.html 30 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409 
  1. <!DOCTYPE html>
    2. 

  2. 

  3. <html lang="en" data-content_root="../../">
    4. 

  4.   <head>
    5. 

  5.     <meta charset="utf-8" />
    6. 

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <meta name="viewport" content="width=device-width, initial-scale=1">
    8. 

  8.     <title>searx.enginelib &#8212; SearXNG Documentation (2025.5.5+0315988f5)</title>
    9. 

  9.     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
    11. 

  11.     <script src="../../_static/documentation_options.js?v=6bec52eb"></script>
    12. 

  12.     <script src="../../_static/doctools.js?v=9a2dae69"></script>
    13. 

  13.     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    14. 

  14.     <script data-project="searxng" data-version="2025.5.5+0315988f5" src="../../_static/describe_version.js?v=fa7f30d0"></script>
    15. 

  15.     <link rel="index" title="Index" href="../../genindex.html" />
    16. 

  16.     <link rel="search" title="Search" href="../../search.html" /> 
    17. 

  17.   </head><body>
    18. 

  18.     <div class="related" role="navigation" aria-label="Related">
    19. 

  19.       <h3>Navigation</h3>
    20. 

  20.       <ul>
    21. 

  21.         <li class="right" style="margin-right: 10px">
    22. 

  22.           <a href="../../genindex.html" title="General Index"
    23. 

  23.              accesskey="I">index</a></li>
    24. 

  24.         <li class="right" >
    25. 

  25.           <a href="../../py-modindex.html" title="Python Module Index"
    26. 

  26.              >modules</a> |</li>
    27. 

  27.         <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.5.5+0315988f5)</a> &#187;</li>
    28. 

  28.           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
    29. 

  29.         <li class="nav-item nav-item-this"><a href="">searx.enginelib</a></li> 
    30. 

  30.       </ul>
    31. 

  31.     </div>  
    32. 

  32. 

  33.     <div class="document">
    34. 

  34.       <div class="documentwrapper">
    35. 

  35.         <div class="bodywrapper">
    36. 

  36.           <div class="body" role="main">
    37. 

  37.             
    38. 

  38.   <h1>Source code for searx.enginelib</h1><div class="highlight"><pre>
    39. 

  39. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
    40. 

  40. <span class="sd">&quot;&quot;&quot;Implementations of the framework for the SearXNG engines.</span>
    41. 

  41. 

  42. <span class="sd">- :py:obj:`searx.enginelib.EngineCache`</span>
    43. 

  43. <span class="sd">- :py:obj:`searx.enginelib.Engine`</span>
    44. 

  44. <span class="sd">- :py:obj:`searx.enginelib.traits`</span>
    45. 

  45. 

  46. <span class="sd">There is a command line for developer purposes and for deeper analysis.  Here is</span>
    47. 

  47. <span class="sd">an example in which the command line is called in the development environment::</span>
    48. 

  48. 

  49. <span class="sd">  $ ./manage pyenv.cmd bash --norc --noprofile</span>
    50. 

  50. <span class="sd">  (py3) python -m searx.enginelib --help</span>
    51. 

  51. 

  52. <span class="sd">.. hint::</span>
    53. 

  53. 

  54. <span class="sd">   The long term goal is to modularize all implementations of the engine</span>
    55. 

  55. <span class="sd">   framework here in this Python package.  ToDo:</span>
    56. 

  56. 

  57. <span class="sd">   - move implementations of the :ref:`searx.engines loader` to a new module in</span>
    58. 

  58. <span class="sd">     the :py:obj:`searx.enginelib` namespace.</span>
    59. 

  59. 

  60. <span class="sd">-----</span>
    61. 

  61. 

  62. <span class="sd">&quot;&quot;&quot;</span>
    63. 

  63. <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>
    64. 

  64. 

  65. <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;EngineCache&quot;</span><span class="p">,</span> <span class="s2">&quot;Engine&quot;</span><span class="p">,</span> <span class="s2">&quot;ENGINES_CACHE&quot;</span><span class="p">]</span>
    66. 

  66. 

  67. <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="p">,</span> <span class="n">Any</span>
    68. 

  68. <span class="kn">import</span><span class="w"> </span><span class="nn">string</span>
    69. 

  69. <span class="kn">import</span><span class="w"> </span><span class="nn">typer</span>
    70. 

  70. 

  71. <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">ExpireCache</span><span class="p">,</span> <span class="n">ExpireCacheCfg</span>
    72. 

  72. 

  73. <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
    74. 

  74.     <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>
    75. 

  75. 

  76. 

  77. <span class="n">ENGINES_CACHE</span> <span class="o">=</span> <span class="n">ExpireCache</span><span class="o">.</span><span class="n">build_cache</span><span class="p">(</span>
    78. 

  78.     <span class="n">ExpireCacheCfg</span><span class="p">(</span>
    79. 

  79.         <span class="n">name</span><span class="o">=</span><span class="s2">&quot;ENGINES_CACHE&quot;</span><span class="p">,</span>
    80. 

  80.         <span class="n">MAXHOLD_TIME</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="p">,</span>  <span class="c1"># 7 days</span>
    81. 

  81.         <span class="n">MAINTENANCE_PERIOD</span><span class="o">=</span><span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span><span class="p">,</span>  <span class="c1"># 2h</span>
    82. 

  82.     <span class="p">)</span>
    83. 

  83. <span class="p">)</span>
    84. 

  84. <span class="sd">&quot;&quot;&quot;Global :py:obj:`searx.cache.ExpireCacheSQLite` instance where the cached</span>
    85. 

  85. <span class="sd">values from all engines are stored.  The `MAXHOLD_TIME` is 7 days and the</span>
    86. 

  86. <span class="sd">`MAINTENANCE_PERIOD` is set to two hours.&quot;&quot;&quot;</span>
    87. 

  87. 

  88. <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>
    89. 

  89. 

  90. 

  91. <span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
    92. 

  92. <span class="k">def</span><span class="w"> </span><span class="nf">state</span><span class="p">():</span>
    93. 

  93. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Show state for the caches of the engines.&quot;&quot;&quot;</span>
    94. 

  94. 

  95.     <span class="n">title</span> <span class="o">=</span> <span class="s2">&quot;cache tables and key/values&quot;</span>
    96. 

  96.     <span class="nb">print</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
    97. 

  97.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">title</span><span class="p">))</span>
    98. 

  98.     <span class="nb">print</span><span class="p">(</span><span class="n">ENGINES_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>
    99. 

  99.     <span class="nb">print</span><span class="p">()</span>
    100. 

  100.     <span class="n">title</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;properties of </span><span class="si">{</span><span class="n">ENGINES_CACHE</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span>
    101. 

  101.     <span class="nb">print</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
    102. 

  102.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">title</span><span class="p">))</span>
    103. 

  103.     <span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">ENGINES_CACHE</span><span class="o">.</span><span class="n">properties</span><span class="p">))</span>  <span class="c1"># type: ignore</span>
    104. 

  104. 

  105. 

  106. <span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
    107. 

  107. <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>
    108. 

  108. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Carry out maintenance on cache of the engines.&quot;&quot;&quot;</span>
    109. 

  109.     <span class="n">ENGINES_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>
    110. 

  110. 

  111. 

  112. <div class="viewcode-block" id="EngineCache">
    113. 

  113. <a class="viewcode-back" href="../../dev/engines/enginelib.html#searx.enginelib.EngineCache">[docs]</a>
    114. 

  114. <span class="k">class</span><span class="w"> </span><span class="nc">EngineCache</span><span class="p">:</span>
    115. 

  115. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Persistent (SQLite) key/value cache that deletes its values again after</span>
    116. 

  116. <span class="sd">    ``expire`` seconds (default/max: :py:obj:`MAXHOLD_TIME</span>
    117. 

  117. <span class="sd">    &lt;searx.cache.ExpireCacheCfg.MAXHOLD_TIME&gt;`).  This class is a wrapper around</span>
    118. 

  118. <span class="sd">    :py:obj:`ENGINES_CACHE` (:py:obj:`ExpireCacheSQLite</span>
    119. 

  119. <span class="sd">    &lt;searx.cache.ExpireCacheSQLite&gt;`).</span>
    120. 

  120. 

  121. <span class="sd">    In the :origin:`searx/engines/demo_offline.py` engine you can find an</span>
    122. 

  122. <span class="sd">    exemplary implementation of such a cache other exaples are implemeted</span>
    123. 

  123. <span class="sd">    in:</span>
    124. 

  124. 

  125. <span class="sd">    - :origin:`searx/engines/radio_browser.py`</span>
    126. 

  126. <span class="sd">    - :origin:`searx/engines/soundcloud.py`</span>
    127. 

  127. <span class="sd">    - :origin:`searx/engines/startpage.py`</span>
    128. 

  128. 

  129. <span class="sd">    .. code: python</span>
    130. 

  130. 

  131. <span class="sd">       from searx.enginelib import EngineCache</span>
    132. 

  132. <span class="sd">       CACHE: EngineCache</span>
    133. 

  133. 

  134. <span class="sd">       def init(engine_settings):</span>
    135. 

  135. <span class="sd">           global CACHE</span>
    136. 

  136. <span class="sd">           CACHE = EngineCache(engine_settings[&quot;name&quot;])</span>
    137. 

  137. 

  138. <span class="sd">       def request(query, params):</span>
    139. 

  139. <span class="sd">           token = CACHE.get(key=&quot;token&quot;)</span>
    140. 

  140. <span class="sd">           if token is None:</span>
    141. 

  141. <span class="sd">               token = get_token()</span>
    142. 

  142. <span class="sd">               # cache token of this engine for 1h</span>
    143. 

  143. <span class="sd">               CACHE.set(key=&quot;token&quot;, value=token, expire=3600)</span>
    144. 

  144. <span class="sd">           ...</span>
    145. 

  145. 

  146. <span class="sd">    For introspection of the DB, jump into developer environment and run command to</span>
    147. 

  147. <span class="sd">    show cache state::</span>
    148. 

  148. 

  149. <span class="sd">        $ ./manage pyenv.cmd bash --norc --noprofile</span>
    150. 

  150. <span class="sd">        (py3) python -m searx.enginelib cache state</span>
    151. 

  151. 

  152. <span class="sd">        cache tables and key/values</span>
    153. 

  153. <span class="sd">        ===========================</span>
    154. 

  154. <span class="sd">        [demo_offline        ] 2025-04-22 11:32:50 count        --&gt; (int) 4</span>
    155. 

  155. <span class="sd">        [startpage           ] 2025-04-22 12:32:30 SC_CODE      --&gt; (str) fSOBnhEMlDfE20</span>
    156. 

  156. <span class="sd">        [duckduckgo          ] 2025-04-22 12:32:31 4dff493e.... --&gt; (str) 4-128634958369380006627592672385352473325</span>
    157. 

  157. <span class="sd">        [duckduckgo          ] 2025-04-22 12:40:06 3e2583e2.... --&gt; (str) 4-263126175288871260472289814259666848451</span>
    158. 

  158. <span class="sd">        [radio_browser       ] 2025-04-23 11:33:08 servers      --&gt; (list) [&#39;https://de2.api.radio-browser.info&#39;,  ...]</span>
    159. 

  159. <span class="sd">        [soundcloud          ] 2025-04-29 11:40:06 guest_client_id --&gt; (str) EjkRJG0BLNEZquRiPZYdNtJdyGtTuHdp</span>
    160. 

  160. <span class="sd">        [wolframalpha        ] 2025-04-22 12:40:06 code         --&gt; (str) 5aa79f86205ad26188e0e26e28fb7ae7</span>
    161. 

  161. <span class="sd">        number of tables: 6</span>
    162. 

  162. <span class="sd">        number of key/value pairs: 7</span>
    163. 

  163. 

  164. <span class="sd">    In the &quot;cache tables and key/values&quot; section, the table name (engine name) is at</span>
    165. 

  165. <span class="sd">    first position on the second there is the calculated expire date and on the</span>
    166. 

  166. <span class="sd">    third and fourth position the key/value is shown.</span>
    167. 

  167. 

  168. <span class="sd">    About duckduckgo: The *vqd coode* of ddg depends on the query term and therefore</span>
    169. 

  169. <span class="sd">    the key is a hash value of the query term (to not to store the raw query term).</span>
    170. 

  170. 

  171. <span class="sd">    In the &quot;properties of ENGINES_CACHE&quot; section all properties of the SQLiteAppl /</span>
    172. 

  172. <span class="sd">    ExpireCache and their last modification date are shown::</span>
    173. 

  173. 

  174. <span class="sd">        properties of ENGINES_CACHE</span>
    175. 

  175. <span class="sd">        ===========================</span>
    176. 

  176. <span class="sd">        [last modified: 2025-04-22 11:32:27] DB_SCHEMA           : 1</span>
    177. 

  177. <span class="sd">        [last modified: 2025-04-22 11:32:27] LAST_MAINTENANCE    :</span>
    178. 

  178. <span class="sd">        [last modified: 2025-04-22 11:32:27] crypt_hash          : ca612e3566fdfd7cf7efe...</span>
    179. 

  179. <span class="sd">        [last modified: 2025-04-22 11:32:30] CACHE-TABLE--demo_offline: demo_offline</span>
    180. 

  180. <span class="sd">        [last modified: 2025-04-22 11:32:30] CACHE-TABLE--startpage: startpage</span>
    181. 

  181. <span class="sd">        [last modified: 2025-04-22 11:32:31] CACHE-TABLE--duckduckgo: duckduckgo</span>
    182. 

  182. <span class="sd">        [last modified: 2025-04-22 11:33:08] CACHE-TABLE--radio_browser: radio_browser</span>
    183. 

  183. <span class="sd">        [last modified: 2025-04-22 11:40:06] CACHE-TABLE--soundcloud: soundcloud</span>
    184. 

  184. <span class="sd">        [last modified: 2025-04-22 11:40:06] CACHE-TABLE--wolframalpha: wolframalpha</span>
    185. 

  185. 

  186. <span class="sd">    These properties provide information about the state of the ExpireCache and</span>
    187. 

  187. <span class="sd">    control the behavior.  For example, the maintenance intervals are controlled by</span>
    188. 

  188. <span class="sd">    the last modification date of the LAST_MAINTENANCE property and the hash value</span>
    189. 

  189. <span class="sd">    of the password can be used to detect whether the password has been changed (in</span>
    190. 

  190. <span class="sd">    this case the DB entries can no longer be decrypted and the entire cache must be</span>
    191. 

  191. <span class="sd">    discarded).</span>
    192. 

  192. <span class="sd">    &quot;&quot;&quot;</span>
    193. 

  193. 

  194.     <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_name</span><span class="p">:</span> <span class="nb">str</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="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
    195. 

  195.         <span class="bp">self</span><span class="o">.</span><span class="n">expire</span> <span class="o">=</span> <span class="n">expire</span> <span class="ow">or</span> <span class="n">ENGINES_CACHE</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">MAXHOLD_TIME</span>
    196. 

  196.         <span class="n">_valid</span> <span class="o">=</span> <span class="s2">&quot;-_.&quot;</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>
    197. 

  197.         <span class="bp">self</span><span class="o">.</span><span class="n">table_name</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">c</span> <span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">_valid</span> <span class="k">else</span> <span class="s2">&quot;_&quot;</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">engine_name</span><span class="p">])</span>
    198. 

  198. 

  199.     <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">key</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="n">Any</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="kc">None</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>
    200. 

  200.         <span class="k">return</span> <span class="n">ENGINES_CACHE</span><span class="o">.</span><span class="n">set</span><span class="p">(</span>
    201. 

  201.             <span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span>
    202. 

  202.             <span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">,</span>
    203. 

  203.             <span class="n">expire</span><span class="o">=</span><span class="n">expire</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">expire</span><span class="p">,</span>
    204. 

  204.             <span class="n">ctx</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">table_name</span><span class="p">,</span>
    205. 

  205.         <span class="p">)</span>
    206. 

  206. 

  207.     <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">key</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="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
    208. 

  208.         <span class="k">return</span> <span class="n">ENGINES_CACHE</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="n">default</span><span class="o">=</span><span class="n">default</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">table_name</span><span class="p">)</span>
    209. 

  209. 

  210.     <span class="k">def</span><span class="w"> </span><span class="nf">secret_hash</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="o">|</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
    211. 

  211.         <span class="k">return</span> <span class="n">ENGINES_CACHE</span><span class="o">.</span><span class="n">secret_hash</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span></div>
    212. 

  212. 

  213. 

  214. 

  215. <div class="viewcode-block" id="Engine">
    216. 

  216. <a class="viewcode-back" href="../../dev/engines/enginelib.html#searx.enginelib.Engine">[docs]</a>
    217. 

  217. <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>
    218. 

  218. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Class of engine instances build from YAML settings.</span>
    219. 

  219. 

  220. <span class="sd">    Further documentation see :ref:`general engine configuration`.</span>
    221. 

  221. 

  222. <span class="sd">    .. hint::</span>
    223. 

  223. 

  224. <span class="sd">       This class is currently never initialized and only used for type hinting.</span>
    225. 

  225. <span class="sd">    &quot;&quot;&quot;</span>
    226. 

  226. 

  227.     <span class="c1"># Common options in the engine module</span>
    228. 

  228. 

  229.     <span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span>
    230. 

  230. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Type of the engine (:ref:`searx.search.processors`)&quot;&quot;&quot;</span>
    231. 

  231. 

  232.     <span class="n">paging</span><span class="p">:</span> <span class="nb">bool</span>
    233. 

  233. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Engine supports multiple pages.&quot;&quot;&quot;</span>
    234. 

  234. 

  235.     <span class="n">time_range_support</span><span class="p">:</span> <span class="nb">bool</span>
    236. 

  236. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Engine supports search time range.&quot;&quot;&quot;</span>
    237. 

  237. 

  238.     <span class="n">safesearch</span><span class="p">:</span> <span class="nb">bool</span>
    239. 

  239. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Engine supports SafeSearch&quot;&quot;&quot;</span>
    240. 

  240. 

  241.     <span class="n">language_support</span><span class="p">:</span> <span class="nb">bool</span>
    242. 

  242. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Engine supports languages (locales) search.&quot;&quot;&quot;</span>
    243. 

  243. 

  244.     <span class="n">language</span><span class="p">:</span> <span class="nb">str</span>
    245. 

  245. <span class="w">    </span><span class="sd">&quot;&quot;&quot;For an engine, when there is ``language: ...`` in the YAML settings the engine</span>
    246. 

  246. <span class="sd">    does support only this one language:</span>
    247. 

  247. 

  248. <span class="sd">    .. code:: yaml</span>
    249. 

  249. 

  250. <span class="sd">      - name: google french</span>
    251. 

  251. <span class="sd">        engine: google</span>
    252. 

  252. <span class="sd">        language: fr</span>
    253. 

  253. <span class="sd">    &quot;&quot;&quot;</span>
    254. 

  254. 

  255.     <span class="n">region</span><span class="p">:</span> <span class="nb">str</span>
    256. 

  256. <span class="w">    </span><span class="sd">&quot;&quot;&quot;For an engine, when there is ``region: ...`` in the YAML settings the engine</span>
    257. 

  257. <span class="sd">    does support only this one region::</span>
    258. 

  258. 

  259. <span class="sd">    .. code:: yaml</span>
    260. 

  260. 

  261. <span class="sd">      - name: google belgium</span>
    262. 

  262. <span class="sd">        engine: google</span>
    263. 

  263. <span class="sd">        region: fr-BE</span>
    264. 

  264. <span class="sd">    &quot;&quot;&quot;</span>
    265. 

  265. 

  266.     <span class="n">fetch_traits</span><span class="p">:</span> <span class="n">Callable</span>
    267. 

  267. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Function to to fetch engine&#39;s traits from origin.&quot;&quot;&quot;</span>
    268. 

  268. 

  269.     <span class="n">traits</span><span class="p">:</span> <span class="n">traits</span><span class="o">.</span><span class="n">EngineTraits</span>
    270. 

  270. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Traits of the engine.&quot;&quot;&quot;</span>
    271. 

  271. 

  272.     <span class="c1"># settings.yml</span>
    273. 

  273. 

  274.     <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>
    275. 

  275. <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>
    276. 

  276. 

  277.     <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
    278. 

  278. <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>
    279. 

  279. <span class="sd">    the result page ..&quot;&quot;&quot;</span>
    280. 

  280. 

  281.     <span class="n">engine</span><span class="p">:</span> <span class="nb">str</span>
    282. 

  282. <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>
    283. 

  283. <span class="sd">    this search engine (file name from :origin:`searx/engines` without</span>
    284. 

  284. <span class="sd">    ``.py``).&quot;&quot;&quot;</span>
    285. 

  285. 

  286.     <span class="n">enable_http</span><span class="p">:</span> <span class="nb">bool</span>
    287. 

  287. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Enable HTTP (by default only HTTPS is enabled).&quot;&quot;&quot;</span>
    288. 

  288. 

  289.     <span class="n">shortcut</span><span class="p">:</span> <span class="nb">str</span>
    290. 

  290. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Code used to execute bang requests (``!foo``)&quot;&quot;&quot;</span>
    291. 

  291. 

  292.     <span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span>
    293. 

  293. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Specific timeout for search-engine.&quot;&quot;&quot;</span>
    294. 

  294. 

  295.     <span class="n">display_error_messages</span><span class="p">:</span> <span class="nb">bool</span>
    296. 

  296. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Display error messages on the web UI.&quot;&quot;&quot;</span>
    297. 

  297. 

  298.     <span class="n">proxies</span><span class="p">:</span> <span class="nb">dict</span>
    299. 

  299. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Set proxies for a specific engine (YAML):</span>
    300. 

  300. 

  301. <span class="sd">    .. code:: yaml</span>
    302. 

  302. 

  303. <span class="sd">       proxies :</span>
    304. 

  304. <span class="sd">         http:  socks5://proxy:port</span>
    305. 

  305. <span class="sd">         https: socks5://proxy:port</span>
    306. 

  306. <span class="sd">    &quot;&quot;&quot;</span>
    307. 

  307. 

  308.     <span class="n">disabled</span><span class="p">:</span> <span class="nb">bool</span>
    309. 

  309. <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>
    310. 

  310. <span class="sd">    user to manually activate it in the settings.&quot;&quot;&quot;</span>
    311. 

  311. 

  312.     <span class="n">inactive</span><span class="p">:</span> <span class="nb">bool</span>
    313. 

  313. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Remove the engine from the settings (*disabled &amp; removed*).&quot;&quot;&quot;</span>
    314. 

  314. 

  315.     <span class="n">about</span><span class="p">:</span> <span class="nb">dict</span>
    316. 

  316. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Additional fields describing the engine.</span>
    317. 

  317. 

  318. <span class="sd">    .. code:: yaml</span>
    319. 

  319. 

  320. <span class="sd">       about:</span>
    321. 

  321. <span class="sd">          website: https://example.com</span>
    322. 

  322. <span class="sd">          wikidata_id: Q306656</span>
    323. 

  323. <span class="sd">          official_api_documentation: https://example.com/api-doc</span>
    324. 

  324. <span class="sd">          use_official_api: true</span>
    325. 

  325. <span class="sd">          require_api_key: true</span>
    326. 

  326. <span class="sd">          results: HTML</span>
    327. 

  327. <span class="sd">    &quot;&quot;&quot;</span>
    328. 

  328. 

  329.     <span class="n">using_tor_proxy</span><span class="p">:</span> <span class="nb">bool</span>
    330. 

  330. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Using tor proxy (``true``) or not (``false``) for this engine.&quot;&quot;&quot;</span>
    331. 

  331. 

  332.     <span class="n">send_accept_language_header</span><span class="p">:</span> <span class="nb">bool</span>
    333. 

  333. <span class="w">    </span><span class="sd">&quot;&quot;&quot;When this option is activated, the language (locale) that is selected by</span>
    334. 

  334. <span class="sd">    the user is used to build and send a ``Accept-Language`` header in the</span>
    335. 

  335. <span class="sd">    request to the origin search engine.&quot;&quot;&quot;</span>
    336. 

  336. 

  337.     <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>
    338. 

  338. <span class="w">    </span><span class="sd">&quot;&quot;&quot;A list of secret tokens to make this engine *private*, more details see</span>
    339. 

  339. <span class="sd">    :ref:`private engines`.&quot;&quot;&quot;</span>
    340. 

  340. 

  341.     <span class="n">weight</span><span class="p">:</span> <span class="nb">int</span>
    342. 

  342. <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>
    343. 

  343. 

  344. </pre></div>
    345. 

  345. 

  346.             <div class="clearer"></div>
    347. 

  347.           </div>
    348. 

  348.         </div>
    349. 

  349.       </div>
    350. 

  350.   <span id="sidebar-top"></span>
    351. 

  351.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    352. 

  352.         <div class="sphinxsidebarwrapper">
    353. 

  353.   
    354. 

  354.     
    355. 

  355.             <p class="logo"><a href="../../index.html">
    356. 

  356.               <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
    357. 

  357.             </a></p>
    358. 

  358.   
    359. 

  359. 

  360. <h3><a href="../../index.html">Table of Contents</a></h3>
    361. 

  361. <ul>
    362. 

  362. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
    363. 

  363. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
    364. 

  364. <li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
    365. 

  365. <li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
    366. 

  366. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
    367. 

  367. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
    368. 

  368. </ul>
    369. 

  369. 

  370.   <h3>Project Links</h3>
    371. 

  371.   <ul>
    372. 

  372.     <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
    373. 

  373.   
    374. 

  374.     <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
    375. 

  375.   
    376. 

  376.     <li><a href="https://searx.space">Public instances</a>
    377. 

  377.   
    378. 

  378.     <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
    379. 

  379.   </ul><h3>Navigation</h3>
    380. 

  380. <ul>
    381. 

  381.   <li><a href="../../index.html">Overview</a>
    382. 

  382.     <ul>
    383. 

  383.       <li><a href="../index.html">Module code</a>
    384. 

  384.         
    385. 

  385.           
    386. 

  386.           </ul>
    387. 

  387.       </li>
    388. 

  388.     </ul>
    389. 

  389.   </li>
    390. 

  390. </ul>
    391. 

  391. <search id="searchbox" style="display: none" role="search">
    392. 

  392.   <h3 id="searchlabel">Quick search</h3>
    393. 

  393.     <div class="searchformwrapper">
    394. 

  394.     <form class="search" action="../../search.html" method="get">
    395. 

  395.       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    396. 

  396.       <input type="submit" value="Go" />
    397. 

  397.     </form>
    398. 

  398.     </div>
    399. 

  399. </search>
    400. 

  400. <script>document.getElementById('searchbox').style.display = "block"</script>
    401. 

  401.         </div>
    402. 

  402.       </div>
    403. 

  403.       <div class="clearer"></div>
    404. 

  404.     </div>
    405. 

  405.     <div class="footer" role="contentinfo">
    406. 

  406.     &#169; Copyright SearXNG team.
    407. 

  407.     </div>
    408. 

  408.   </body>
    409. 

  409. </html>
    410.
© 2025 NTab仓库
Page: 42ms Template: 1ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website