models.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../../../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>searx.search.models &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
  9. <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
  10. <script src="../../../_static/documentation_options.js?v=b12b0e12"></script>
  11. <script src="../../../_static/doctools.js?v=9a2dae69"></script>
  12. <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
  13. <script data-project="searxng" data-version="2025.4.30+fd33559cf" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
  14. <link rel="index" title="Index" href="../../../genindex.html" />
  15. <link rel="search" title="Search" href="../../../search.html" />
  16. </head><body>
  17. <div class="related" role="navigation" aria-label="Related">
  18. <h3>Navigation</h3>
  19. <ul>
  20. <li class="right" style="margin-right: 10px">
  21. <a href="../../../genindex.html" title="General Index"
  22. accesskey="I">index</a></li>
  23. <li class="right" >
  24. <a href="../../../py-modindex.html" title="Python Module Index"
  25. >modules</a> |</li>
  26. <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
  27. <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
  28. <li class="nav-item nav-item-2"><a href="../search.html" accesskey="U">searx.search</a> &#187;</li>
  29. <li class="nav-item nav-item-this"><a href="">searx.search.models</a></li>
  30. </ul>
  31. </div>
  32. <div class="document">
  33. <div class="documentwrapper">
  34. <div class="bodywrapper">
  35. <div class="body" role="main">
  36. <h1>Source code for searx.search.models</h1><div class="highlight"><pre>
  37. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
  38. <span class="c1"># pylint: disable=missing-module-docstring</span>
  39. <span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
  40. <span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
  41. <div class="viewcode-block" id="EngineRef">
  42. <a class="viewcode-back" href="../../../src/searx.search.html#searx.search.EngineRef">[docs]</a>
  43. <span class="k">class</span><span class="w"> </span><span class="nc">EngineRef</span><span class="p">:</span>
  44. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Reference by names to an engine and category&quot;&quot;&quot;</span>
  45. <span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="s1">&#39;category&#39;</span>
  46. <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">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">category</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
  47. <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
  48. <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="n">category</span>
  49. <span class="k">def</span><span class="w"> </span><span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  50. <span class="k">return</span> <span class="s2">&quot;EngineRef(</span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">)&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">category</span><span class="p">)</span>
  51. <span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
  52. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">name</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">category</span>
  53. <span class="k">def</span><span class="w"> </span><span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  54. <span class="k">return</span> <span class="nb">hash</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">category</span><span class="p">))</span></div>
  55. <div class="viewcode-block" id="SearchQuery">
  56. <a class="viewcode-back" href="../../../src/searx.search.html#searx.search.SearchQuery">[docs]</a>
  57. <span class="k">class</span><span class="w"> </span><span class="nc">SearchQuery</span><span class="p">:</span>
  58. <span class="w"> </span><span class="sd">&quot;&quot;&quot;container for all the search parameters (query, language, etc...)&quot;&quot;&quot;</span>
  59. <span class="vm">__slots__</span> <span class="o">=</span> <span class="p">(</span>
  60. <span class="s1">&#39;query&#39;</span><span class="p">,</span>
  61. <span class="s1">&#39;engineref_list&#39;</span><span class="p">,</span>
  62. <span class="s1">&#39;lang&#39;</span><span class="p">,</span>
  63. <span class="s1">&#39;locale&#39;</span><span class="p">,</span>
  64. <span class="s1">&#39;safesearch&#39;</span><span class="p">,</span>
  65. <span class="s1">&#39;pageno&#39;</span><span class="p">,</span>
  66. <span class="s1">&#39;time_range&#39;</span><span class="p">,</span>
  67. <span class="s1">&#39;timeout_limit&#39;</span><span class="p">,</span>
  68. <span class="s1">&#39;external_bang&#39;</span><span class="p">,</span>
  69. <span class="s1">&#39;engine_data&#39;</span><span class="p">,</span>
  70. <span class="s1">&#39;redirect_to_first_result&#39;</span><span class="p">,</span>
  71. <span class="p">)</span>
  72. <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
  73. <span class="bp">self</span><span class="p">,</span>
  74. <span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
  75. <span class="n">engineref_list</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">EngineRef</span><span class="p">],</span>
  76. <span class="n">lang</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;all&#39;</span><span class="p">,</span>
  77. <span class="n">safesearch</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
  78. <span class="n">pageno</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
  79. <span class="n">time_range</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  80. <span class="n">timeout_limit</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  81. <span class="n">external_bang</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  82. <span class="n">engine_data</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</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> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  83. <span class="n">redirect_to_first_result</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  84. <span class="p">):</span> <span class="c1"># pylint:disable=too-many-arguments</span>
  85. <span class="bp">self</span><span class="o">.</span><span class="n">query</span> <span class="o">=</span> <span class="n">query</span>
  86. <span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span> <span class="o">=</span> <span class="n">engineref_list</span>
  87. <span class="bp">self</span><span class="o">.</span><span class="n">lang</span> <span class="o">=</span> <span class="n">lang</span>
  88. <span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span> <span class="o">=</span> <span class="n">safesearch</span>
  89. <span class="bp">self</span><span class="o">.</span><span class="n">pageno</span> <span class="o">=</span> <span class="n">pageno</span>
  90. <span class="bp">self</span><span class="o">.</span><span class="n">time_range</span> <span class="o">=</span> <span class="n">time_range</span>
  91. <span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span> <span class="o">=</span> <span class="n">timeout_limit</span>
  92. <span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span> <span class="o">=</span> <span class="n">external_bang</span>
  93. <span class="bp">self</span><span class="o">.</span><span class="n">engine_data</span> <span class="o">=</span> <span class="n">engine_data</span> <span class="ow">or</span> <span class="p">{}</span>
  94. <span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span> <span class="o">=</span> <span class="n">redirect_to_first_result</span>
  95. <span class="bp">self</span><span class="o">.</span><span class="n">locale</span> <span class="o">=</span> <span class="kc">None</span>
  96. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">:</span>
  97. <span class="k">try</span><span class="p">:</span>
  98. <span class="bp">self</span><span class="o">.</span><span class="n">locale</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
  99. <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
  100. <span class="k">pass</span>
  101. <span class="nd">@property</span>
  102. <span class="k">def</span><span class="w"> </span><span class="nf">categories</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  103. <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">engineref</span><span class="p">:</span> <span class="n">engineref</span><span class="o">.</span><span class="n">category</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">)))</span>
  104. <span class="k">def</span><span class="w"> </span><span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  105. <span class="k">return</span> <span class="s2">&quot;SearchQuery(</span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">)&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
  106. <span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span>
  107. <span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">,</span>
  108. <span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span>
  109. <span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span><span class="p">,</span>
  110. <span class="bp">self</span><span class="o">.</span><span class="n">pageno</span><span class="p">,</span>
  111. <span class="bp">self</span><span class="o">.</span><span class="n">time_range</span><span class="p">,</span>
  112. <span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span><span class="p">,</span>
  113. <span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span><span class="p">,</span>
  114. <span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span><span class="p">,</span>
  115. <span class="p">)</span>
  116. <span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
  117. <span class="k">return</span> <span class="p">(</span>
  118. <span class="bp">self</span><span class="o">.</span><span class="n">query</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">query</span>
  119. <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">engineref_list</span>
  120. <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">lang</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">lang</span>
  121. <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">safesearch</span>
  122. <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">pageno</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">pageno</span>
  123. <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_range</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">time_range</span>
  124. <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">timeout_limit</span>
  125. <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">external_bang</span>
  126. <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">redirect_to_first_result</span>
  127. <span class="p">)</span>
  128. <span class="k">def</span><span class="w"> </span><span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  129. <span class="k">return</span> <span class="nb">hash</span><span class="p">(</span>
  130. <span class="p">(</span>
  131. <span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span>
  132. <span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">),</span>
  133. <span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span>
  134. <span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span><span class="p">,</span>
  135. <span class="bp">self</span><span class="o">.</span><span class="n">pageno</span><span class="p">,</span>
  136. <span class="bp">self</span><span class="o">.</span><span class="n">time_range</span><span class="p">,</span>
  137. <span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span><span class="p">,</span>
  138. <span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span><span class="p">,</span>
  139. <span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span><span class="p">,</span>
  140. <span class="p">)</span>
  141. <span class="p">)</span>
  142. <span class="k">def</span><span class="w"> </span><span class="nf">__copy__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  143. <span class="k">return</span> <span class="n">SearchQuery</span><span class="p">(</span>
  144. <span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span>
  145. <span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">,</span>
  146. <span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span>
  147. <span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span><span class="p">,</span>
  148. <span class="bp">self</span><span class="o">.</span><span class="n">pageno</span><span class="p">,</span>
  149. <span class="bp">self</span><span class="o">.</span><span class="n">time_range</span><span class="p">,</span>
  150. <span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span><span class="p">,</span>
  151. <span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span><span class="p">,</span>
  152. <span class="bp">self</span><span class="o">.</span><span class="n">engine_data</span><span class="p">,</span>
  153. <span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span><span class="p">,</span>
  154. <span class="p">)</span></div>
  155. </pre></div>
  156. <div class="clearer"></div>
  157. </div>
  158. </div>
  159. </div>
  160. <span id="sidebar-top"></span>
  161. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  162. <div class="sphinxsidebarwrapper">
  163. <p class="logo"><a href="../../../index.html">
  164. <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  165. </a></p>
  166. <h3><a href="../../../index.html">Table of Contents</a></h3>
  167. <ul>
  168. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
  169. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
  170. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
  171. <li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
  172. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
  173. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
  174. </ul>
  175. <h3>Project Links</h3>
  176. <ul>
  177. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  178. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  179. <li><a href="https://searx.space">Public instances</a>
  180. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  181. </ul><h3>Navigation</h3>
  182. <ul>
  183. <li><a href="../../../index.html">Overview</a>
  184. <ul>
  185. <li><a href="../../index.html">Module code</a>
  186. <ul>
  187. <li><a href="../search.html">searx.search</a>
  188. </ul>
  189. </li></ul>
  190. </li>
  191. </ul>
  192. </li>
  193. </ul>
  194. <search id="searchbox" style="display: none" role="search">
  195. <h3 id="searchlabel">Quick search</h3>
  196. <div class="searchformwrapper">
  197. <form class="search" action="../../../search.html" method="get">
  198. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  199. <input type="submit" value="Go" />
  200. </form>
  201. </div>
  202. </search>
  203. <script>document.getElementById('searchbox').style.display = "block"</script>
  204. </div>
  205. </div>
  206. <div class="clearer"></div>
  207. </div>
  208. <div class="footer" role="contentinfo">
  209. &#169; Copyright SearXNG team.
  210. </div>
  211. </body>
  212. </html>