NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
searxng
/
_modules
/
searx
/
settings_loader.html

settings_loader.html 33 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337 
  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.settings_loader &#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" accesskey="U">Module code</a> &#187;</li>
    29. 

  29.         <li class="nav-item nav-item-this"><a href="">searx.settings_loader</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.settings_loader</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 for loading configurations from YAML files.  This essentially</span>
    41. 

  41. <span class="sd">includes the configuration of the (:ref:`SearXNG appl &lt;searxng settings.yml&gt;`)</span>
    42. 

  42. <span class="sd">server. The default configuration for the application server is loaded from the</span>
    43. 

  43. <span class="sd">:origin:`DEFAULT_SETTINGS_FILE &lt;searx/settings.yml&gt;`.  This default</span>
    44. 

  44. <span class="sd">configuration can be completely replaced or :ref:`customized individually</span>
    45. 

  45. <span class="sd">&lt;use_default_settings.yml&gt;` and the ``SEARXNG_SETTINGS_PATH`` environment</span>
    46. 

  46. <span class="sd">variable can be used to set the location from which the local customizations are</span>
    47. 

  47. <span class="sd">to be loaded. The rules used for this can be found in the</span>
    48. 

  48. <span class="sd">:py:obj:`get_user_cfg_folder` function.</span>
    49. 

  49. 

  50. <span class="sd">- By default, local configurations are expected in folder ``/etc/searxng`` from</span>
    51. 

  51. <span class="sd">  where applications can load them with the :py:obj:`get_yaml_cfg` function.</span>
    52. 

  52. 

  53. <span class="sd">- By default, customized :ref:`SearXNG appl &lt;searxng settings.yml&gt;` settings are</span>
    54. 

  54. <span class="sd">  expected in a file named ``settings.yml``.</span>
    55. 

  55. 

  56. <span class="sd">&quot;&quot;&quot;</span>
    57. 

  57. 

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

  59. 

  60. <span class="kn">import</span><span class="w"> </span><span class="nn">os.path</span>
    61. 

  61. <span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Mapping</span>
    62. 

  62. <span class="kn">from</span><span class="w"> </span><span class="nn">itertools</span><span class="w"> </span><span class="kn">import</span> <span class="n">filterfalse</span>
    63. 

  63. <span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
    64. 

  64. 

  65. <span class="kn">import</span><span class="w"> </span><span class="nn">yaml</span>
    66. 

  66. 

  67. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearxSettingsException</span>
    68. 

  68. 

  69. <span class="n">searx_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
    70. 

  70. 

  71. <span class="n">SETTINGS_YAML</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s2">&quot;settings.yml&quot;</span><span class="p">)</span>
    72. 

  72. <span class="n">DEFAULT_SETTINGS_FILE</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">searx_dir</span><span class="p">)</span> <span class="o">/</span> <span class="n">SETTINGS_YAML</span>
    73. 

  73. <span class="sd">&quot;&quot;&quot;The :origin:`searx/settings.yml` file with all the default settings.&quot;&quot;&quot;</span>
    74. 

  74. 

  75. 

  76. <div class="viewcode-block" id="load_yaml">
    77. 

  77. <a class="viewcode-back" href="../../src/searx.settings.html#searx.settings_loader.load_yaml">[docs]</a>
    78. 

  78. <span class="k">def</span><span class="w"> </span><span class="nf">load_yaml</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Path</span><span class="p">):</span>
    79. 

  79. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Load YAML config from a file.&quot;&quot;&quot;</span>
    80. 

  80.     <span class="k">try</span><span class="p">:</span>
    81. 

  81.         <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">settings_yaml</span><span class="p">:</span>
    82. 

  82.             <span class="k">return</span> <span class="n">yaml</span><span class="o">.</span><span class="n">safe_load</span><span class="p">(</span><span class="n">settings_yaml</span><span class="p">)</span> <span class="ow">or</span> <span class="p">{}</span>
    83. 

  83.     <span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    84. 

  84.         <span class="k">raise</span> <span class="n">SearxSettingsException</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">file_name</span><span class="p">))</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span>
    85. 

  85.     <span class="k">except</span> <span class="n">yaml</span><span class="o">.</span><span class="n">YAMLError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    86. 

  86.         <span class="k">raise</span> <span class="n">SearxSettingsException</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">file_name</span><span class="p">))</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span></div>
    87. 

  87. 

  88. 

  89. 

  90. <div class="viewcode-block" id="get_yaml_cfg">
    91. 

  91. <a class="viewcode-back" href="../../src/searx.settings.html#searx.settings_loader.get_yaml_cfg">[docs]</a>
    92. 

  92. <span class="k">def</span><span class="w"> </span><span class="nf">get_yaml_cfg</span><span class="p">(</span><span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
    93. 

  93. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Shortcut to load a YAML config from a file, located in the</span>
    94. 

  94. 

  95. <span class="sd">    - :py:obj:`get_user_cfg_folder` or</span>
    96. 

  96. <span class="sd">    - in the ``searx`` folder of the SearXNG installation</span>
    97. 

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

  98. 

  99.     <span class="n">folder</span> <span class="o">=</span> <span class="n">get_user_cfg_folder</span><span class="p">()</span> <span class="ow">or</span> <span class="n">Path</span><span class="p">(</span><span class="n">searx_dir</span><span class="p">)</span>
    100. 

  100.     <span class="n">fname</span> <span class="o">=</span> <span class="n">folder</span> <span class="o">/</span> <span class="n">file_name</span>
    101. 

  101.     <span class="k">if</span> <span class="ow">not</span> <span class="n">fname</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
    102. 

  102.         <span class="k">raise</span> <span class="ne">FileNotFoundError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;File </span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s2"> does not exist!&quot;</span><span class="p">)</span>
    103. 

  103. 

  104.     <span class="k">return</span> <span class="n">load_yaml</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span></div>
    105. 

  105. 

  106. 

  107. 

  108. <div class="viewcode-block" id="get_user_cfg_folder">
    109. 

  109. <a class="viewcode-back" href="../../src/searx.settings.html#searx.settings_loader.get_user_cfg_folder">[docs]</a>
    110. 

  110. <span class="k">def</span><span class="w"> </span><span class="nf">get_user_cfg_folder</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
    111. 

  111. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns folder where the local configurations are located.</span>
    112. 

  112. 

  113. <span class="sd">    1. If the ``SEARXNG_SETTINGS_PATH`` environment is set and points to a</span>
    114. 

  114. <span class="sd">       folder (e.g. ``/etc/mysxng/``), all local configurations are expected in</span>
    115. 

  115. <span class="sd">       this folder.  The settings of the :ref:`SearXNG appl &lt;searxng</span>
    116. 

  116. <span class="sd">       settings.yml&gt;` then expected in ``settings.yml``</span>
    117. 

  117. <span class="sd">       (e.g. ``/etc/mysxng/settings.yml``).</span>
    118. 

  118. 

  119. <span class="sd">    2. If the ``SEARXNG_SETTINGS_PATH`` environment is set and points to a file</span>
    120. 

  120. <span class="sd">       (e.g. ``/etc/mysxng/myinstance.yml``), this file contains the settings of</span>
    121. 

  121. <span class="sd">       the :ref:`SearXNG appl &lt;searxng settings.yml&gt;` and the folder</span>
    122. 

  122. <span class="sd">       (e.g. ``/etc/mysxng/``) is used for all other configurations.</span>
    123. 

  123. 

  124. <span class="sd">       This type (``SEARXNG_SETTINGS_PATH`` points to a file) is suitable for</span>
    125. 

  125. <span class="sd">       use cases in which different profiles of the :ref:`SearXNG appl &lt;searxng</span>
    126. 

  126. <span class="sd">       settings.yml&gt;` are to be managed, such as in test scenarios.</span>
    127. 

  127. 

  128. <span class="sd">    3. If folder ``/etc/searxng`` exists, it is used.</span>
    129. 

  129. 

  130. <span class="sd">    In case none of the above path exists, ``None`` is returned.  In case of</span>
    131. 

  131. <span class="sd">    environment ``SEARXNG_SETTINGS_PATH`` is set, but the (folder or file) does</span>
    132. 

  132. <span class="sd">    not exists, a :py:obj:`EnvironmentError` is raised.</span>
    133. 

  133. 

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

  135. 

  136.     <span class="n">folder</span> <span class="o">=</span> <span class="kc">None</span>
    137. 

  137.     <span class="n">settings_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;SEARXNG_SETTINGS_PATH&quot;</span><span class="p">)</span>
    138. 

  138. 

  139.     <span class="c1"># Disable default /etc/searxng is intended exclusively for internal testing purposes</span>
    140. 

  140.     <span class="c1"># and is therefore not documented!</span>
    141. 

  141.     <span class="n">disable_etc</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;SEARXNG_DISABLE_ETC_SETTINGS&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;1&#39;</span><span class="p">,</span> <span class="s1">&#39;true&#39;</span><span class="p">)</span>
    142. 

  142. 

  143.     <span class="k">if</span> <span class="n">settings_path</span><span class="p">:</span>
    144. 

  144.         <span class="c1"># rule 1. and 2.</span>
    145. 

  145.         <span class="n">settings_path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">settings_path</span><span class="p">)</span>
    146. 

  146.         <span class="k">if</span> <span class="n">settings_path</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
    147. 

  147.             <span class="n">folder</span> <span class="o">=</span> <span class="n">settings_path</span>
    148. 

  148.         <span class="k">elif</span> <span class="n">settings_path</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
    149. 

  149.             <span class="n">folder</span> <span class="o">=</span> <span class="n">settings_path</span><span class="o">.</span><span class="n">parent</span>
    150. 

  150.         <span class="k">else</span><span class="p">:</span>
    151. 

  151.             <span class="k">raise</span> <span class="ne">EnvironmentError</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">settings_path</span><span class="si">}</span><span class="s2"> not exists!&quot;</span><span class="p">,</span> <span class="n">settings_path</span><span class="p">)</span>
    152. 

  152. 

  153.     <span class="k">if</span> <span class="ow">not</span> <span class="n">folder</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">disable_etc</span><span class="p">:</span>
    154. 

  154.         <span class="c1"># default: rule 3.</span>
    155. 

  155.         <span class="n">folder</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s2">&quot;/etc/searxng&quot;</span><span class="p">)</span>
    156. 

  156.         <span class="k">if</span> <span class="ow">not</span> <span class="n">folder</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
    157. 

  157.             <span class="n">folder</span> <span class="o">=</span> <span class="kc">None</span>
    158. 

  158. 

  159.     <span class="k">return</span> <span class="n">folder</span></div>
    160. 

  160. 

  161. 

  162. 

  163. <span class="k">def</span><span class="w"> </span><span class="nf">update_dict</span><span class="p">(</span><span class="n">default_dict</span><span class="p">,</span> <span class="n">user_dict</span><span class="p">):</span>
    164. 

  164.     <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">user_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    165. 

  165.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
    166. 

  166.             <span class="n">default_dict</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">update_dict</span><span class="p">(</span><span class="n">default_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="p">{}),</span> <span class="n">v</span><span class="p">)</span>
    167. 

  167.         <span class="k">else</span><span class="p">:</span>
    168. 

  168.             <span class="n">default_dict</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
    169. 

  169.     <span class="k">return</span> <span class="n">default_dict</span>
    170. 

  170. 

  171. 

  172. <span class="k">def</span><span class="w"> </span><span class="nf">update_settings</span><span class="p">(</span><span class="n">default_settings</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">user_settings</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
    173. 

  173.     <span class="c1"># pylint: disable=too-many-branches</span>
    174. 

  174. 

  175.     <span class="c1"># merge everything except the engines</span>
    176. 

  176.     <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    177. 

  177.         <span class="k">if</span> <span class="n">k</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;use_default_settings&#39;</span><span class="p">,</span> <span class="s1">&#39;engines&#39;</span><span class="p">):</span>
    178. 

  178.             <span class="k">if</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">default_settings</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">):</span>
    179. 

  179.                 <span class="n">update_dict</span><span class="p">(</span><span class="n">default_settings</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="n">v</span><span class="p">)</span>
    180. 

  180.             <span class="k">else</span><span class="p">:</span>
    181. 

  181.                 <span class="n">default_settings</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
    182. 

  182. 

  183.     <span class="n">categories_as_tabs</span> <span class="o">=</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;categories_as_tabs&#39;</span><span class="p">)</span>
    184. 

  184.     <span class="k">if</span> <span class="n">categories_as_tabs</span><span class="p">:</span>
    185. 

  185.         <span class="n">default_settings</span><span class="p">[</span><span class="s1">&#39;categories_as_tabs&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">categories_as_tabs</span>
    186. 

  186. 

  187.     <span class="c1"># parse the engines</span>
    188. 

  188.     <span class="n">remove_engines</span> <span class="o">=</span> <span class="kc">None</span>
    189. 

  189.     <span class="n">keep_only_engines</span> <span class="o">=</span> <span class="kc">None</span>
    190. 

  190.     <span class="n">use_default_settings</span> <span class="o">=</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;use_default_settings&#39;</span><span class="p">)</span>
    191. 

  191.     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">use_default_settings</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    192. 

  192.         <span class="n">remove_engines</span> <span class="o">=</span> <span class="n">use_default_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;engines&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;remove&#39;</span><span class="p">)</span>
    193. 

  193.         <span class="n">keep_only_engines</span> <span class="o">=</span> <span class="n">use_default_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;engines&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;keep_only&#39;</span><span class="p">)</span>
    194. 

  194. 

  195.     <span class="k">if</span> <span class="s1">&#39;engines&#39;</span> <span class="ow">in</span> <span class="n">user_settings</span> <span class="ow">or</span> <span class="n">remove_engines</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">keep_only_engines</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    196. 

  196.         <span class="n">engines</span> <span class="o">=</span> <span class="n">default_settings</span><span class="p">[</span><span class="s1">&#39;engines&#39;</span><span class="p">]</span>
    197. 

  197. 

  198.         <span class="c1"># parse &quot;use_default_settings.engines.remove&quot;</span>
    199. 

  199.         <span class="k">if</span> <span class="n">remove_engines</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    200. 

  200.             <span class="n">engines</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">filterfalse</span><span class="p">(</span><span class="k">lambda</span> <span class="n">engine</span><span class="p">:</span> <span class="p">(</span><span class="n">engine</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">))</span> <span class="ow">in</span> <span class="n">remove_engines</span><span class="p">,</span> <span class="n">engines</span><span class="p">))</span>
    201. 

  201. 

  202.         <span class="c1"># parse &quot;use_default_settings.engines.keep_only&quot;</span>
    203. 

  203.         <span class="k">if</span> <span class="n">keep_only_engines</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    204. 

  204.             <span class="n">engines</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">filter</span><span class="p">(</span><span class="k">lambda</span> <span class="n">engine</span><span class="p">:</span> <span class="p">(</span><span class="n">engine</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">))</span> <span class="ow">in</span> <span class="n">keep_only_engines</span><span class="p">,</span> <span class="n">engines</span><span class="p">))</span>
    205. 

  205. 

  206.         <span class="c1"># parse &quot;engines&quot;</span>
    207. 

  207.         <span class="n">user_engines</span> <span class="o">=</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;engines&#39;</span><span class="p">)</span>
    208. 

  208.         <span class="k">if</span> <span class="n">user_engines</span><span class="p">:</span>
    209. 

  209.             <span class="n">engines_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">definition</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span> <span class="n">definition</span><span class="p">)</span> <span class="k">for</span> <span class="n">definition</span> <span class="ow">in</span> <span class="n">engines</span><span class="p">)</span>
    210. 

  210.             <span class="k">for</span> <span class="n">user_engine</span> <span class="ow">in</span> <span class="n">user_engines</span><span class="p">:</span>
    211. 

  211.                 <span class="n">default_engine</span> <span class="o">=</span> <span class="n">engines_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">user_engine</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">])</span>
    212. 

  212.                 <span class="k">if</span> <span class="n">default_engine</span><span class="p">:</span>
    213. 

  213.                     <span class="n">update_dict</span><span class="p">(</span><span class="n">default_engine</span><span class="p">,</span> <span class="n">user_engine</span><span class="p">)</span>
    214. 

  214.                 <span class="k">else</span><span class="p">:</span>
    215. 

  215.                     <span class="n">engines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">user_engine</span><span class="p">)</span>
    216. 

  216. 

  217.         <span class="c1"># store the result</span>
    218. 

  218.         <span class="n">default_settings</span><span class="p">[</span><span class="s1">&#39;engines&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">engines</span>
    219. 

  219. 

  220.     <span class="k">return</span> <span class="n">default_settings</span>
    221. 

  221. 

  222. 

  223. <span class="k">def</span><span class="w"> </span><span class="nf">is_use_default_settings</span><span class="p">(</span><span class="n">user_settings</span><span class="p">):</span>
    224. 

  224. 

  225.     <span class="n">use_default_settings</span> <span class="o">=</span> <span class="n">user_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;use_default_settings&#39;</span><span class="p">)</span>
    226. 

  226.     <span class="k">if</span> <span class="n">use_default_settings</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
    227. 

  227.         <span class="k">return</span> <span class="kc">True</span>
    228. 

  228.     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">use_default_settings</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    229. 

  229.         <span class="k">return</span> <span class="kc">True</span>
    230. 

  230.     <span class="k">if</span> <span class="n">use_default_settings</span> <span class="ow">is</span> <span class="kc">False</span> <span class="ow">or</span> <span class="n">use_default_settings</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    231. 

  231.         <span class="k">return</span> <span class="kc">False</span>
    232. 

  232.     <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Invalid value for use_default_settings&#39;</span><span class="p">)</span>
    233. 

  233. 

  234. 

  235. <div class="viewcode-block" id="load_settings">
    236. 

  236. <a class="viewcode-back" href="../../src/searx.settings.html#searx.settings_loader.load_settings">[docs]</a>
    237. 

  237. <span class="k">def</span><span class="w"> </span><span class="nf">load_settings</span><span class="p">(</span><span class="n">load_user_settings</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">dict</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
    238. 

  238. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Function for loading the settings of the SearXNG application</span>
    239. 

  239. <span class="sd">    (:ref:`settings.yml &lt;searxng settings.yml&gt;`).&quot;&quot;&quot;</span>
    240. 

  240. 

  241.     <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;load the default settings from </span><span class="si">{</span><span class="n">DEFAULT_SETTINGS_FILE</span><span class="si">}</span><span class="s2">&quot;</span>
    242. 

  242.     <span class="n">cfg</span> <span class="o">=</span> <span class="n">load_yaml</span><span class="p">(</span><span class="n">DEFAULT_SETTINGS_FILE</span><span class="p">)</span>
    243. 

  243.     <span class="n">cfg_folder</span> <span class="o">=</span> <span class="n">get_user_cfg_folder</span><span class="p">()</span>
    244. 

  244. 

  245.     <span class="k">if</span> <span class="ow">not</span> <span class="n">load_user_settings</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">cfg_folder</span><span class="p">:</span>
    246. 

  246.         <span class="k">return</span> <span class="n">cfg</span><span class="p">,</span> <span class="n">msg</span>
    247. 

  247. 

  248.     <span class="n">settings_yml</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;SEARXNG_SETTINGS_PATH&quot;</span><span class="p">)</span>
    249. 

  249.     <span class="k">if</span> <span class="n">settings_yml</span> <span class="ow">and</span> <span class="n">Path</span><span class="p">(</span><span class="n">settings_yml</span><span class="p">)</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
    250. 

  250.         <span class="c1"># see get_user_cfg_folder() --&gt; SEARXNG_SETTINGS_PATH points to a file</span>
    251. 

  251.         <span class="n">settings_yml</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">settings_yml</span><span class="p">)</span><span class="o">.</span><span class="n">name</span>
    252. 

  252.     <span class="k">else</span><span class="p">:</span>
    253. 

  253.         <span class="c1"># see get_user_cfg_folder() --&gt; SEARXNG_SETTINGS_PATH points to a folder</span>
    254. 

  254.         <span class="n">settings_yml</span> <span class="o">=</span> <span class="n">SETTINGS_YAML</span>
    255. 

  255. 

  256.     <span class="n">cfg_file</span> <span class="o">=</span> <span class="n">cfg_folder</span> <span class="o">/</span> <span class="n">settings_yml</span>
    257. 

  257.     <span class="k">if</span> <span class="ow">not</span> <span class="n">cfg_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
    258. 

  258.         <span class="k">return</span> <span class="n">cfg</span><span class="p">,</span> <span class="n">msg</span>
    259. 

  259. 

  260.     <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;load the user settings from </span><span class="si">{</span><span class="n">cfg_file</span><span class="si">}</span><span class="s2">&quot;</span>
    261. 

  261.     <span class="n">user_cfg</span> <span class="o">=</span> <span class="n">load_yaml</span><span class="p">(</span><span class="n">cfg_file</span><span class="p">)</span>
    262. 

  262. 

  263.     <span class="k">if</span> <span class="n">is_use_default_settings</span><span class="p">(</span><span class="n">user_cfg</span><span class="p">):</span>
    264. 

  264.         <span class="c1"># the user settings are merged with the default configuration</span>
    265. 

  265.         <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;merge the default settings ( </span><span class="si">{</span><span class="n">DEFAULT_SETTINGS_FILE</span><span class="si">}</span><span class="s2"> ) and the user settings ( </span><span class="si">{</span><span class="n">cfg_file</span><span class="si">}</span><span class="s2"> )&quot;</span>
    266. 

  266.         <span class="n">update_settings</span><span class="p">(</span><span class="n">cfg</span><span class="p">,</span> <span class="n">user_cfg</span><span class="p">)</span>
    267. 

  267.     <span class="k">else</span><span class="p">:</span>
    268. 

  268.         <span class="n">cfg</span> <span class="o">=</span> <span class="n">user_cfg</span>
    269. 

  269. 

  270.     <span class="k">return</span> <span class="n">cfg</span><span class="p">,</span> <span class="n">msg</span></div>
    271. 

  271. 

  272. </pre></div>
    273. 

  273. 

  274.             <div class="clearer"></div>
    275. 

  275.           </div>
    276. 

  276.         </div>
    277. 

  277.       </div>
    278. 

  278.   <span id="sidebar-top"></span>
    279. 

  279.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    280. 

  280.         <div class="sphinxsidebarwrapper">
    281. 

  281.   
    282. 

  282.     
    283. 

  283.             <p class="logo"><a href="../../index.html">
    284. 

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

  285.             </a></p>
    286. 

  286.   
    287. 

  287. 

  288. <h3><a href="../../index.html">Table of Contents</a></h3>
    289. 

  289. <ul>
    290. 

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

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

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

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

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

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

  296. </ul>
    297. 

  297. 

  298.   <h3>Project Links</h3>
    299. 

  299.   <ul>
    300. 

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

  301.   
    302. 

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

  303.   
    304. 

  304.     <li><a href="https://searx.space">Public instances</a>
    305. 

  305.   
    306. 

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

  307.   </ul><h3>Navigation</h3>
    308. 

  308. <ul>
    309. 

  309.   <li><a href="../../index.html">Overview</a>
    310. 

  310.     <ul>
    311. 

  311.       <li><a href="../index.html">Module code</a>
    312. 

  312.         
    313. 

  313.           
    314. 

  314.           </ul>
    315. 

  315.       </li>
    316. 

  316.     </ul>
    317. 

  317.   </li>
    318. 

  318. </ul>
    319. 

  319. <search id="searchbox" style="display: none" role="search">
    320. 

  320.   <h3 id="searchlabel">Quick search</h3>
    321. 

  321.     <div class="searchformwrapper">
    322. 

  322.     <form class="search" action="../../search.html" method="get">
    323. 

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

  324.       <input type="submit" value="Go" />
    325. 

  325.     </form>
    326. 

  326.     </div>
    327. 

  327. </search>
    328. 

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

  329.         </div>
    330. 

  330.       </div>
    331. 

  331.       <div class="clearer"></div>
    332. 

  332.     </div>
    333. 

  333.     <div class="footer" role="contentinfo">
    334. 

  334.     &#169; Copyright SearXNG team.
    335. 

  335.     </div>
    336. 

  336.   </body>
    337. 

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