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

enginelib.html 14 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254 
  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.1+1a1628149)</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=cc9fc81d"></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.1+1a1628149" 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.1+1a1628149)</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">.. hint::</span>
    43. 

  43. 

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

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

  46. 

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

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

  49. 

  50. <span class="sd">&quot;&quot;&quot;</span>
    51. 

  51. 

  52. 

  53. <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>
    54. 

  54. <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>
    55. 

  55. 

  56. <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
    57. 

  57.     <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>
    58. 

  58. 

  59. 

  60. <div class="viewcode-block" id="Engine">
    61. 

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

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

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

  64. 

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

  66. 

  67. <span class="sd">    .. hint::</span>
    68. 

  68. 

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

  70. <span class="sd">    &quot;&quot;&quot;</span>
    71. 

  71. 

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

  73. 

  74.     <span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span>
    75. 

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

  76. 

  77.     <span class="n">paging</span><span class="p">:</span> <span class="nb">bool</span>
    78. 

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

  79. 

  80.     <span class="n">time_range_support</span><span class="p">:</span> <span class="nb">bool</span>
    81. 

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

  82. 

  83.     <span class="n">safesearch</span><span class="p">:</span> <span class="nb">bool</span>
    84. 

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

  85. 

  86.     <span class="n">language_support</span><span class="p">:</span> <span class="nb">bool</span>
    87. 

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

  88. 

  89.     <span class="n">language</span><span class="p">:</span> <span class="nb">str</span>
    90. 

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

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

  92. 

  93. <span class="sd">    .. code:: yaml</span>
    94. 

  94. 

  95. <span class="sd">      - name: google french</span>
    96. 

  96. <span class="sd">        engine: google</span>
    97. 

  97. <span class="sd">        language: fr</span>
    98. 

  98. <span class="sd">    &quot;&quot;&quot;</span>
    99. 

  99. 

  100.     <span class="n">region</span><span class="p">:</span> <span class="nb">str</span>
    101. 

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

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

  103. 

  104. <span class="sd">    .. code:: yaml</span>
    105. 

  105. 

  106. <span class="sd">      - name: google belgium</span>
    107. 

  107. <span class="sd">        engine: google</span>
    108. 

  108. <span class="sd">        region: fr-BE</span>
    109. 

  109. <span class="sd">    &quot;&quot;&quot;</span>
    110. 

  110. 

  111.     <span class="n">fetch_traits</span><span class="p">:</span> <span class="n">Callable</span>
    112. 

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

  113. 

  114.     <span class="n">traits</span><span class="p">:</span> <span class="n">traits</span><span class="o">.</span><span class="n">EngineTraits</span>
    115. 

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

  116. 

  117.     <span class="c1"># settings.yml</span>
    118. 

  118. 

  119.     <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>
    120. 

  120. <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>
    121. 

  121. 

  122.     <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
    123. 

  123. <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>
    124. 

  124. <span class="sd">    the result page ..&quot;&quot;&quot;</span>
    125. 

  125. 

  126.     <span class="n">engine</span><span class="p">:</span> <span class="nb">str</span>
    127. 

  127. <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>
    128. 

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

  129. <span class="sd">    ``.py``).&quot;&quot;&quot;</span>
    130. 

  130. 

  131.     <span class="n">enable_http</span><span class="p">:</span> <span class="nb">bool</span>
    132. 

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

  133. 

  134.     <span class="n">shortcut</span><span class="p">:</span> <span class="nb">str</span>
    135. 

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

  136. 

  137.     <span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span>
    138. 

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

  139. 

  140.     <span class="n">display_error_messages</span><span class="p">:</span> <span class="nb">bool</span>
    141. 

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

  142. 

  143.     <span class="n">proxies</span><span class="p">:</span> <span class="nb">dict</span>
    144. 

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

  145. 

  146. <span class="sd">    .. code:: yaml</span>
    147. 

  147. 

  148. <span class="sd">       proxies :</span>
    149. 

  149. <span class="sd">         http:  socks5://proxy:port</span>
    150. 

  150. <span class="sd">         https: socks5://proxy:port</span>
    151. 

  151. <span class="sd">    &quot;&quot;&quot;</span>
    152. 

  152. 

  153.     <span class="n">disabled</span><span class="p">:</span> <span class="nb">bool</span>
    154. 

  154. <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>
    155. 

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

  156. 

  157.     <span class="n">inactive</span><span class="p">:</span> <span class="nb">bool</span>
    158. 

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

  159. 

  160.     <span class="n">about</span><span class="p">:</span> <span class="nb">dict</span>
    161. 

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

  162. 

  163. <span class="sd">    .. code:: yaml</span>
    164. 

  164. 

  165. <span class="sd">       about:</span>
    166. 

  166. <span class="sd">          website: https://example.com</span>
    167. 

  167. <span class="sd">          wikidata_id: Q306656</span>
    168. 

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

  169. <span class="sd">          use_official_api: true</span>
    170. 

  170. <span class="sd">          require_api_key: true</span>
    171. 

  171. <span class="sd">          results: HTML</span>
    172. 

  172. <span class="sd">    &quot;&quot;&quot;</span>
    173. 

  173. 

  174.     <span class="n">using_tor_proxy</span><span class="p">:</span> <span class="nb">bool</span>
    175. 

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

  176. 

  177.     <span class="n">send_accept_language_header</span><span class="p">:</span> <span class="nb">bool</span>
    178. 

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

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

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

  181. 

  182.     <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>
    183. 

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

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

  185. 

  186.     <span class="n">weight</span><span class="p">:</span> <span class="nb">int</span>
    187. 

  187. <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>
    188. 

  188. 

  189. </pre></div>
    190. 

  190. 

  191.             <div class="clearer"></div>
    192. 

  192.           </div>
    193. 

  193.         </div>
    194. 

  194.       </div>
    195. 

  195.   <span id="sidebar-top"></span>
    196. 

  196.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    197. 

  197.         <div class="sphinxsidebarwrapper">
    198. 

  198.   
    199. 

  199.     
    200. 

  200.             <p class="logo"><a href="../../index.html">
    201. 

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

  202.             </a></p>
    203. 

  203.   
    204. 

  204. 

  205. <h3><a href="../../index.html">Table of Contents</a></h3>
    206. 

  206. <ul>
    207. 

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

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

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

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

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

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

  213. </ul>
    214. 

  214. 

  215.   <h3>Project Links</h3>
    216. 

  216.   <ul>
    217. 

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

  218.   
    219. 

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

  220.   
    221. 

  221.     <li><a href="https://searx.space">Public instances</a>
    222. 

  222.   
    223. 

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

  224.   </ul><h3>Navigation</h3>
    225. 

  225. <ul>
    226. 

  226.   <li><a href="../../index.html">Overview</a>
    227. 

  227.     <ul>
    228. 

  228.       <li><a href="../index.html">Module code</a>
    229. 

  229.         
    230. 

  230.           
    231. 

  231.           </ul>
    232. 

  232.       </li>
    233. 

  233.     </ul>
    234. 

  234.   </li>
    235. 

  235. </ul>
    236. 

  236. <search id="searchbox" style="display: none" role="search">
    237. 

  237.   <h3 id="searchlabel">Quick search</h3>
    238. 

  238.     <div class="searchformwrapper">
    239. 

  239.     <form class="search" action="../../search.html" method="get">
    240. 

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

  241.       <input type="submit" value="Go" />
    242. 

  242.     </form>
    243. 

  243.     </div>
    244. 

  244. </search>
    245. 

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

  246.         </div>
    247. 

  247.       </div>
    248. 

  248.       <div class="clearer"></div>
    249. 

  249.     </div>
    250. 

  250.     <div class="footer" role="contentinfo">
    251. 

  251.     &#169; Copyright SearXNG team.
    252. 

  252.     </div>
    253. 

  253.   </body>
    254. 

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