wikipedia.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443
  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.engines.wikipedia &#8212; SearXNG Documentation (2025.5.1+1a1628149)</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=cc9fc81d"></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.5.1+1a1628149" 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.5.1+1a1628149)</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="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
  29. <li class="nav-item nav-item-this"><a href="">searx.engines.wikipedia</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.engines.wikipedia</h1><div class="highlight"><pre>
  37. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
  38. <span class="sd">&quot;&quot;&quot;This module implements the Wikipedia engine. Some of this implementations</span>
  39. <span class="sd">are shared by other engines:</span>
  40. <span class="sd">- :ref:`wikidata engine`</span>
  41. <span class="sd">The list of supported languages is :py:obj:`fetched &lt;fetch_wikimedia_traits&gt;` from</span>
  42. <span class="sd">the article linked by :py:obj:`list_of_wikipedias`.</span>
  43. <span class="sd">Unlike traditional search engines, wikipedia does not support one Wikipedia for</span>
  44. <span class="sd">all languages, but there is one Wikipedia for each supported language. Some of</span>
  45. <span class="sd">these Wikipedias have a LanguageConverter_ enabled</span>
  46. <span class="sd">(:py:obj:`rest_v1_summary_url`).</span>
  47. <span class="sd">A LanguageConverter_ (LC) is a system based on language variants that</span>
  48. <span class="sd">automatically converts the content of a page into a different variant. A variant</span>
  49. <span class="sd">is mostly the same language in a different script.</span>
  50. <span class="sd">- `Wikipedias in multiple writing systems`_</span>
  51. <span class="sd">- `Automatic conversion between traditional and simplified Chinese characters`_</span>
  52. <span class="sd">PR-2554_:</span>
  53. <span class="sd"> The Wikipedia link returned by the API is still the same in all cases</span>
  54. <span class="sd"> (`https://zh.wikipedia.org/wiki/出租車`_) but if your browser&#39;s</span>
  55. <span class="sd"> ``Accept-Language`` is set to any of ``zh``, ``zh-CN``, ``zh-TW``, ``zh-HK``</span>
  56. <span class="sd"> or .. Wikipedia&#39;s LC automatically returns the desired script in their</span>
  57. <span class="sd"> web-page.</span>
  58. <span class="sd"> - You can test the API here: https://reqbin.com/gesg2kvx</span>
  59. <span class="sd">.. _https://zh.wikipedia.org/wiki/出租車:</span>
  60. <span class="sd"> https://zh.wikipedia.org/wiki/%E5%87%BA%E7%A7%9F%E8%BB%8A</span>
  61. <span class="sd">To support Wikipedia&#39;s LanguageConverter_, a SearXNG request to Wikipedia uses</span>
  62. <span class="sd">:py:obj:`get_wiki_params` and :py:obj:`wiki_lc_locale_variants&#39; in the</span>
  63. <span class="sd">:py:obj:`fetch_wikimedia_traits` function.</span>
  64. <span class="sd">To test in SearXNG, query for ``!wp 出租車`` with each of the available Chinese</span>
  65. <span class="sd">options:</span>
  66. <span class="sd">- ``!wp 出租車 :zh`` should show 出租車</span>
  67. <span class="sd">- ``!wp 出租車 :zh-CN`` should show 出租车</span>
  68. <span class="sd">- ``!wp 出租車 :zh-TW`` should show 計程車</span>
  69. <span class="sd">- ``!wp 出租車 :zh-HK`` should show 的士</span>
  70. <span class="sd">- ``!wp 出租車 :zh-SG`` should show 德士</span>
  71. <span class="sd">.. _LanguageConverter:</span>
  72. <span class="sd"> https://www.mediawiki.org/wiki/Writing_systems#LanguageConverter</span>
  73. <span class="sd">.. _Wikipedias in multiple writing systems:</span>
  74. <span class="sd"> https://meta.wikimedia.org/wiki/Wikipedias_in_multiple_writing_systems</span>
  75. <span class="sd">.. _Automatic conversion between traditional and simplified Chinese characters:</span>
  76. <span class="sd"> https://en.wikipedia.org/wiki/Chinese_Wikipedia#Automatic_conversion_between_traditional_and_simplified_Chinese_characters</span>
  77. <span class="sd">.. _PR-2554: https://github.com/searx/searx/pull/2554</span>
  78. <span class="sd">&quot;&quot;&quot;</span>
  79. <span class="kn">import</span><span class="w"> </span><span class="nn">urllib.parse</span>
  80. <span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
  81. <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>
  82. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">utils</span>
  83. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">network</span> <span class="k">as</span> <span class="n">_network</span>
  84. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">locales</span>
  85. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib.traits</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineTraits</span>
  86. <span class="n">traits</span><span class="p">:</span> <span class="n">EngineTraits</span>
  87. <span class="c1"># about</span>
  88. <span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
  89. <span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s1">&#39;https://www.wikipedia.org/&#39;</span><span class="p">,</span>
  90. <span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s1">&#39;Q52&#39;</span><span class="p">,</span>
  91. <span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s1">&#39;https://en.wikipedia.org/api/&#39;</span><span class="p">,</span>
  92. <span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
  93. <span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
  94. <span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s1">&#39;JSON&#39;</span><span class="p">,</span>
  95. <span class="p">}</span>
  96. <span class="n">display_type</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;infobox&quot;</span><span class="p">]</span>
  97. <span class="sd">&quot;&quot;&quot;A list of display types composed from ``infobox`` and ``list``. The latter</span>
  98. <span class="sd">one will add a hit to the result list. The first one will show a hit in the</span>
  99. <span class="sd">info box. Both values can be set, or one of the two can be set.&quot;&quot;&quot;</span>
  100. <span class="n">send_accept_language_header</span> <span class="o">=</span> <span class="kc">True</span>
  101. <span class="sd">&quot;&quot;&quot;The HTTP ``Accept-Language`` header is needed for wikis where</span>
  102. <span class="sd">LanguageConverter_ is enabled.&quot;&quot;&quot;</span>
  103. <span class="n">list_of_wikipedias</span> <span class="o">=</span> <span class="s1">&#39;https://meta.wikimedia.org/wiki/List_of_Wikipedias&#39;</span>
  104. <span class="sd">&quot;&quot;&quot;`List of all wikipedias &lt;https://meta.wikimedia.org/wiki/List_of_Wikipedias&gt;`_</span>
  105. <span class="sd">&quot;&quot;&quot;</span>
  106. <span class="n">wikipedia_article_depth</span> <span class="o">=</span> <span class="s1">&#39;https://meta.wikimedia.org/wiki/Wikipedia_article_depth&#39;</span>
  107. <span class="sd">&quot;&quot;&quot;The *editing depth* of Wikipedia is one of several possible rough indicators</span>
  108. <span class="sd">of the encyclopedia&#39;s collaborative quality, showing how frequently its articles</span>
  109. <span class="sd">are updated. The measurement of depth was introduced after some limitations of</span>
  110. <span class="sd">the classic measurement of article count were realized.</span>
  111. <span class="sd">&quot;&quot;&quot;</span>
  112. <span class="n">rest_v1_summary_url</span> <span class="o">=</span> <span class="s1">&#39;https://</span><span class="si">{wiki_netloc}</span><span class="s1">/api/rest_v1/page/summary/</span><span class="si">{title}</span><span class="s1">&#39;</span>
  113. <span class="sd">&quot;&quot;&quot;</span>
  114. <span class="sd">`wikipedia rest_v1 summary API`_:</span>
  115. <span class="sd"> The summary response includes an extract of the first paragraph of the page in</span>
  116. <span class="sd"> plain text and HTML as well as the type of page. This is useful for page</span>
  117. <span class="sd"> previews (fka. Hovercards, aka. Popups) on the web and link previews in the</span>
  118. <span class="sd"> apps.</span>
  119. <span class="sd">HTTP ``Accept-Language`` header (:py:obj:`send_accept_language_header`):</span>
  120. <span class="sd"> The desired language variant code for wikis where LanguageConverter_ is</span>
  121. <span class="sd"> enabled.</span>
  122. <span class="sd">.. _wikipedia rest_v1 summary API:</span>
  123. <span class="sd"> https://en.wikipedia.org/api/rest_v1/#/Page%20content/get_page_summary__title_</span>
  124. <span class="sd">&quot;&quot;&quot;</span>
  125. <span class="n">wiki_lc_locale_variants</span> <span class="o">=</span> <span class="p">{</span>
  126. <span class="s2">&quot;zh&quot;</span><span class="p">:</span> <span class="p">(</span>
  127. <span class="s2">&quot;zh-CN&quot;</span><span class="p">,</span>
  128. <span class="s2">&quot;zh-HK&quot;</span><span class="p">,</span>
  129. <span class="s2">&quot;zh-MO&quot;</span><span class="p">,</span>
  130. <span class="s2">&quot;zh-MY&quot;</span><span class="p">,</span>
  131. <span class="s2">&quot;zh-SG&quot;</span><span class="p">,</span>
  132. <span class="s2">&quot;zh-TW&quot;</span><span class="p">,</span>
  133. <span class="p">),</span>
  134. <span class="s2">&quot;zh-classical&quot;</span><span class="p">:</span> <span class="p">(</span><span class="s2">&quot;zh-classical&quot;</span><span class="p">,),</span>
  135. <span class="p">}</span>
  136. <span class="sd">&quot;&quot;&quot;Mapping rule of the LanguageConverter_ to map a language and its variants to</span>
  137. <span class="sd">a Locale (used in the HTTP ``Accept-Language`` header). For example see `LC</span>
  138. <span class="sd">Chinese`_.</span>
  139. <span class="sd">.. _LC Chinese:</span>
  140. <span class="sd"> https://meta.wikimedia.org/wiki/Wikipedias_in_multiple_writing_systems#Chinese</span>
  141. <span class="sd">&quot;&quot;&quot;</span>
  142. <span class="n">wikipedia_script_variants</span> <span class="o">=</span> <span class="p">{</span>
  143. <span class="s2">&quot;zh&quot;</span><span class="p">:</span> <span class="p">(</span>
  144. <span class="s2">&quot;zh_Hant&quot;</span><span class="p">,</span>
  145. <span class="s2">&quot;zh_Hans&quot;</span><span class="p">,</span>
  146. <span class="p">)</span>
  147. <span class="p">}</span>
  148. <div class="viewcode-block" id="get_wiki_params">
  149. <a class="viewcode-back" href="../../../dev/engines/online/wikipedia.html#searx.engines.wikipedia.get_wiki_params">[docs]</a>
  150. <span class="k">def</span><span class="w"> </span><span class="nf">get_wiki_params</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">eng_traits</span><span class="p">):</span>
  151. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns the Wikipedia language tag and the netloc that fits to the</span>
  152. <span class="sd"> ``sxng_locale``. To support LanguageConverter_ this function rates a locale</span>
  153. <span class="sd"> (region) higher than a language (compare :py:obj:`wiki_lc_locale_variants`).</span>
  154. <span class="sd"> &quot;&quot;&quot;</span>
  155. <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_region</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">get_language</span><span class="p">(</span><span class="n">sxng_locale</span><span class="p">,</span> <span class="s1">&#39;en&#39;</span><span class="p">))</span>
  156. <span class="n">wiki_netloc</span> <span class="o">=</span> <span class="n">eng_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">,</span> <span class="s1">&#39;en.wikipedia.org&#39;</span><span class="p">)</span>
  157. <span class="k">return</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">wiki_netloc</span></div>
  158. <div class="viewcode-block" id="request">
  159. <a class="viewcode-back" href="../../../dev/engines/online/wikipedia.html#searx.engines.wikipedia.request">[docs]</a>
  160. <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>
  161. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Assemble a request (`wikipedia rest_v1 summary API`_).&quot;&quot;&quot;</span>
  162. <span class="k">if</span> <span class="n">query</span><span class="o">.</span><span class="n">islower</span><span class="p">():</span>
  163. <span class="n">query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">title</span><span class="p">()</span>
  164. <span class="n">_eng_tag</span><span class="p">,</span> <span class="n">wiki_netloc</span> <span class="o">=</span> <span class="n">get_wiki_params</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;searxng_locale&#39;</span><span class="p">],</span> <span class="n">traits</span><span class="p">)</span>
  165. <span class="n">title</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">quote</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
  166. <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">rest_v1_summary_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">wiki_netloc</span><span class="o">=</span><span class="n">wiki_netloc</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">)</span>
  167. <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>
  168. <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="mi">2</span>
  169. <span class="k">return</span> <span class="n">params</span></div>
  170. <span class="c1"># get response from search-request</span>
  171. <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>
  172. <span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
  173. <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">404</span><span class="p">:</span>
  174. <span class="k">return</span> <span class="p">[]</span>
  175. <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
  176. <span class="k">try</span><span class="p">:</span>
  177. <span class="n">api_result</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
  178. <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
  179. <span class="k">pass</span>
  180. <span class="k">else</span><span class="p">:</span>
  181. <span class="k">if</span> <span class="p">(</span>
  182. <span class="n">api_result</span><span class="p">[</span><span class="s1">&#39;type&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;https://mediawiki.org/wiki/HyperSwitch/errors/bad_request&#39;</span>
  183. <span class="ow">and</span> <span class="n">api_result</span><span class="p">[</span><span class="s1">&#39;detail&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;title-invalid-characters&#39;</span>
  184. <span class="p">):</span>
  185. <span class="k">return</span> <span class="p">[]</span>
  186. <span class="n">_network</span><span class="o">.</span><span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
  187. <span class="n">api_result</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
  188. <span class="n">title</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">html_to_text</span><span class="p">(</span><span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;titles&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;display&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;title&#39;</span><span class="p">))</span>
  189. <span class="n">wikipedia_link</span> <span class="o">=</span> <span class="n">api_result</span><span class="p">[</span><span class="s1">&#39;content_urls&#39;</span><span class="p">][</span><span class="s1">&#39;desktop&#39;</span><span class="p">][</span><span class="s1">&#39;page&#39;</span><span class="p">]</span>
  190. <span class="k">if</span> <span class="s2">&quot;list&quot;</span> <span class="ow">in</span> <span class="n">display_type</span> <span class="ow">or</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;type&#39;</span><span class="p">)</span> <span class="o">!=</span> <span class="s1">&#39;standard&#39;</span><span class="p">:</span>
  191. <span class="c1"># show item in the result list if &#39;list&#39; is in the display options or it</span>
  192. <span class="c1"># is a item that can&#39;t be displayed in a infobox.</span>
  193. <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">wikipedia_link</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">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)})</span>
  194. <span class="k">if</span> <span class="s2">&quot;infobox&quot;</span> <span class="ow">in</span> <span class="n">display_type</span><span class="p">:</span>
  195. <span class="k">if</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;type&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="s1">&#39;standard&#39;</span><span class="p">:</span>
  196. <span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
  197. <span class="p">{</span>
  198. <span class="s1">&#39;infobox&#39;</span><span class="p">:</span> <span class="n">title</span><span class="p">,</span>
  199. <span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="n">wikipedia_link</span><span class="p">,</span>
  200. <span class="s1">&#39;content&#39;</span><span class="p">:</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;extract&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
  201. <span class="s1">&#39;img_src&#39;</span><span class="p">:</span> <span class="n">api_result</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;thumbnail&#39;</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;source&#39;</span><span class="p">),</span>
  202. <span class="s1">&#39;urls&#39;</span><span class="p">:</span> <span class="p">[{</span><span class="s1">&#39;title&#39;</span><span class="p">:</span> <span class="s1">&#39;Wikipedia&#39;</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">:</span> <span class="n">wikipedia_link</span><span class="p">}],</span>
  203. <span class="p">}</span>
  204. <span class="p">)</span>
  205. <span class="k">return</span> <span class="n">results</span>
  206. <span class="c1"># Nonstandard language codes</span>
  207. <span class="c1">#</span>
  208. <span class="c1"># These Wikipedias use language codes that do not conform to the ISO 639</span>
  209. <span class="c1"># standard (which is how wiki subdomains are chosen nowadays).</span>
  210. <span class="n">lang_map</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">LOCALE_BEST_MATCH</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
  211. <span class="n">lang_map</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
  212. <span class="p">{</span>
  213. <span class="s1">&#39;be-tarask&#39;</span><span class="p">:</span> <span class="s1">&#39;bel&#39;</span><span class="p">,</span>
  214. <span class="s1">&#39;ak&#39;</span><span class="p">:</span> <span class="s1">&#39;aka&#39;</span><span class="p">,</span>
  215. <span class="s1">&#39;als&#39;</span><span class="p">:</span> <span class="s1">&#39;gsw&#39;</span><span class="p">,</span>
  216. <span class="s1">&#39;bat-smg&#39;</span><span class="p">:</span> <span class="s1">&#39;sgs&#39;</span><span class="p">,</span>
  217. <span class="s1">&#39;cbk-zam&#39;</span><span class="p">:</span> <span class="s1">&#39;cbk&#39;</span><span class="p">,</span>
  218. <span class="s1">&#39;fiu-vro&#39;</span><span class="p">:</span> <span class="s1">&#39;vro&#39;</span><span class="p">,</span>
  219. <span class="s1">&#39;map-bms&#39;</span><span class="p">:</span> <span class="s1">&#39;map&#39;</span><span class="p">,</span>
  220. <span class="s1">&#39;no&#39;</span><span class="p">:</span> <span class="s1">&#39;nb-NO&#39;</span><span class="p">,</span>
  221. <span class="s1">&#39;nrm&#39;</span><span class="p">:</span> <span class="s1">&#39;nrf&#39;</span><span class="p">,</span>
  222. <span class="s1">&#39;roa-rup&#39;</span><span class="p">:</span> <span class="s1">&#39;rup&#39;</span><span class="p">,</span>
  223. <span class="s1">&#39;nds-nl&#39;</span><span class="p">:</span> <span class="s1">&#39;nds&#39;</span><span class="p">,</span>
  224. <span class="c1">#&#39;simple: – invented code used for the Simple English Wikipedia (not the official IETF code en-simple)</span>
  225. <span class="s1">&#39;zh-min-nan&#39;</span><span class="p">:</span> <span class="s1">&#39;nan&#39;</span><span class="p">,</span>
  226. <span class="s1">&#39;zh-yue&#39;</span><span class="p">:</span> <span class="s1">&#39;yue&#39;</span><span class="p">,</span>
  227. <span class="s1">&#39;an&#39;</span><span class="p">:</span> <span class="s1">&#39;arg&#39;</span><span class="p">,</span>
  228. <span class="p">}</span>
  229. <span class="p">)</span>
  230. <span class="k">def</span><span class="w"> </span><span class="nf">fetch_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
  231. <span class="n">fetch_wikimedia_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">)</span>
  232. <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;WIKIPEDIA_LANGUAGES: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]))</span>
  233. <div class="viewcode-block" id="fetch_wikimedia_traits">
  234. <a class="viewcode-back" href="../../../dev/engines/online/wikipedia.html#searx.engines.wikipedia.fetch_wikimedia_traits">[docs]</a>
  235. <span class="k">def</span><span class="w"> </span><span class="nf">fetch_wikimedia_traits</span><span class="p">(</span><span class="n">engine_traits</span><span class="p">:</span> <span class="n">EngineTraits</span><span class="p">):</span>
  236. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Fetch languages from Wikipedia. Not all languages from the</span>
  237. <span class="sd"> :py:obj:`list_of_wikipedias` are supported by SearXNG locales, only those</span>
  238. <span class="sd"> known from :py:obj:`searx.locales.LOCALE_NAMES` or those with a minimal</span>
  239. <span class="sd"> :py:obj:`editing depth &lt;wikipedia_article_depth&gt;`.</span>
  240. <span class="sd"> The location of the Wikipedia address of a language is mapped in a</span>
  241. <span class="sd"> :py:obj:`custom field &lt;searx.enginelib.traits.EngineTraits.custom&gt;`</span>
  242. <span class="sd"> (``wiki_netloc``). Here is a reduced example:</span>
  243. <span class="sd"> .. code:: python</span>
  244. <span class="sd"> traits.custom[&#39;wiki_netloc&#39;] = {</span>
  245. <span class="sd"> &quot;en&quot;: &quot;en.wikipedia.org&quot;,</span>
  246. <span class="sd"> ..</span>
  247. <span class="sd"> &quot;gsw&quot;: &quot;als.wikipedia.org&quot;,</span>
  248. <span class="sd"> ..</span>
  249. <span class="sd"> &quot;zh&quot;: &quot;zh.wikipedia.org&quot;,</span>
  250. <span class="sd"> &quot;zh-classical&quot;: &quot;zh-classical.wikipedia.org&quot;</span>
  251. <span class="sd"> }</span>
  252. <span class="sd"> &quot;&quot;&quot;</span>
  253. <span class="c1"># pylint: disable=too-many-branches</span>
  254. <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
  255. <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
  256. <span class="c1"># insert alias to map from a script or region to a wikipedia variant</span>
  257. <span class="k">for</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">sxng_tag_list</span> <span class="ow">in</span> <span class="n">wikipedia_script_variants</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
  258. <span class="k">for</span> <span class="n">sxng_tag</span> <span class="ow">in</span> <span class="n">sxng_tag_list</span><span class="p">:</span>
  259. <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
  260. <span class="k">for</span> <span class="n">eng_tag</span><span class="p">,</span> <span class="n">sxng_tag_list</span> <span class="ow">in</span> <span class="n">wiki_lc_locale_variants</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
  261. <span class="k">for</span> <span class="n">sxng_tag</span> <span class="ow">in</span> <span class="n">sxng_tag_list</span><span class="p">:</span>
  262. <span class="n">engine_traits</span><span class="o">.</span><span class="n">regions</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
  263. <span class="n">resp</span> <span class="o">=</span> <span class="n">_network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">list_of_wikipedias</span><span class="p">)</span>
  264. <span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">ok</span><span class="p">:</span>
  265. <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR: response from Wikipedia is not OK.&quot;</span><span class="p">)</span>
  266. <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>
  267. <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">dom</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;//table[contains(@class,&quot;sortable&quot;)]//tbody/tr&#39;</span><span class="p">):</span>
  268. <span class="n">cols</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;./td&#39;</span><span class="p">)</span>
  269. <span class="k">if</span> <span class="ow">not</span> <span class="n">cols</span><span class="p">:</span>
  270. <span class="k">continue</span>
  271. <span class="n">cols</span> <span class="o">=</span> <span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">text_content</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">cols</span><span class="p">]</span>
  272. <span class="n">depth</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">cols</span><span class="p">[</span><span class="mi">11</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">,</span> <span class="s1">&#39;0&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;,&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
  273. <span class="n">articles</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">cols</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;,&#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;,&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">))</span>
  274. <span class="n">eng_tag</span> <span class="o">=</span> <span class="n">cols</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
  275. <span class="n">wiki_url</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s1">&#39;./td[4]/a/@href&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
  276. <span class="n">wiki_url</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">wiki_url</span><span class="p">)</span>
  277. <span class="k">try</span><span class="p">:</span>
  278. <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">locales</span><span class="o">.</span><span class="n">language_tag</span><span class="p">(</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="n">lang_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">))</span>
  279. <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
  280. <span class="c1"># print(&quot;ERROR: %s [%s] is unknown by babel&quot; % (cols[0], eng_tag))</span>
  281. <span class="k">continue</span>
  282. <span class="k">finally</span><span class="p">:</span>
  283. <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">eng_tag</span><span class="p">)</span>
  284. <span class="k">if</span> <span class="n">sxng_tag</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">locales</span><span class="o">.</span><span class="n">LOCALE_NAMES</span><span class="p">:</span>
  285. <span class="k">if</span> <span class="n">articles</span> <span class="o">&lt;</span> <span class="mi">10000</span><span class="p">:</span>
  286. <span class="c1"># exclude languages with too few articles</span>
  287. <span class="k">continue</span>
  288. <span class="k">if</span> <span class="nb">int</span><span class="p">(</span><span class="n">depth</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">20</span><span class="p">:</span>
  289. <span class="c1"># Rough indicator of a Wikipedia’s quality, showing how</span>
  290. <span class="c1"># frequently its articles are updated.</span>
  291. <span class="k">continue</span>
  292. <span class="n">conflict</span> <span class="o">=</span> <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">sxng_tag</span><span class="p">)</span>
  293. <span class="k">if</span> <span class="n">conflict</span><span class="p">:</span>
  294. <span class="k">if</span> <span class="n">conflict</span> <span class="o">!=</span> <span class="n">eng_tag</span><span class="p">:</span>
  295. <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;CONFLICT: babel </span><span class="si">%s</span><span class="s2"> --&gt; </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">sxng_tag</span><span class="p">,</span> <span class="n">conflict</span><span class="p">,</span> <span class="n">eng_tag</span><span class="p">))</span>
  296. <span class="k">continue</span>
  297. <span class="n">engine_traits</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="n">sxng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">eng_tag</span>
  298. <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;wiki_netloc&#39;</span><span class="p">][</span><span class="n">eng_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">wiki_url</span><span class="o">.</span><span class="n">netloc</span>
  299. <span class="n">engine_traits</span><span class="o">.</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;WIKIPEDIA_LANGUAGES&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span></div>
  300. </pre></div>
  301. <div class="clearer"></div>
  302. </div>
  303. </div>
  304. </div>
  305. <span id="sidebar-top"></span>
  306. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  307. <div class="sphinxsidebarwrapper">
  308. <p class="logo"><a href="../../../index.html">
  309. <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  310. </a></p>
  311. <h3><a href="../../../index.html">Table of Contents</a></h3>
  312. <ul>
  313. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
  314. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
  315. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
  316. <li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
  317. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
  318. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
  319. </ul>
  320. <h3>Project Links</h3>
  321. <ul>
  322. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  323. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  324. <li><a href="https://searx.space">Public instances</a>
  325. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  326. </ul><h3>Navigation</h3>
  327. <ul>
  328. <li><a href="../../../index.html">Overview</a>
  329. <ul>
  330. <li><a href="../../index.html">Module code</a>
  331. <ul>
  332. <li><a href="../engines.html">searx.engines</a>
  333. </ul>
  334. </li></ul>
  335. </li>
  336. </ul>
  337. </li>
  338. </ul>
  339. <search id="searchbox" style="display: none" role="search">
  340. <h3 id="searchlabel">Quick search</h3>
  341. <div class="searchformwrapper">
  342. <form class="search" action="../../../search.html" method="get">
  343. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  344. <input type="submit" value="Go" />
  345. </form>
  346. </div>
  347. </search>
  348. <script>document.getElementById('searchbox').style.display = "block"</script>
  349. </div>
  350. </div>
  351. <div class="clearer"></div>
  352. </div>
  353. <div class="footer" role="contentinfo">
  354. &#169; Copyright SearXNG team.
  355. </div>
  356. </body>
  357. </html>