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
/
botdetection
/
config.html

config.html 54 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512 
  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.botdetection.config &#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.botdetection.config</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.botdetection.config</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;Configuration class :py:class:`Config` with deep-update, schema validation</span>
    41. 

  41. <span class="sd">and deprecated names.</span>
    42. 

  42. 

  43. <span class="sd">The :py:class:`Config` class implements a configuration that is based on</span>
    44. 

  44. <span class="sd">structured dictionaries.  The configuration schema is defined in a dictionary</span>
    45. 

  45. <span class="sd">structure and the configuration data is given in a dictionary structure.</span>
    46. 

  46. <span class="sd">&quot;&quot;&quot;</span>
    47. 

  47. <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>
    48. 

  48. <span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Any</span>
    49. 

  49. 

  50. <span class="kn">import</span><span class="w"> </span><span class="nn">copy</span>
    51. 

  51. <span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
    52. 

  52. <span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
    53. 

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

  54. 

  55. <span class="kn">from</span><span class="w"> </span><span class="nn">..compat</span><span class="w"> </span><span class="kn">import</span> <span class="n">tomllib</span>
    56. 

  56. 

  57. <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Config&#39;</span><span class="p">,</span> <span class="s1">&#39;UNSET&#39;</span><span class="p">,</span> <span class="s1">&#39;SchemaIssue&#39;</span><span class="p">]</span>
    58. 

  58. 

  59. <span class="n">log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
    60. 

  60. 

  61. 

  62. <span class="k">class</span><span class="w"> </span><span class="nc">FALSE</span><span class="p">:</span>
    63. 

  63. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Class of ``False`` singleton&quot;&quot;&quot;</span>
    64. 

  64. 

  65.     <span class="c1"># pylint: disable=multiple-statements</span>
    66. 

  66.     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
    67. 

  67.         <span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="n">msg</span>
    68. 

  68. 

  69.     <span class="k">def</span><span class="w"> </span><span class="fm">__bool__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    70. 

  70.         <span class="k">return</span> <span class="kc">False</span>
    71. 

  71. 

  72.     <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    73. 

  73.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">msg</span>
    74. 

  74. 

  75.     <span class="fm">__repr__</span> <span class="o">=</span> <span class="fm">__str__</span>
    76. 

  76. 

  77. 

  78. <span class="n">UNSET</span> <span class="o">=</span> <span class="n">FALSE</span><span class="p">(</span><span class="s1">&#39;&lt;UNSET&gt;&#39;</span><span class="p">)</span>
    79. 

  79. 

  80. 

  81. <div class="viewcode-block" id="SchemaIssue">
    82. 

  82. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.SchemaIssue">[docs]</a>
    83. 

  83. <span class="k">class</span><span class="w"> </span><span class="nc">SchemaIssue</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
    84. 

  84. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Exception to store and/or raise a message from a schema issue.&quot;&quot;&quot;</span>
    85. 

  85. 

  86.     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">level</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;warn&#39;</span><span class="p">,</span> <span class="s1">&#39;invalid&#39;</span><span class="p">],</span> <span class="n">msg</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    87. 

  87.         <span class="bp">self</span><span class="o">.</span><span class="n">level</span> <span class="o">=</span> <span class="n">level</span>
    88. 

  88.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    89. 

  89. 

  90.     <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    91. 

  91.         <span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;[cfg schema </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">level</span><span class="si">}</span><span class="s2">] </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span></div>
    92. 

  92. 

  93. 

  94. 

  95. <div class="viewcode-block" id="Config">
    96. 

  96. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config">[docs]</a>
    97. 

  97. <span class="k">class</span><span class="w"> </span><span class="nc">Config</span><span class="p">:</span>
    98. 

  98. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class used for configuration&quot;&quot;&quot;</span>
    99. 

  99. 

  100.     <span class="n">UNSET</span> <span class="o">=</span> <span class="n">UNSET</span>
    101. 

  101. 

  102.     <span class="nd">@classmethod</span>
    103. 

  103.     <span class="k">def</span><span class="w"> </span><span class="nf">from_toml</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">schema_file</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Config</span><span class="p">:</span>
    104. 

  104. 

  105.         <span class="c1"># init schema</span>
    106. 

  106. 

  107.         <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;load schema file: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">schema_file</span><span class="p">)</span>
    108. 

  108.         <span class="n">cfg</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">cfg_schema</span><span class="o">=</span><span class="n">toml_load</span><span class="p">(</span><span class="n">schema_file</span><span class="p">),</span> <span class="n">deprecated</span><span class="o">=</span><span class="n">deprecated</span><span class="p">)</span>
    109. 

  109.         <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>
    110. 

  110.             <span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;missing config file: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">)</span>
    111. 

  111.             <span class="k">return</span> <span class="n">cfg</span>
    112. 

  112. 

  113.         <span class="c1"># load configuration</span>
    114. 

  114. 

  115.         <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;load config file: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">cfg_file</span><span class="p">)</span>
    116. 

  116.         <span class="n">upd_cfg</span> <span class="o">=</span> <span class="n">toml_load</span><span class="p">(</span><span class="n">cfg_file</span><span class="p">)</span>
    117. 

  117. 

  118.         <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="n">upd_cfg</span><span class="p">)</span>
    119. 

  119.         <span class="k">for</span> <span class="n">msg</span> <span class="ow">in</span> <span class="n">issue_list</span><span class="p">:</span>
    120. 

  120.             <span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">msg</span><span class="p">))</span>
    121. 

  121.         <span class="k">if</span> <span class="ow">not</span> <span class="n">is_valid</span><span class="p">:</span>
    122. 

  122.             <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;schema of </span><span class="si">{</span><span class="n">cfg_file</span><span class="si">}</span><span class="s2"> is invalid!&quot;</span><span class="p">)</span>
    123. 

  123.         <span class="n">cfg</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">upd_cfg</span><span class="p">)</span>
    124. 

  124.         <span class="k">return</span> <span class="n">cfg</span>
    125. 

  125. 

  126.     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg_schema</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]):</span>
    127. 

  127. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Constructor of class Config.</span>
    128. 

  128. 

  129. <span class="sd">        :param cfg_schema: Schema of the configuration</span>
    130. 

  130. <span class="sd">        :param deprecated: dictionary that maps deprecated configuration names to a messages</span>
    131. 

  131. 

  132. <span class="sd">        These values are needed for validation, see :py:obj:`validate`.</span>
    133. 

  133. 

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

  135.         <span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span> <span class="o">=</span> <span class="n">cfg_schema</span>
    136. 

  136.         <span class="bp">self</span><span class="o">.</span><span class="n">deprecated</span> <span class="o">=</span> <span class="n">deprecated</span>
    137. 

  137.         <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">cfg_schema</span><span class="p">)</span>
    138. 

  138. 

  139.     <span class="k">def</span><span class="w"> </span><span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
    140. 

  140.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
    141. 

  141. 

  142. <div class="viewcode-block" id="Config.validate">
    143. 

  143. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.validate">[docs]</a>
    144. 

  144.     <span class="k">def</span><span class="w"> </span><span class="nf">validate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
    145. 

  145. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Validation of dictionary ``cfg`` on :py:obj:`Config.SCHEMA`.</span>
    146. 

  146. <span class="sd">        Validation is done by :py:obj:`validate`.&quot;&quot;&quot;</span>
    147. 

  147. 

  148.         <span class="k">return</span> <span class="n">validate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span><span class="p">,</span> <span class="n">cfg</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deprecated</span><span class="p">)</span></div>
    149. 

  149. 

  150. 

  151. <div class="viewcode-block" id="Config.update">
    152. 

  152. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.update">[docs]</a>
    153. 

  153.     <span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">upd_cfg</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
    154. 

  154. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Update this configuration by ``upd_cfg``.&quot;&quot;&quot;</span>
    155. 

  155. 

  156.         <span class="n">dict_deepupdate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">,</span> <span class="n">upd_cfg</span><span class="p">)</span></div>
    157. 

  157. 

  158. 

  159. <div class="viewcode-block" id="Config.default">
    160. 

  160. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.default">[docs]</a>
    161. 

  161.     <span class="k">def</span><span class="w"> </span><span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    162. 

  162. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns default value of field ``name`` in ``self.cfg_schema``.&quot;&quot;&quot;</span>
    163. 

  163.         <span class="k">return</span> <span class="n">value</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg_schema</span><span class="p">)</span></div>
    164. 

  164. 

  165. 

  166. <div class="viewcode-block" id="Config.get">
    167. 

  167. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.get">[docs]</a>
    168. 

  168.     <span class="k">def</span><span class="w"> </span><span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="n">UNSET</span><span class="p">,</span> <span class="n">replace</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
    169. 

  169. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the value to which ``name`` points in the configuration.</span>
    170. 

  170. 

  171. <span class="sd">        If there is no such ``name`` in the config and the ``default`` is</span>
    172. 

  172. <span class="sd">        :py:obj:`UNSET`, a :py:obj:`KeyError` is raised.</span>
    173. 

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

  174. 

  175.         <span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_parent_dict</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    176. 

  176.         <span class="n">val</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">UNSET</span><span class="p">)</span>
    177. 

  177.         <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
    178. 

  178.             <span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
    179. 

  179.                 <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    180. 

  180.             <span class="n">val</span> <span class="o">=</span> <span class="n">default</span>
    181. 

  181. 

  182.         <span class="k">if</span> <span class="n">replace</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
    183. 

  183.             <span class="n">val</span> <span class="o">=</span> <span class="n">val</span> <span class="o">%</span> <span class="bp">self</span>
    184. 

  184.         <span class="k">return</span> <span class="n">val</span></div>
    185. 

  185. 

  186. 

  187. <div class="viewcode-block" id="Config.set">
    188. 

  188. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.set">[docs]</a>
    189. 

  189.     <span class="k">def</span><span class="w"> </span><span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">val</span><span class="p">):</span>
    190. 

  190. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set the value to which ``name`` points in the configuration.</span>
    191. 

  191. 

  192. <span class="sd">        If there is no such ``name`` in the config, a :py:obj:`KeyError` is</span>
    193. 

  193. <span class="sd">        raised.</span>
    194. 

  194. <span class="sd">        &quot;&quot;&quot;</span>
    195. 

  195.         <span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_parent_dict</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    196. 

  196.         <span class="n">parent</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">val</span></div>
    197. 

  197. 

  198. 

  199.     <span class="k">def</span><span class="w"> </span><span class="nf">_get_parent_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
    200. 

  200.         <span class="n">parent_name</span> <span class="o">=</span> <span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
    201. 

  201.         <span class="k">if</span> <span class="n">parent_name</span><span class="p">:</span>
    202. 

  202.             <span class="n">parent</span> <span class="o">=</span> <span class="n">value</span><span class="p">(</span><span class="n">parent_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="p">)</span>
    203. 

  203.         <span class="k">else</span><span class="p">:</span>
    204. 

  204.             <span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span>
    205. 

  205.         <span class="k">if</span> <span class="p">(</span><span class="n">parent</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)):</span>
    206. 

  206.             <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">parent_name</span><span class="p">)</span>
    207. 

  207.         <span class="k">return</span> <span class="n">parent</span>
    208. 

  208. 

  209. <div class="viewcode-block" id="Config.path">
    210. 

  210. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.path">[docs]</a>
    211. 

  211.     <span class="k">def</span><span class="w"> </span><span class="nf">path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">UNSET</span><span class="p">):</span>
    212. 

  212. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Get a :py:class:`pathlib.Path` object from a config string.&quot;&quot;&quot;</span>
    213. 

  213. 

  214.         <span class="n">val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
    215. 

  215.         <span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
    216. 

  216.             <span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
    217. 

  217.                 <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    218. 

  218.             <span class="k">return</span> <span class="n">default</span>
    219. 

  219.         <span class="k">return</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">val</span><span class="p">))</span></div>
    220. 

  220. 

  221. 

  222. <div class="viewcode-block" id="Config.pyobj">
    223. 

  223. <a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.config.Config.pyobj">[docs]</a>
    224. 

  224.     <span class="k">def</span><span class="w"> </span><span class="nf">pyobj</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">UNSET</span><span class="p">):</span>
    225. 

  225. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Get python object referred by full qualiffied name (FQN) in the config</span>
    226. 

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

  227. 

  228.         <span class="n">fqn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
    229. 

  229.         <span class="k">if</span> <span class="n">fqn</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
    230. 

  230.             <span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
    231. 

  231.                 <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    232. 

  232.             <span class="k">return</span> <span class="n">default</span>
    233. 

  233.         <span class="p">(</span><span class="n">modulename</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">fqn</span><span class="p">)</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
    234. 

  234.         <span class="n">m</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">modulename</span><span class="p">,</span> <span class="p">{},</span> <span class="p">{},</span> <span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="mi">0</span><span class="p">)</span>
    235. 

  235.         <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span></div>
    236. 

  236. </div>
    237. 

  237. 

  238. 

  239. 

  240. <span class="k">def</span><span class="w"> </span><span class="nf">toml_load</span><span class="p">(</span><span class="n">file_name</span><span class="p">):</span>
    241. 

  241.     <span class="k">try</span><span class="p">:</span>
    242. 

  242.         <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
    243. 

  243.             <span class="k">return</span> <span class="n">tomllib</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
    244. 

  244.     <span class="k">except</span> <span class="n">tomllib</span><span class="o">.</span><span class="n">TOMLDecodeError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
    245. 

  245.         <span class="n">msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\t</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">,</span> <span class="s1">&#39; &#39;</span><span class="p">)</span>
    246. 

  246.         <span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
    247. 

  247.         <span class="k">raise</span>
    248. 

  248. 

  249. 

  250. <span class="c1"># working with dictionaries</span>
    251. 

  251. 

  252. 

  253. <span class="k">def</span><span class="w"> </span><span class="nf">value</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
    254. 

  254. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns the value to which ``name`` points in the ``dat_dict``.</span>
    255. 

  255. 

  256. <span class="sd">    .. code: python</span>
    257. 

  257. 

  258. <span class="sd">        &gt;&gt;&gt; data_dict = {</span>
    259. 

  259. <span class="sd">                &quot;foo&quot;: {&quot;bar&quot;: 1 },</span>
    260. 

  260. <span class="sd">                &quot;bar&quot;: {&quot;foo&quot;: 2 },</span>
    261. 

  261. <span class="sd">                &quot;foobar&quot;: [1, 2, 3],</span>
    262. 

  262. <span class="sd">            }</span>
    263. 

  263. <span class="sd">        &gt;&gt;&gt; value(&#39;foobar&#39;, data_dict)</span>
    264. 

  264. <span class="sd">        [1, 2, 3]</span>
    265. 

  265. <span class="sd">        &gt;&gt;&gt; value(&#39;foo.bar&#39;, data_dict)</span>
    266. 

  266. <span class="sd">        1</span>
    267. 

  267. <span class="sd">        &gt;&gt;&gt; value(&#39;foo.bar.xxx&#39;, data_dict)</span>
    268. 

  268. <span class="sd">        &lt;UNSET&gt;</span>
    269. 

  269. 

  270. <span class="sd">    &quot;&quot;&quot;</span>
    271. 

  271. 

  272.     <span class="n">ret_val</span> <span class="o">=</span> <span class="n">data_dict</span>
    273. 

  273.     <span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">):</span>
    274. 

  274.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ret_val</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    275. 

  275.             <span class="n">ret_val</span> <span class="o">=</span> <span class="n">ret_val</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">part</span><span class="p">,</span> <span class="n">UNSET</span><span class="p">)</span>
    276. 

  276.         <span class="k">if</span> <span class="n">ret_val</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
    277. 

  277.             <span class="k">break</span>
    278. 

  278.     <span class="k">return</span> <span class="n">ret_val</span>
    279. 

  279. 

  280. 

  281. <span class="k">def</span><span class="w"> </span><span class="nf">validate</span><span class="p">(</span>
    282. 

  282.     <span class="n">schema_dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>
    283. 

  283. <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">list</span><span class="p">]:</span>
    284. 

  284. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Deep validation of dictionary in ``data_dict`` against dictionary in</span>
    285. 

  285. <span class="sd">    ``schema_dict``.  Argument deprecated is a dictionary that maps deprecated</span>
    286. 

  286. <span class="sd">    configuration names to a messages::</span>
    287. 

  287. 

  288. <span class="sd">        deprecated = {</span>
    289. 

  289. <span class="sd">            &quot;foo.bar&quot; : &quot;config &#39;foo.bar&#39; is deprecated, use &#39;bar.foo&#39;&quot;,</span>
    290. 

  290. <span class="sd">            &quot;...&quot;     : &quot;...&quot;</span>
    291. 

  291. <span class="sd">        }</span>
    292. 

  292. 

  293. <span class="sd">    The function returns a python tuple ``(is_valid, issue_list)``:</span>
    294. 

  294. 

  295. <span class="sd">    ``is_valid``:</span>
    296. 

  296. <span class="sd">      A bool value indicating ``data_dict`` is valid or not.</span>
    297. 

  297. 

  298. <span class="sd">    ``issue_list``:</span>
    299. 

  299. <span class="sd">      A list of messages (:py:obj:`SchemaIssue`) from the validation::</span>
    300. 

  300. 

  301. <span class="sd">          [schema warn] data_dict: deprecated &#39;fontlib.foo&#39;: &lt;DEPRECATED[&#39;foo.bar&#39;]&gt;</span>
    302. 

  302. <span class="sd">          [schema invalid] data_dict: key unknown &#39;fontlib.foo&#39;</span>
    303. 

  303. <span class="sd">          [schema invalid] data_dict: type mismatch &#39;fontlib.foo&#39;: expected ..., is ...</span>
    304. 

  304. 

  305. <span class="sd">    If ``schema_dict`` or ``data_dict`` is not a dictionary type a</span>
    306. 

  306. <span class="sd">    :py:obj:`SchemaIssue` is raised.</span>
    307. 

  307. 

  308. <span class="sd">    &quot;&quot;&quot;</span>
    309. 

  309.     <span class="n">names</span> <span class="o">=</span> <span class="p">[]</span>
    310. 

  310.     <span class="n">is_valid</span> <span class="o">=</span> <span class="kc">True</span>
    311. 

  311.     <span class="n">issue_list</span> <span class="o">=</span> <span class="p">[]</span>
    312. 

  312. 

  313.     <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">schema_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    314. 

  314.         <span class="k">raise</span> <span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">&#39;invalid&#39;</span><span class="p">,</span> <span class="s2">&quot;schema_dict is not a dict type&quot;</span><span class="p">)</span>
    315. 

  315.     <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    316. 

  316.         <span class="k">raise</span> <span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">&#39;invalid&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;data_dict issue</span><span class="si">{</span><span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2"> is not a dict type&quot;</span><span class="p">)</span>
    317. 

  317. 

  318.     <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span> <span class="o">=</span> <span class="n">_validate</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">issue_list</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">,</span> <span class="n">data_dict</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">)</span>
    319. 

  319.     <span class="k">return</span> <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span>
    320. 

  320. 

  321. 

  322. <span class="k">def</span><span class="w"> </span><span class="nf">_validate</span><span class="p">(</span>
    323. 

  323.     <span class="n">names</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">,</span>
    324. 

  324.     <span class="n">issue_list</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">,</span>
    325. 

  325.     <span class="n">schema_dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span>
    326. 

  326.     <span class="n">data_dict</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">,</span>
    327. 

  327.     <span class="n">deprecated</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span>
    328. 

  328. <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">]:</span>
    329. 

  329. 

  330.     <span class="n">is_valid</span> <span class="o">=</span> <span class="kc">True</span>
    331. 

  331. 

  332.     <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">data_value</span> <span class="ow">in</span> <span class="n">data_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    333. 

  333. 

  334.         <span class="n">names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
    335. 

  335.         <span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span>
    336. 

  336. 

  337.         <span class="n">deprecated_msg</span> <span class="o">=</span> <span class="n">deprecated</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    338. 

  338.         <span class="c1"># print(&quot;XXX %s: key %s //   data_value: %s&quot; % (name, key, data_value))</span>
    339. 

  339.         <span class="k">if</span> <span class="n">deprecated_msg</span><span class="p">:</span>
    340. 

  340.             <span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">&#39;warn&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;data_dict &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39;: deprecated - </span><span class="si">{</span><span class="n">deprecated_msg</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">))</span>
    341. 

  341. 

  342.         <span class="n">schema_value</span> <span class="o">=</span> <span class="n">value</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">)</span>
    343. 

  343.         <span class="c1"># print(&quot;YYY %s: key %s // schema_value: %s&quot; % (name, key, schema_value))</span>
    344. 

  344.         <span class="k">if</span> <span class="n">schema_value</span> <span class="ow">is</span> <span class="n">UNSET</span><span class="p">:</span>
    345. 

  345.             <span class="k">if</span> <span class="ow">not</span> <span class="n">deprecated_msg</span><span class="p">:</span>
    346. 

  346.                 <span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">SchemaIssue</span><span class="p">(</span><span class="s1">&#39;invalid&#39;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;data_dict &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39;: key unknown in schema_dict&quot;</span><span class="p">))</span>
    347. 

  347.                 <span class="n">is_valid</span> <span class="o">=</span> <span class="kc">False</span>
    348. 

  348. 

  349.         <span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">schema_value</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">type</span><span class="p">(</span><span class="n">data_value</span><span class="p">):</span>  <span class="c1"># pylint: disable=unidiomatic-typecheck</span>
    350. 

  350.             <span class="n">issue_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
    351. 

  351.                 <span class="n">SchemaIssue</span><span class="p">(</span>
    352. 

  352.                     <span class="s1">&#39;invalid&#39;</span><span class="p">,</span>
    353. 

  353.                     <span class="p">(</span><span class="sa">f</span><span class="s2">&quot;data_dict: type mismatch &#39;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39;:&quot;</span> <span class="sa">f</span><span class="s2">&quot; expected </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">schema_value</span><span class="p">)</span><span class="si">}</span><span class="s2">, is: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">data_value</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">),</span>
    354. 

  354.                 <span class="p">)</span>
    355. 

  355.             <span class="p">)</span>
    356. 

  356.             <span class="n">is_valid</span> <span class="o">=</span> <span class="kc">False</span>
    357. 

  357. 

  358.         <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data_value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    359. 

  359.             <span class="n">_valid</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_validate</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">issue_list</span><span class="p">,</span> <span class="n">schema_dict</span><span class="p">,</span> <span class="n">data_value</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">)</span>
    360. 

  360.             <span class="n">is_valid</span> <span class="o">=</span> <span class="n">is_valid</span> <span class="ow">and</span> <span class="n">_valid</span>
    361. 

  361.         <span class="n">names</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
    362. 

  362. 

  363.     <span class="k">return</span> <span class="n">is_valid</span><span class="p">,</span> <span class="n">issue_list</span>
    364. 

  364. 

  365. 

  366. <span class="k">def</span><span class="w"> </span><span class="nf">dict_deepupdate</span><span class="p">(</span><span class="n">base_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">upd_dict</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">names</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    367. 

  367. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Deep-update of dictionary in ``base_dict`` by dictionary in ``upd_dict``.</span>
    368. 

  368. 

  369. <span class="sd">    For each ``upd_key`` &amp; ``upd_val`` pair in ``upd_dict``:</span>
    370. 

  370. 

  371. <span class="sd">    0. If types of ``base_dict[upd_key]`` and ``upd_val`` do not match raise a</span>
    372. 

  372. <span class="sd">       :py:obj:`TypeError`.</span>
    373. 

  373. 

  374. <span class="sd">    1. If ``base_dict[upd_key]`` is a dict: recursively deep-update it by ``upd_val``.</span>
    375. 

  375. 

  376. <span class="sd">    2. If ``base_dict[upd_key]`` not exist: set ``base_dict[upd_key]`` from a</span>
    377. 

  377. <span class="sd">       (deep-) copy of ``upd_val``.</span>
    378. 

  378. 

  379. <span class="sd">    3. If ``upd_val`` is a list, extend list in ``base_dict[upd_key]`` by the</span>
    380. 

  380. <span class="sd">       list in ``upd_val``.</span>
    381. 

  381. 

  382. <span class="sd">    4. If ``upd_val`` is a set, update set in ``base_dict[upd_key]`` by set in</span>
    383. 

  383. <span class="sd">       ``upd_val``.</span>
    384. 

  384. <span class="sd">    &quot;&quot;&quot;</span>
    385. 

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

  386.     <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    387. 

  387.         <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;argument &#39;base_dict&#39; is not a ditionary type&quot;</span><span class="p">)</span>
    388. 

  388.     <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    389. 

  389.         <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;argument &#39;upd_dict&#39; is not a ditionary type&quot;</span><span class="p">)</span>
    390. 

  390. 

  391.     <span class="k">if</span> <span class="n">names</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    392. 

  392.         <span class="n">names</span> <span class="o">=</span> <span class="p">[]</span>
    393. 

  393. 

  394.     <span class="k">for</span> <span class="n">upd_key</span><span class="p">,</span> <span class="n">upd_val</span> <span class="ow">in</span> <span class="n">upd_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    395. 

  395.         <span class="c1"># For each upd_key &amp; upd_val pair in upd_dict:</span>
    396. 

  396. 

  397.         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
    398. 

  398. 

  399.             <span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
    400. 

  400.                 <span class="c1"># if base_dict[upd_key] exists, recursively deep-update it</span>
    401. 

  401.                 <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">dict</span><span class="p">):</span>
    402. 

  402.                     <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;type mismatch </span><span class="si">{</span><span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a dict type in base_dict&quot;</span><span class="p">)</span>
    403. 

  403.                 <span class="n">dict_deepupdate</span><span class="p">(</span>
    404. 

  404.                     <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span>
    405. 

  405.                     <span class="n">upd_val</span><span class="p">,</span>
    406. 

  406.                     <span class="n">names</span>
    407. 

  407.                     <span class="o">+</span> <span class="p">[</span>
    408. 

  408.                         <span class="n">upd_key</span><span class="p">,</span>
    409. 

  409.                     <span class="p">],</span>
    410. 

  410.                 <span class="p">)</span>
    411. 

  411. 

  412.             <span class="k">else</span><span class="p">:</span>
    413. 

  413.                 <span class="c1"># if base_dict[upd_key] not exist, set base_dict[upd_key] from deepcopy of upd_val</span>
    414. 

  414.                 <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
    415. 

  415. 

  416.         <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
    417. 

  417. 

  418.             <span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
    419. 

  419.                 <span class="c1"># if base_dict[upd_key] exists, base_dict[up_key] is extended by</span>
    420. 

  420.                 <span class="c1"># the list from upd_val</span>
    421. 

  421.                 <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">list</span><span class="p">):</span>
    422. 

  422.                     <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;type mismatch </span><span class="si">{</span><span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a list type in base_dict&quot;</span><span class="p">)</span>
    423. 

  423.                 <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
    424. 

  424. 

  425.             <span class="k">else</span><span class="p">:</span>
    426. 

  426.                 <span class="c1"># if base_dict[upd_key] doesn&#39;t exists, set base_dict[key] from a deepcopy of the</span>
    427. 

  427.                 <span class="c1"># list in upd_val.</span>
    428. 

  428.                 <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
    429. 

  429. 

  430.         <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">upd_val</span><span class="p">,</span> <span class="nb">set</span><span class="p">):</span>
    431. 

  431. 

  432.             <span class="k">if</span> <span class="n">upd_key</span> <span class="ow">in</span> <span class="n">base_dict</span><span class="p">:</span>
    433. 

  433.                 <span class="c1"># if base_dict[upd_key] exists, base_dict[up_key] is updated by the set in upd_val</span>
    434. 

  434.                 <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">],</span> <span class="nb">set</span><span class="p">):</span>
    435. 

  435.                     <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;type mismatch </span><span class="si">{</span><span class="s1">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">names</span><span class="p">)</span><span class="si">}</span><span class="s2">: is not a set type in base_dict&quot;</span><span class="p">)</span>
    436. 

  436.                 <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">upd_val</span><span class="o">.</span><span class="n">copy</span><span class="p">())</span>
    437. 

  437. 

  438.             <span class="k">else</span><span class="p">:</span>
    439. 

  439.                 <span class="c1"># if base_dict[upd_key] doesn&#39;t exists, set base_dict[upd_key] from a copy of the</span>
    440. 

  440.                 <span class="c1"># set in upd_val</span>
    441. 

  441.                 <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">upd_val</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
    442. 

  442. 

  443.         <span class="k">else</span><span class="p">:</span>
    444. 

  444.             <span class="c1"># for any other type of upd_val replace or add base_dict[upd_key] by a copy</span>
    445. 

  445.             <span class="c1"># of upd_val</span>
    446. 

  446.             <span class="n">base_dict</span><span class="p">[</span><span class="n">upd_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">upd_val</span><span class="p">)</span>
    447. 

  447. </pre></div>
    448. 

  448. 

  449.             <div class="clearer"></div>
    450. 

  450.           </div>
    451. 

  451.         </div>
    452. 

  452.       </div>
    453. 

  453.   <span id="sidebar-top"></span>
    454. 

  454.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    455. 

  455.         <div class="sphinxsidebarwrapper">
    456. 

  456.   
    457. 

  457.     
    458. 

  458.             <p class="logo"><a href="../../../index.html">
    459. 

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

  460.             </a></p>
    461. 

  461.   
    462. 

  462. 

  463. <h3><a href="../../../index.html">Table of Contents</a></h3>
    464. 

  464. <ul>
    465. 

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

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

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

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

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

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

  471. </ul>
    472. 

  472. 

  473.   <h3>Project Links</h3>
    474. 

  474.   <ul>
    475. 

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

  476.   
    477. 

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

  478.   
    479. 

  479.     <li><a href="https://searx.space">Public instances</a>
    480. 

  480.   
    481. 

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

  482.   </ul><h3>Navigation</h3>
    483. 

  483. <ul>
    484. 

  484.   <li><a href="../../../index.html">Overview</a>
    485. 

  485.     <ul>
    486. 

  486.       <li><a href="../../index.html">Module code</a>
    487. 

  487.         
    488. 

  488.           
    489. 

  489.           </ul>
    490. 

  490.       </li>
    491. 

  491.     </ul>
    492. 

  492.   </li>
    493. 

  493. </ul>
    494. 

  494. <search id="searchbox" style="display: none" role="search">
    495. 

  495.   <h3 id="searchlabel">Quick search</h3>
    496. 

  496.     <div class="searchformwrapper">
    497. 

  497.     <form class="search" action="../../../search.html" method="get">
    498. 

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

  499.       <input type="submit" value="Go" />
    500. 

  500.     </form>
    501. 

  501.     </div>
    502. 

  502. </search>
    503. 

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

  504.         </div>
    505. 

  505.       </div>
    506. 

  506.       <div class="clearer"></div>
    507. 

  507.     </div>
    508. 

  508.     <div class="footer" role="contentinfo">
    509. 

  509.     &#169; Copyright SearXNG team.
    510. 

  510.     </div>
    511. 

  511.   </body>
    512. 

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