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

traits.html 41 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411 
  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.traits &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</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=b12b0e12"></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.4.30+fd33559cf" 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.4.30+fd33559cf)</a> &#187;</li>
    28. 

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

  29.           <li class="nav-item nav-item-2"><a href="../enginelib.html" accesskey="U">searx.enginelib</a> &#187;</li>
    30. 

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

  31.       </ul>
    32. 

  32.     </div>  
    33. 

  33. 

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

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

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

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

  38.             
    39. 

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

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

  41. <span class="sd">&quot;&quot;&quot;Engine&#39;s traits are fetched from the origin engines and stored in a JSON file</span>
    42. 

  42. <span class="sd">in the *data folder*.  Most often traits are languages and region codes and</span>
    43. 

  43. <span class="sd">their mapping from SearXNG&#39;s representation to the representation in the origin</span>
    44. 

  44. <span class="sd">search engine.  For new traits new properties can be added to the class</span>
    45. 

  45. <span class="sd">:py:class:`EngineTraits`.</span>
    46. 

  46. 

  47. <span class="sd">To load traits from the persistence :py:obj:`EngineTraitsMap.from_data` can be</span>
    48. 

  48. <span class="sd">used.</span>
    49. 

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

  50. 

  51. <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>
    52. 

  52. 

  53. <span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
    54. 

  54. <span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
    55. 

  55. <span class="kn">import</span><span class="w"> </span><span class="nn">dataclasses</span>
    56. 

  56. <span class="kn">import</span><span class="w"> </span><span class="nn">types</span>
    57. 

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

  58. 

  59. <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>
    60. 

  60. <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>
    61. 

  61. 

  62. <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
    63. 

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

  64. 

  65. 

  66. <div class="viewcode-block" id="EngineTraitsEncoder">
    67. 

  67. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsEncoder">[docs]</a>
    68. 

  68. <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>
    69. 

  69. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Encodes :class:`EngineTraits` to a serializable object, see</span>
    70. 

  70. <span class="sd">    :class:`json.JSONEncoder`.&quot;&quot;&quot;</span>
    71. 

  71. 

  72. <div class="viewcode-block" id="EngineTraitsEncoder.default">
    73. 

  73. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsEncoder.default">[docs]</a>
    74. 

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

  75. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Return dictionary of a :class:`EngineTraits` object.&quot;&quot;&quot;</span>
    76. 

  76.         <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>
    77. 

  77.             <span class="k">return</span> <span class="n">o</span><span class="o">.</span><span class="vm">__dict__</span>
    78. 

  78.         <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>
    79. 

  79. </div>
    80. 

  80. 

  81. 

  82. 

  83. <div class="viewcode-block" id="EngineTraits">
    84. 

  84. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits">[docs]</a>
    85. 

  85. <span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span>
    86. 

  86. <span class="k">class</span><span class="w"> </span><span class="nc">EngineTraits</span><span class="p">:</span>
    87. 

  87. <span class="w">    </span><span class="sd">&quot;&quot;&quot;The class is intended to be instantiated for each engine.&quot;&quot;&quot;</span>
    88. 

  88. 

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

  90. <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>
    91. 

  91. 

  92. <span class="sd">    SearXNG&#39;s internal representation can be parsed by babel and the value is</span>
    93. 

  93. <span class="sd">    send to the engine:</span>
    94. 

  94. 

  95. <span class="sd">    .. code:: python</span>
    96. 

  96. 

  97. <span class="sd">       regions ={</span>
    98. 

  98. <span class="sd">           &#39;fr-BE&#39; : &lt;engine&#39;s region name&gt;,</span>
    99. 

  99. <span class="sd">       }</span>
    100. 

  100. 

  101. <span class="sd">       for key, egnine_region regions.items():</span>
    102. 

  102. <span class="sd">          searxng_region = babel.Locale.parse(key, sep=&#39;-&#39;)</span>
    103. 

  103. <span class="sd">          ...</span>
    104. 

  104. <span class="sd">    &quot;&quot;&quot;</span>
    105. 

  105. 

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

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

  108. 

  109. <span class="sd">    SearXNG&#39;s internal representation can be parsed by babel and the value is</span>
    110. 

  110. <span class="sd">    send to the engine:</span>
    111. 

  111. 

  112. <span class="sd">    .. code:: python</span>
    113. 

  113. 

  114. <span class="sd">       languages = {</span>
    115. 

  115. <span class="sd">           &#39;ca&#39; : &lt;engine&#39;s language name&gt;,</span>
    116. 

  116. <span class="sd">       }</span>
    117. 

  117. 

  118. <span class="sd">       for key, egnine_lang in languages.items():</span>
    119. 

  119. <span class="sd">          searxng_lang = babel.Locale.parse(key)</span>
    120. 

  120. <span class="sd">          ...</span>
    121. 

  121. <span class="sd">    &quot;&quot;&quot;</span>
    122. 

  122. 

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

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

  125. <span class="sd">    language&quot;).</span>
    126. 

  126. <span class="sd">    &quot;&quot;&quot;</span>
    127. 

  127. 

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

  129. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Data type, default is &#39;traits_v1&#39;.</span>
    130. 

  130. <span class="sd">    &quot;&quot;&quot;</span>
    131. 

  131. 

  132.     <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>
    133. 

  133. <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>
    134. 

  134. <span class="sd">    &quot;&quot;&quot;</span>
    135. 

  135. 

  136. <div class="viewcode-block" id="EngineTraits.get_language">
    137. 

  137. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.get_language">[docs]</a>
    138. 

  138.     <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>
    139. 

  139. <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>
    140. 

  140. 

  141. <span class="sd">        :param searxng_locale: SearXNG&#39;s internal representation of locale</span>
    142. 

  142. <span class="sd">          selected by the user.</span>
    143. 

  143. 

  144. <span class="sd">        :param default: engine&#39;s default language</span>
    145. 

  145. 

  146. <span class="sd">        The *best fits* rules are implemented in</span>
    147. 

  147. <span class="sd">        :py:obj:`searx.locales.get_engine_locale`.  Except for the special value ``all``</span>
    148. 

  148. <span class="sd">        which is determined from :py:obj:`EngineTraits.all_locale`.</span>
    149. 

  149. <span class="sd">        &quot;&quot;&quot;</span>
    150. 

  150.         <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>
    151. 

  151.             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_locale</span>
    152. 

  152.         <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>
    153. 

  153. 

  154. 

  155. <div class="viewcode-block" id="EngineTraits.get_region">
    156. 

  156. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.get_region">[docs]</a>
    157. 

  157.     <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>
    158. 

  158. <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>
    159. 

  159. 

  160. <span class="sd">        :param searxng_locale: SearXNG&#39;s internal representation of locale</span>
    161. 

  161. <span class="sd">          selected by the user.</span>
    162. 

  162. 

  163. <span class="sd">        :param default: engine&#39;s default region</span>
    164. 

  164. 

  165. <span class="sd">        The *best fits* rules are implemented in</span>
    166. 

  166. <span class="sd">        :py:obj:`searx.locales.get_engine_locale`.  Except for the special value ``all``</span>
    167. 

  167. <span class="sd">        which is determined from :py:obj:`EngineTraits.all_locale`.</span>
    168. 

  168. <span class="sd">        &quot;&quot;&quot;</span>
    169. 

  169.         <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>
    170. 

  170.             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_locale</span>
    171. 

  171.         <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>
    172. 

  172. 

  173. 

  174. <div class="viewcode-block" id="EngineTraits.is_locale_supported">
    175. 

  175. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.is_locale_supported">[docs]</a>
    176. 

  176.     <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>
    177. 

  177. <span class="w">        </span><span class="sd">&quot;&quot;&quot;A *locale* (SearXNG&#39;s internal representation) is considered to be</span>
    178. 

  178. <span class="sd">        supported by the engine if the *region* or the *language* is supported</span>
    179. 

  179. <span class="sd">        by the engine.</span>
    180. 

  180. 

  181. <span class="sd">        For verification the functions :py:func:`EngineTraits.get_region` and</span>
    182. 

  182. <span class="sd">        :py:func:`EngineTraits.get_language` are used.</span>
    183. 

  183. <span class="sd">        &quot;&quot;&quot;</span>
    184. 

  184.         <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>
    185. 

  185.             <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>
    186. 

  186. 

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

  188. 

  189. 

  190. <div class="viewcode-block" id="EngineTraits.copy">
    191. 

  191. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.copy">[docs]</a>
    192. 

  192.     <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>
    193. 

  193. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Create a copy of the dataclass object.&quot;&quot;&quot;</span>
    194. 

  194.         <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>
    195. 

  195. 

  196. 

  197. <div class="viewcode-block" id="EngineTraits.fetch_traits">
    198. 

  198. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraits.fetch_traits">[docs]</a>
    199. 

  199.     <span class="nd">@classmethod</span>
    200. 

  200.     <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>
    201. 

  201. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Call a function ``fetch_traits(engine_traits)`` from engines namespace to fetch</span>
    202. 

  202. <span class="sd">        and set properties from the origin engine in the object ``engine_traits``.  If</span>
    203. 

  203. <span class="sd">        function does not exists, ``None`` is returned.</span>
    204. 

  204. <span class="sd">        &quot;&quot;&quot;</span>
    205. 

  205. 

  206.         <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>
    207. 

  207.         <span class="n">engine_traits</span> <span class="o">=</span> <span class="kc">None</span>
    208. 

  208. 

  209.         <span class="k">if</span> <span class="n">fetch_traits</span><span class="p">:</span>
    210. 

  210.             <span class="n">engine_traits</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
    211. 

  211.             <span class="n">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">)</span>
    212. 

  212.         <span class="k">return</span> <span class="n">engine_traits</span></div>
    213. 

  213. 

  214. 

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

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

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

  218. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set traits from self object in a :py:obj:`.Engine` namespace.</span>
    219. 

  219. 

  220. <span class="sd">        :param engine: engine instance build by :py:func:`searx.engines.load_engine`</span>
    221. 

  221. <span class="sd">        &quot;&quot;&quot;</span>
    222. 

  222. 

  223.         <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>
    224. 

  224.             <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>
    225. 

  225.         <span class="k">else</span><span class="p">:</span>
    226. 

  226.             <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>
    227. 

  227. 

  228. 

  229.     <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>
    230. 

  230.         <span class="c1"># For an engine, when there is `language: ...` in the YAML settings the engine</span>
    231. 

  231.         <span class="c1"># does support only this one language (region)::</span>
    232. 

  232.         <span class="c1">#</span>
    233. 

  233.         <span class="c1">#   - name: google italian</span>
    234. 

  234.         <span class="c1">#     engine: google</span>
    235. 

  235.         <span class="c1">#     language: it</span>
    236. 

  236.         <span class="c1">#     region: it-IT                                      # type: ignore</span>
    237. 

  237. 

  238.         <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>
    239. 

  239. 

  240.         <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>
    241. 

  241. 

  242.         <span class="n">languages</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">languages</span>
    243. 

  243.         <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>
    244. 

  244.             <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>
    245. 

  245.                 <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>
    246. 

  246.             <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>
    247. 

  247. 

  248.         <span class="n">regions</span> <span class="o">=</span> <span class="n">traits</span><span class="o">.</span><span class="n">regions</span>
    249. 

  249.         <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>
    250. 

  250.             <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>
    251. 

  251.                 <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>
    252. 

  252.             <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>
    253. 

  253. 

  254.         <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>
    255. 

  255. 

  256.         <span class="c1"># set the copied &amp; modified traits in engine&#39;s namespace</span>
    257. 

  257.         <span class="n">engine</span><span class="o">.</span><span class="n">traits</span> <span class="o">=</span> <span class="n">traits</span></div>
    258. 

  258. 

  259. 

  260. 

  261. <div class="viewcode-block" id="EngineTraitsMap">
    262. 

  262. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsMap">[docs]</a>
    263. 

  263. <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>
    264. 

  264. <span class="w">    </span><span class="sd">&quot;&quot;&quot;A python dictionary to map :class:`EngineTraits` by engine name.&quot;&quot;&quot;</span>
    265. 

  265. 

  266.     <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>
    267. 

  267. <span class="w">    </span><span class="sd">&quot;&quot;&quot;File with persistence of the :py:obj:`EngineTraitsMap`.&quot;&quot;&quot;</span>
    268. 

  268. 

  269. <div class="viewcode-block" id="EngineTraitsMap.save_data">
    270. 

  270. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsMap.save_data">[docs]</a>
    271. 

  271.     <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>
    272. 

  272. <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>
    273. 

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

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

  275. 

  276. 

  277. <div class="viewcode-block" id="EngineTraitsMap.from_data">
    278. 

  278. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsMap.from_data">[docs]</a>
    279. 

  279.     <span class="nd">@classmethod</span>
    280. 

  280.     <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>
    281. 

  281. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Instantiate :class:`EngineTraitsMap` object from :py:obj:`ENGINE_TRAITS`&quot;&quot;&quot;</span>
    282. 

  282.         <span class="n">obj</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
    283. 

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

  284.             <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>
    285. 

  285.         <span class="k">return</span> <span class="n">obj</span></div>
    286. 

  286. 

  287. 

  288.     <span class="nd">@classmethod</span>
    289. 

  289.     <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>
    290. 

  290.         <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>
    291. 

  291. 

  292.         <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>
    293. 

  293.         <span class="n">names</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
    294. 

  294.         <span class="n">obj</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">()</span>
    295. 

  295. 

  296.         <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>
    297. 

  297.             <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>
    298. 

  298.             <span class="n">traits</span> <span class="o">=</span> <span class="kc">None</span>
    299. 

  299. 

  300.             <span class="c1"># pylint: disable=broad-exception-caught</span>
    301. 

  301.             <span class="k">try</span><span class="p">:</span>
    302. 

  302.                 <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>
    303. 

  303.             <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
    304. 

  304.                 <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>
    305. 

  305.                 <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>
    306. 

  306.                     <span class="k">raise</span>
    307. 

  307.                 <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>
    308. 

  308.                 <span class="k">if</span> <span class="n">v</span><span class="p">:</span>
    309. 

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

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

  311. 

  312.             <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>
    313. 

  313.                 <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>
    314. 

  314.                 <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>
    315. 

  315.                 <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>
    316. 

  316. 

  317.         <span class="k">return</span> <span class="n">obj</span>
    318. 

  318. 

  319. <div class="viewcode-block" id="EngineTraitsMap.set_traits">
    320. 

  320. <a class="viewcode-back" href="../../../dev/engines/enginelib.html#searx.enginelib.traits.EngineTraitsMap.set_traits">[docs]</a>
    321. 

  321.     <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>
    322. 

  322. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set traits in a :py:obj:`Engine` namespace.</span>
    323. 

  323. 

  324. <span class="sd">        :param engine: engine instance build by :py:func:`searx.engines.load_engine`</span>
    325. 

  325. <span class="sd">        &quot;&quot;&quot;</span>
    326. 

  326. 

  327.         <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>
    328. 

  328.         <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>
    329. 

  329.             <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>
    330. 

  330. 

  331.         <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>
    332. 

  332.             <span class="c1"># The key of the dictionary traits_map is the *engine name*</span>
    333. 

  333.             <span class="c1"># configured in settings.xml.  When multiple engines are configured</span>
    334. 

  334.             <span class="c1"># in settings.yml to use the same origin engine (python module)</span>
    335. 

  335.             <span class="c1"># these additional engines can use the languages from the origin</span>
    336. 

  336.             <span class="c1"># engine.  For this use the configured ``engine: ...`` from</span>
    337. 

  337.             <span class="c1"># settings.yml</span>
    338. 

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

  339. 

  340.         <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>
    341. 

  341. </div>
    342. 

  342. 

  343. </pre></div>
    344. 

  344. 

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

  346.           </div>
    347. 

  347.         </div>
    348. 

  348.       </div>
    349. 

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

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

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

  352.   
    353. 

  353.     
    354. 

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

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

  356.             </a></p>
    357. 

  357.   
    358. 

  358. 

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

  360. <ul>
    361. 

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

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

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

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

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

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

  367. </ul>
    368. 

  368. 

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

  370.   <ul>
    371. 

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

  372.   
    373. 

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

  374.   
    375. 

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

  376.   
    377. 

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

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

  379. <ul>
    380. 

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

  381.     <ul>
    382. 

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

  383.         <ul>
    384. 

  384.       <li><a href="../enginelib.html">searx.enginelib</a>
    385. 

  385.         
    386. 

  386.           
    387. 

  387.           </ul>
    388. 

  388.       </li></ul>
    389. 

  389.       </li>
    390. 

  390.     </ul>
    391. 

  391.   </li>
    392. 

  392. </ul>
    393. 

  393. <search id="searchbox" style="display: none" role="search">
    394. 

  394.   <h3 id="searchlabel">Quick search</h3>
    395. 

  395.     <div class="searchformwrapper">
    396. 

  396.     <form class="search" action="../../../search.html" method="get">
    397. 

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

  398.       <input type="submit" value="Go" />
    399. 

  399.     </form>
    400. 

  400.     </div>
    401. 

  401. </search>
    402. 

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

  403.         </div>
    404. 

  404.       </div>
    405. 

  405.       <div class="clearer"></div>
    406. 

  406.     </div>
    407. 

  407.     <div class="footer" role="contentinfo">
    408. 

  408.     &#169; Copyright SearXNG team.
    409. 

  409.     </div>
    410. 

  410.   </body>
    411. 

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