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
/
engines
/
xpath.html

xpath.html 34 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447 
  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.engines.xpath &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
    9. 

  9.     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
    11. 

  11.     <script src="../../../_static/documentation_options.js?v=b12b0e12"></script>
    12. 

  12.     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
    13. 

  13.     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
    14. 

  14.     <script data-project="searxng" data-version="2025.4.30+fd33559cf" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
    15. 

  15.     <link rel="index" title="Index" href="../../../genindex.html" />
    16. 

  16.     <link rel="search" title="Search" href="../../../search.html" /> 
    17. 

  17.   </head><body>
    18. 

  18.     <div class="related" role="navigation" aria-label="Related">
    19. 

  19.       <h3>Navigation</h3>
    20. 

  20.       <ul>
    21. 

  21.         <li class="right" style="margin-right: 10px">
    22. 

  22.           <a href="../../../genindex.html" title="General Index"
    23. 

  23.              accesskey="I">index</a></li>
    24. 

  24.         <li class="right" >
    25. 

  25.           <a href="../../../py-modindex.html" title="Python Module Index"
    26. 

  26.              >modules</a> |</li>
    27. 

  27.         <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
    28. 

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

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

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

  31.       </ul>
    32. 

  32.     </div>  
    33. 

  33. 

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

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

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

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

  38.             
    39. 

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

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

  41. <span class="sd">&quot;&quot;&quot;The XPath engine is a *generic* engine with which it is possible to configure</span>
    42. 

  42. <span class="sd">engines in the settings.</span>
    43. 

  43. 

  44. <span class="sd">.. _XPath selector: https://quickref.me/xpath.html#xpath-selectors</span>
    45. 

  45. 

  46. <span class="sd">Configuration</span>
    47. 

  47. <span class="sd">=============</span>
    48. 

  48. 

  49. <span class="sd">Request:</span>
    50. 

  50. 

  51. <span class="sd">- :py:obj:`search_url`</span>
    52. 

  52. <span class="sd">- :py:obj:`lang_all`</span>
    53. 

  53. <span class="sd">- :py:obj:`soft_max_redirects`</span>
    54. 

  54. <span class="sd">- :py:obj:`method`</span>
    55. 

  55. <span class="sd">- :py:obj:`request_body`</span>
    56. 

  56. <span class="sd">- :py:obj:`cookies`</span>
    57. 

  57. <span class="sd">- :py:obj:`headers`</span>
    58. 

  58. 

  59. <span class="sd">Paging:</span>
    60. 

  60. 

  61. <span class="sd">- :py:obj:`paging`</span>
    62. 

  62. <span class="sd">- :py:obj:`page_size`</span>
    63. 

  63. <span class="sd">- :py:obj:`first_page_num`</span>
    64. 

  64. 

  65. <span class="sd">Time Range:</span>
    66. 

  66. 

  67. <span class="sd">- :py:obj:`time_range_support`</span>
    68. 

  68. <span class="sd">- :py:obj:`time_range_url`</span>
    69. 

  69. <span class="sd">- :py:obj:`time_range_map`</span>
    70. 

  70. 

  71. <span class="sd">Safe-Search:</span>
    72. 

  72. 

  73. <span class="sd">- :py:obj:`safe_search_support`</span>
    74. 

  74. <span class="sd">- :py:obj:`safe_search_map`</span>
    75. 

  75. 

  76. <span class="sd">Response:</span>
    77. 

  77. 

  78. <span class="sd">- :py:obj:`no_result_for_http_status`</span>
    79. 

  79. 

  80. <span class="sd">`XPath selector`_:</span>
    81. 

  81. 

  82. <span class="sd">- :py:obj:`results_xpath`</span>
    83. 

  83. <span class="sd">- :py:obj:`url_xpath`</span>
    84. 

  84. <span class="sd">- :py:obj:`title_xpath`</span>
    85. 

  85. <span class="sd">- :py:obj:`content_xpath`</span>
    86. 

  86. <span class="sd">- :py:obj:`thumbnail_xpath`</span>
    87. 

  87. <span class="sd">- :py:obj:`suggestion_xpath`</span>
    88. 

  88. 

  89. 

  90. <span class="sd">Example</span>
    91. 

  91. <span class="sd">=======</span>
    92. 

  92. 

  93. <span class="sd">Here is a simple example of a XPath engine configured in the :ref:`settings</span>
    94. 

  94. <span class="sd">engines` section, further read :ref:`engines-dev`.</span>
    95. 

  95. 

  96. <span class="sd">.. code:: yaml</span>
    97. 

  97. 

  98. <span class="sd">  - name : bitbucket</span>
    99. 

  99. <span class="sd">    engine : xpath</span>
    100. 

  100. <span class="sd">    paging : True</span>
    101. 

  101. <span class="sd">    search_url : https://bitbucket.org/repo/all/{pageno}?name={query}</span>
    102. 

  102. <span class="sd">    url_xpath : //article[@class=&quot;repo-summary&quot;]//a[@class=&quot;repo-link&quot;]/@href</span>
    103. 

  103. <span class="sd">    title_xpath : //article[@class=&quot;repo-summary&quot;]//a[@class=&quot;repo-link&quot;]</span>
    104. 

  104. <span class="sd">    content_xpath : //article[@class=&quot;repo-summary&quot;]/p</span>
    105. 

  105. 

  106. <span class="sd">Implementations</span>
    107. 

  107. <span class="sd">===============</span>
    108. 

  108. 

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

  110. 

  111. <span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
    112. 

  112. 

  113. <span class="kn">from</span><span class="w"> </span><span class="nn">lxml</span><span class="w"> </span><span class="kn">import</span> <span class="n">html</span>
    114. 

  114. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">extract_text</span><span class="p">,</span> <span class="n">extract_url</span><span class="p">,</span> <span class="n">eval_xpath</span><span class="p">,</span> <span class="n">eval_xpath_list</span>
    115. 

  115. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">raise_for_httperror</span>
    116. 

  116. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineResults</span>
    117. 

  117. 

  118. <span class="n">search_url</span> <span class="o">=</span> <span class="kc">None</span>
    119. 

  119. <span class="sd">&quot;&quot;&quot;</span>
    120. 

  120. <span class="sd">Search URL of the engine.  Example::</span>
    121. 

  121. 

  122. <span class="sd">    https://example.org/?search={query}&amp;page={pageno}{time_range}{safe_search}</span>
    123. 

  123. 

  124. <span class="sd">Replacements are:</span>
    125. 

  125. 

  126. <span class="sd">``{query}``:</span>
    127. 

  127. <span class="sd">  Search terms from user.</span>
    128. 

  128. 

  129. <span class="sd">``{pageno}``:</span>
    130. 

  130. <span class="sd">  Page number if engine supports paging :py:obj:`paging`</span>
    131. 

  131. 

  132. <span class="sd">``{lang}``:</span>
    133. 

  133. <span class="sd">  ISO 639-1 language code (en, de, fr ..)</span>
    134. 

  134. 

  135. <span class="sd">``{time_range}``:</span>
    136. 

  136. <span class="sd">  :py:obj:`URL parameter &lt;time_range_url&gt;` if engine :py:obj:`supports time</span>
    137. 

  137. <span class="sd">  range &lt;time_range_support&gt;`.  The value for the parameter is taken from</span>
    138. 

  138. <span class="sd">  :py:obj:`time_range_map`.</span>
    139. 

  139. 

  140. <span class="sd">``{safe_search}``:</span>
    141. 

  141. <span class="sd">  Safe-search :py:obj:`URL parameter &lt;safe_search_map&gt;` if engine</span>
    142. 

  142. <span class="sd">  :py:obj:`supports safe-search &lt;safe_search_support&gt;`.  The ``{safe_search}``</span>
    143. 

  143. <span class="sd">  replacement is taken from the :py:obj:`safes_search_map`.  Filter results::</span>
    144. 

  144. 

  145. <span class="sd">      0: none, 1: moderate, 2:strict</span>
    146. 

  146. 

  147. <span class="sd">  If not supported, the URL parameter is an empty string.</span>
    148. 

  148. 

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

  150. 

  151. <span class="n">lang_all</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
    152. 

  152. <span class="sd">&#39;&#39;&#39;Replacement ``{lang}`` in :py:obj:`search_url` if language ``all`` is</span>
    153. 

  153. <span class="sd">selected.</span>
    154. 

  154. <span class="sd">&#39;&#39;&#39;</span>
    155. 

  155. 

  156. <span class="n">no_result_for_http_status</span> <span class="o">=</span> <span class="p">[]</span>
    157. 

  157. <span class="sd">&#39;&#39;&#39;Return empty result for these HTTP status codes instead of throwing an error.</span>
    158. 

  158. 

  159. <span class="sd">.. code:: yaml</span>
    160. 

  160. 

  161. <span class="sd">    no_result_for_http_status: []</span>
    162. 

  162. <span class="sd">&#39;&#39;&#39;</span>
    163. 

  163. 

  164. <span class="n">soft_max_redirects</span> <span class="o">=</span> <span class="mi">0</span>
    165. 

  165. <span class="sd">&#39;&#39;&#39;Maximum redirects, soft limit. Record an error but don&#39;t stop the engine&#39;&#39;&#39;</span>
    166. 

  166. 

  167. <span class="n">results_xpath</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    168. 

  168. <span class="sd">&#39;&#39;&#39;`XPath selector`_ for the list of result items&#39;&#39;&#39;</span>
    169. 

  169. 

  170. <span class="n">url_xpath</span> <span class="o">=</span> <span class="kc">None</span>
    171. 

  171. <span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``url``.&#39;&#39;&#39;</span>
    172. 

  172. 

  173. <span class="n">content_xpath</span> <span class="o">=</span> <span class="kc">None</span>
    174. 

  174. <span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``content``.&#39;&#39;&#39;</span>
    175. 

  175. 

  176. <span class="n">title_xpath</span> <span class="o">=</span> <span class="kc">None</span>
    177. 

  177. <span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``title``.&#39;&#39;&#39;</span>
    178. 

  178. 

  179. <span class="n">thumbnail_xpath</span> <span class="o">=</span> <span class="kc">False</span>
    180. 

  180. <span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``thumbnail``.&#39;&#39;&#39;</span>
    181. 

  181. 

  182. <span class="n">suggestion_xpath</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    183. 

  183. <span class="sd">&#39;&#39;&#39;`XPath selector`_ of result&#39;s ``suggestion``.&#39;&#39;&#39;</span>
    184. 

  184. 

  185. <span class="n">cached_xpath</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    186. 

  186. <span class="n">cached_url</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    187. 

  187. 

  188. <span class="n">cookies</span> <span class="o">=</span> <span class="p">{}</span>
    189. 

  189. <span class="sd">&#39;&#39;&#39;Some engines might offer different result based on cookies.</span>
    190. 

  190. <span class="sd">Possible use-case: To set safesearch cookie.&#39;&#39;&#39;</span>
    191. 

  191. 

  192. <span class="n">headers</span> <span class="o">=</span> <span class="p">{}</span>
    193. 

  193. <span class="sd">&#39;&#39;&#39;Some engines might offer different result based headers.  Possible use-case:</span>
    194. 

  194. <span class="sd">To set header to moderate.&#39;&#39;&#39;</span>
    195. 

  195. 

  196. <span class="n">method</span> <span class="o">=</span> <span class="s1">&#39;GET&#39;</span>
    197. 

  197. <span class="sd">&#39;&#39;&#39;Some engines might require to do POST requests for search.&#39;&#39;&#39;</span>
    198. 

  198. 

  199. <span class="n">request_body</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    200. 

  200. <span class="sd">&#39;&#39;&#39;The body of the request.  This can only be used if different :py:obj:`method`</span>
    201. 

  201. <span class="sd">is set, e.g. ``POST``.  For formatting see the documentation of :py:obj:`search_url`::</span>
    202. 

  202. 

  203. <span class="sd">    search={query}&amp;page={pageno}{time_range}{safe_search}</span>
    204. 

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

  205. 

  206. <span class="n">paging</span> <span class="o">=</span> <span class="kc">False</span>
    207. 

  207. <span class="sd">&#39;&#39;&#39;Engine supports paging [True or False].&#39;&#39;&#39;</span>
    208. 

  208. 

  209. <span class="n">page_size</span> <span class="o">=</span> <span class="mi">1</span>
    210. 

  210. <span class="sd">&#39;&#39;&#39;Number of results on each page.  Only needed if the site requires not a page</span>
    211. 

  211. <span class="sd">number, but an offset.&#39;&#39;&#39;</span>
    212. 

  212. 

  213. <span class="n">first_page_num</span> <span class="o">=</span> <span class="mi">1</span>
    214. 

  214. <span class="sd">&#39;&#39;&#39;Number of the first page (usually 0 or 1).&#39;&#39;&#39;</span>
    215. 

  215. 

  216. <span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">False</span>
    217. 

  217. <span class="sd">&#39;&#39;&#39;Engine supports search time range.&#39;&#39;&#39;</span>
    218. 

  218. 

  219. <span class="n">time_range_url</span> <span class="o">=</span> <span class="s1">&#39;&amp;hours=</span><span class="si">{time_range_val}</span><span class="s1">&#39;</span>
    220. 

  220. <span class="sd">&#39;&#39;&#39;Time range URL parameter in the in :py:obj:`search_url`.  If no time range is</span>
    221. 

  221. <span class="sd">requested by the user, the URL parameter is an empty string.  The</span>
    222. 

  222. <span class="sd">``{time_range_val}`` replacement is taken from the :py:obj:`time_range_map`.</span>
    223. 

  223. 

  224. <span class="sd">.. code:: yaml</span>
    225. 

  225. 

  226. <span class="sd">    time_range_url : &#39;&amp;days={time_range_val}&#39;</span>
    227. 

  227. <span class="sd">&#39;&#39;&#39;</span>
    228. 

  228. 

  229. <span class="n">time_range_map</span> <span class="o">=</span> <span class="p">{</span>
    230. 

  230.     <span class="s1">&#39;day&#39;</span><span class="p">:</span> <span class="mi">24</span><span class="p">,</span>
    231. 

  231.     <span class="s1">&#39;week&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">7</span><span class="p">,</span>
    232. 

  232.     <span class="s1">&#39;month&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">30</span><span class="p">,</span>
    233. 

  233.     <span class="s1">&#39;year&#39;</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">365</span><span class="p">,</span>
    234. 

  234. <span class="p">}</span>
    235. 

  235. <span class="sd">&#39;&#39;&#39;Maps time range value from user to ``{time_range_val}`` in</span>
    236. 

  236. <span class="sd">:py:obj:`time_range_url`.</span>
    237. 

  237. 

  238. <span class="sd">.. code:: yaml</span>
    239. 

  239. 

  240. <span class="sd">    time_range_map:</span>
    241. 

  241. <span class="sd">      day: 1</span>
    242. 

  242. <span class="sd">      week: 7</span>
    243. 

  243. <span class="sd">      month: 30</span>
    244. 

  244. <span class="sd">      year: 365</span>
    245. 

  245. <span class="sd">&#39;&#39;&#39;</span>
    246. 

  246. 

  247. <span class="n">safe_search_support</span> <span class="o">=</span> <span class="kc">False</span>
    248. 

  248. <span class="sd">&#39;&#39;&#39;Engine supports safe-search.&#39;&#39;&#39;</span>
    249. 

  249. 

  250. <span class="n">safe_search_map</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=none&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=moderate&#39;</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">&#39;&amp;filter=strict&#39;</span><span class="p">}</span>
    251. 

  251. <span class="sd">&#39;&#39;&#39;Maps safe-search value to ``{safe_search}`` in :py:obj:`search_url`.</span>
    252. 

  252. 

  253. <span class="sd">.. code:: yaml</span>
    254. 

  254. 

  255. <span class="sd">    safesearch: true</span>
    256. 

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

  257. <span class="sd">      0: &#39;&amp;filter=none&#39;</span>
    258. 

  258. <span class="sd">      1: &#39;&amp;filter=moderate&#39;</span>
    259. 

  259. <span class="sd">      2: &#39;&amp;filter=strict&#39;</span>
    260. 

  260. 

  261. <span class="sd">&#39;&#39;&#39;</span>
    262. 

  262. 

  263. 

  264. <div class="viewcode-block" id="request">
    265. 

  265. <a class="viewcode-back" href="../../../dev/engines/xpath.html#searx.engines.xpath.request">[docs]</a>
    266. 

  266. <span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
    267. 

  267. <span class="w">    </span><span class="sd">&#39;&#39;&#39;Build request parameters (see :ref:`engine request`).&#39;&#39;&#39;</span>
    268. 

  268.     <span class="n">lang</span> <span class="o">=</span> <span class="n">lang_all</span>
    269. 

  269.     <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;all&#39;</span><span class="p">:</span>
    270. 

  270.         <span class="n">lang</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;language&#39;</span><span class="p">][:</span><span class="mi">2</span><span class="p">]</span>
    271. 

  271. 

  272.     <span class="n">time_range</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    273. 

  273.     <span class="k">if</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;time_range&#39;</span><span class="p">):</span>
    274. 

  274.         <span class="n">time_range_val</span> <span class="o">=</span> <span class="n">time_range_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;time_range&#39;</span><span class="p">))</span>
    275. 

  275.         <span class="n">time_range</span> <span class="o">=</span> <span class="n">time_range_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">time_range_val</span><span class="o">=</span><span class="n">time_range_val</span><span class="p">)</span>
    276. 

  276. 

  277.     <span class="n">safe_search</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
    278. 

  278.     <span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]:</span>
    279. 

  279.         <span class="n">safe_search</span> <span class="o">=</span> <span class="n">safe_search_map</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;safesearch&#39;</span><span class="p">]]</span>
    280. 

  280. 

  281.     <span class="n">fargs</span> <span class="o">=</span> <span class="p">{</span>
    282. 

  282.         <span class="s1">&#39;query&#39;</span><span class="p">:</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">})[</span><span class="mi">2</span><span class="p">:],</span>
    283. 

  283.         <span class="s1">&#39;lang&#39;</span><span class="p">:</span> <span class="n">lang</span><span class="p">,</span>
    284. 

  284.         <span class="s1">&#39;pageno&#39;</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#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">page_size</span> <span class="o">+</span> <span class="n">first_page_num</span><span class="p">,</span>
    285. 

  285.         <span class="s1">&#39;time_range&#39;</span><span class="p">:</span> <span class="n">time_range</span><span class="p">,</span>
    286. 

  286.         <span class="s1">&#39;safe_search&#39;</span><span class="p">:</span> <span class="n">safe_search</span><span class="p">,</span>
    287. 

  287.     <span class="p">}</span>
    288. 

  288. 

  289.     <span class="n">params</span><span class="p">[</span><span class="s1">&#39;cookies&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cookies</span><span class="p">)</span>
    290. 

  290.     <span class="n">params</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">headers</span><span class="p">)</span>
    291. 

  291. 

  292.     <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">fargs</span><span class="p">)</span>
    293. 

  293.     <span class="n">params</span><span class="p">[</span><span class="s1">&#39;method&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">method</span>
    294. 

  294. 

  295.     <span class="k">if</span> <span class="n">request_body</span><span class="p">:</span>
    296. 

  296.         <span class="c1"># don&#39;t url-encode the query if it&#39;s in the request body</span>
    297. 

  297.         <span class="n">fargs</span><span class="p">[</span><span class="s1">&#39;query&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span>
    298. 

  298.         <span class="n">params</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">request_body</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">fargs</span><span class="p">)</span>
    299. 

  299. 

  300.     <span class="n">params</span><span class="p">[</span><span class="s1">&#39;soft_max_redirects&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">soft_max_redirects</span>
    301. 

  301.     <span class="n">params</span><span class="p">[</span><span class="s1">&#39;raise_for_httperror&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
    302. 

  302. 

  303.     <span class="k">return</span> <span class="n">params</span></div>
    304. 

  304. 

  305. 

  306. 

  307. <div class="viewcode-block" id="response">
    308. 

  308. <a class="viewcode-back" href="../../../dev/engines/xpath.html#searx.engines.xpath.response">[docs]</a>
    309. 

  309. <span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>  <span class="c1"># pylint: disable=too-many-branches</span>
    310. 

  310. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Scrap *results* from the response (see :ref:`result types`).&quot;&quot;&quot;</span>
    311. 

  311.     <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
    312. 

  312. 

  313.     <span class="k">if</span> <span class="n">no_result_for_http_status</span> <span class="ow">and</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="ow">in</span> <span class="n">no_result_for_http_status</span><span class="p">:</span>
    314. 

  314.         <span class="k">return</span> <span class="n">results</span>
    315. 

  315. 

  316.     <span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
    317. 

  317. 

  318.     <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">:</span>
    319. 

  319.         <span class="k">return</span> <span class="n">results</span>
    320. 

  320. 

  321.     <span class="n">dom</span> <span class="o">=</span> <span class="n">html</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
    322. 

  322.     <span class="n">is_onion</span> <span class="o">=</span> <span class="s1">&#39;onions&#39;</span> <span class="ow">in</span> <span class="n">categories</span>
    323. 

  323. 

  324.     <span class="k">if</span> <span class="n">results_xpath</span><span class="p">:</span>
    325. 

  325.         <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">results_xpath</span><span class="p">):</span>
    326. 

  326. 

  327.             <span class="n">url</span> <span class="o">=</span> <span class="n">extract_url</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">url_xpath</span><span class="p">,</span> <span class="n">min_len</span><span class="o">=</span><span class="mi">1</span><span class="p">),</span> <span class="n">search_url</span><span class="p">)</span>
    328. 

  328.             <span class="n">title</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">title_xpath</span><span class="p">,</span> <span class="n">min_len</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span>
    329. 

  329.             <span class="n">content</span> <span class="o">=</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">content_xpath</span><span class="p">))</span>
    330. 

  330.             <span class="n">tmp_result</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">}</span>
    331. 

  331. 

  332.             <span class="c1"># add thumbnail if available</span>
    333. 

  333.             <span class="k">if</span> <span class="n">thumbnail_xpath</span><span class="p">:</span>
    334. 

  334.                 <span class="n">thumbnail_xpath_result</span> <span class="o">=</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">thumbnail_xpath</span><span class="p">)</span>
    335. 

  335.                 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">thumbnail_xpath_result</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
    336. 

  336.                     <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">extract_url</span><span class="p">(</span><span class="n">thumbnail_xpath_result</span><span class="p">,</span> <span class="n">search_url</span><span class="p">)</span>
    337. 

  337. 

  338.             <span class="c1"># add alternative cached url if available</span>
    339. 

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

  340.                 <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;cached_url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">cached_url</span> <span class="o">+</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">cached_xpath</span><span class="p">,</span> <span class="n">min_len</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span>
    341. 

  341. 

  342.             <span class="k">if</span> <span class="n">is_onion</span><span class="p">:</span>
    343. 

  343.                 <span class="n">tmp_result</span><span class="p">[</span><span class="s1">&#39;is_onion&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
    344. 

  344. 

  345.             <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tmp_result</span><span class="p">)</span>
    346. 

  346. 

  347.     <span class="k">else</span><span class="p">:</span>
    348. 

  348.         <span class="k">if</span> <span class="n">cached_xpath</span><span class="p">:</span>
    349. 

  349.             <span class="k">for</span> <span class="n">url</span><span class="p">,</span> <span class="n">title</span><span class="p">,</span> <span class="n">content</span><span class="p">,</span> <span class="n">cached</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span>
    350. 

  350.                 <span class="p">(</span><span class="n">extract_url</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">search_url</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">url_xpath</span><span class="p">)),</span>
    351. 

  351.                 <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">title_xpath</span><span class="p">)),</span>
    352. 

  352.                 <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">content_xpath</span><span class="p">)),</span>
    353. 

  353.                 <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">cached_xpath</span><span class="p">)),</span>
    354. 

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

  355.                 <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
    356. 

  356.                     <span class="p">{</span>
    357. 

  357.                         <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
    358. 

  358.                         <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
    359. 

  359.                         <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span>
    360. 

  360.                         <span class="s1">&#39;cached_url&#39;</span><span class="p">:</span> <span class="n">cached_url</span> <span class="o">+</span> <span class="n">cached</span><span class="p">,</span>
    361. 

  361.                         <span class="s1">&#39;is_onion&#39;</span><span class="p">:</span> <span class="n">is_onion</span><span class="p">,</span>
    362. 

  362.                     <span class="p">}</span>
    363. 

  363.                 <span class="p">)</span>
    364. 

  364.         <span class="k">else</span><span class="p">:</span>
    365. 

  365.             <span class="k">for</span> <span class="n">url</span><span class="p">,</span> <span class="n">title</span><span class="p">,</span> <span class="n">content</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span>
    366. 

  366.                 <span class="p">(</span><span class="n">extract_url</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">search_url</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">url_xpath</span><span class="p">)),</span>
    367. 

  367.                 <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">title_xpath</span><span class="p">)),</span>
    368. 

  368.                 <span class="nb">map</span><span class="p">(</span><span class="n">extract_text</span><span class="p">,</span> <span class="n">eval_xpath_list</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">content_xpath</span><span class="p">)),</span>
    369. 

  369.             <span class="p">):</span>
    370. 

  370.                 <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span> <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">content</span><span class="p">,</span> <span class="s1">&#39;is_onion&#39;</span><span class="p">:</span> <span class="n">is_onion</span><span class="p">})</span>
    371. 

  371. 

  372.     <span class="k">if</span> <span class="n">suggestion_xpath</span><span class="p">:</span>
    373. 

  373.         <span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">eval_xpath</span><span class="p">(</span><span class="n">dom</span><span class="p">,</span> <span class="n">suggestion_xpath</span><span class="p">):</span>
    374. 

  374.             <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">&#39;suggestion&#39;</span><span class="p">:</span> <span class="n">extract_text</span><span class="p">(</span><span class="n">suggestion</span><span class="p">)})</span>
    375. 

  375. 

  376.     <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;found </span><span class="si">%s</span><span class="s2"> results&quot;</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">results</span><span class="p">))</span>
    377. 

  377.     <span class="k">return</span> <span class="n">results</span></div>
    378. 

  378. 

  379. </pre></div>
    380. 

  380. 

  381.             <div class="clearer"></div>
    382. 

  382.           </div>
    383. 

  383.         </div>
    384. 

  384.       </div>
    385. 

  385.   <span id="sidebar-top"></span>
    386. 

  386.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    387. 

  387.         <div class="sphinxsidebarwrapper">
    388. 

  388.   
    389. 

  389.     
    390. 

  390.             <p class="logo"><a href="../../../index.html">
    391. 

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

  392.             </a></p>
    393. 

  393.   
    394. 

  394. 

  395. <h3><a href="../../../index.html">Table of Contents</a></h3>
    396. 

  396. <ul>
    397. 

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

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

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

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

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

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

  403. </ul>
    404. 

  404. 

  405.   <h3>Project Links</h3>
    406. 

  406.   <ul>
    407. 

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

  408.   
    409. 

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

  410.   
    411. 

  411.     <li><a href="https://searx.space">Public instances</a>
    412. 

  412.   
    413. 

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

  414.   </ul><h3>Navigation</h3>
    415. 

  415. <ul>
    416. 

  416.   <li><a href="../../../index.html">Overview</a>
    417. 

  417.     <ul>
    418. 

  418.       <li><a href="../../index.html">Module code</a>
    419. 

  419.         <ul>
    420. 

  420.       <li><a href="../engines.html">searx.engines</a>
    421. 

  421.         
    422. 

  422.           
    423. 

  423.           </ul>
    424. 

  424.       </li></ul>
    425. 

  425.       </li>
    426. 

  426.     </ul>
    427. 

  427.   </li>
    428. 

  428. </ul>
    429. 

  429. <search id="searchbox" style="display: none" role="search">
    430. 

  430.   <h3 id="searchlabel">Quick search</h3>
    431. 

  431.     <div class="searchformwrapper">
    432. 

  432.     <form class="search" action="../../../search.html" method="get">
    433. 

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

  434.       <input type="submit" value="Go" />
    435. 

  435.     </form>
    436. 

  436.     </div>
    437. 

  437. </search>
    438. 

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

  439.         </div>
    440. 

  440.       </div>
    441. 

  441.       <div class="clearer"></div>
    442. 

  442.     </div>
    443. 

  443.     <div class="footer" role="contentinfo">
    444. 

  444.     &#169; Copyright SearXNG team.
    445. 

  445.     </div>
    446. 

  446.   </body>
    447. 

  447. </html>
    448.
© 2025 NTab仓库
Page: 45ms Template: 0ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website