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

locales.html 52 KB
Permalink History Raw

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

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

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

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

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

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

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

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

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

  17.   </head><body>
    18. 

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

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

  20.       <ul>
    21. 

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

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

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

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

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

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

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

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

  29.         <li class="nav-item nav-item-this"><a href="">searx.locales</a></li> 
    30. 

  30.       </ul>
    31. 

  31.     </div>  
    32. 

  32. 

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

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

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

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

  37.             
    38. 

  38.   <h1>Source code for searx.locales</h1><div class="highlight"><pre>
    39. 

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

  40. <span class="sd">&quot;&quot;&quot;</span>
    41. 

  41. <span class="sd">SearXNG’s locale data</span>
    42. 

  42. <span class="sd">=====================</span>
    43. 

  43. 

  44. <span class="sd">The variables :py:obj:`RTL_LOCALES` and :py:obj:`LOCALE_NAMES` are loaded from</span>
    45. 

  45. <span class="sd">:origin:`searx/data/locales.json` / see :py:obj:`locales_initialize` and</span>
    46. 

  46. <span class="sd">:ref:`update_locales.py`.</span>
    47. 

  47. 

  48. <span class="sd">.. hint::</span>
    49. 

  49. 

  50. <span class="sd">   Whenever the value of :py:obj:`ADDITIONAL_TRANSLATIONS` or</span>
    51. 

  51. <span class="sd">   :py:obj:`LOCALE_BEST_MATCH` is modified, the</span>
    52. 

  52. <span class="sd">   :origin:`searx/data/locales.json` needs to be rebuild::</span>
    53. 

  53. 

  54. <span class="sd">     ./manage data.locales</span>
    55. 

  55. 

  56. <span class="sd">SearXNG&#39;s locale codes</span>
    57. 

  57. <span class="sd">======================</span>
    58. 

  58. 

  59. <span class="sd">.. automodule:: searx.sxng_locales</span>
    60. 

  60. <span class="sd">   :members:</span>
    61. 

  61. 

  62. 

  63. <span class="sd">SearXNG’s locale implementations</span>
    64. 

  64. <span class="sd">================================</span>
    65. 

  65. <span class="sd">&quot;&quot;&quot;</span>
    66. 

  66. 

  67. <span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
    68. 

  68. 

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

  70. 

  71. <span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
    72. 

  72. <span class="kn">from</span><span class="w"> </span><span class="nn">babel.support</span><span class="w"> </span><span class="kn">import</span> <span class="n">Translations</span>
    73. 

  73. <span class="kn">import</span><span class="w"> </span><span class="nn">babel.languages</span>
    74. 

  74. <span class="kn">import</span><span class="w"> </span><span class="nn">babel.core</span>
    75. 

  75. <span class="kn">import</span><span class="w"> </span><span class="nn">flask_babel</span>
    76. 

  76. <span class="kn">from</span><span class="w"> </span><span class="nn">flask.ctx</span><span class="w"> </span><span class="kn">import</span> <span class="n">has_request_context</span>
    77. 

  77. 

  78. <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="p">(</span>
    79. 

  79.     <span class="n">data</span><span class="p">,</span>
    80. 

  80.     <span class="n">logger</span><span class="p">,</span>
    81. 

  81.     <span class="n">searx_dir</span><span class="p">,</span>
    82. 

  82. <span class="p">)</span>
    83. 

  83. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">sxng_request</span>
    84. 

  84. 

  85. <span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s1">&#39;locales&#39;</span><span class="p">)</span>
    86. 

  86. 

  87. 

  88. <span class="c1"># safe before monkey patching flask_babel.get_translations</span>
    89. 

  89. <span class="n">_flask_babel_get_translations</span> <span class="o">=</span> <span class="n">flask_babel</span><span class="o">.</span><span class="n">get_translations</span>
    90. 

  90. 

  91. <span class="n">LOCALE_NAMES</span> <span class="o">=</span> <span class="p">{}</span>
    92. 

  92. <span class="sd">&quot;&quot;&quot;Mapping of locales and their description.  Locales e.g. &#39;fr&#39; or &#39;pt-BR&#39; (see</span>
    93. 

  93. <span class="sd">:py:obj:`locales_initialize`).</span>
    94. 

  94. 

  95. <span class="sd">:meta hide-value:</span>
    96. 

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

  97. 

  98. <span class="n">RTL_LOCALES</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
    99. 

  99. <span class="sd">&quot;&quot;&quot;List of *Right-To-Left* locales e.g. &#39;he&#39; or &#39;fa-IR&#39; (see</span>
    100. 

  100. <span class="sd">:py:obj:`locales_initialize`).&quot;&quot;&quot;</span>
    101. 

  101. 

  102. <span class="n">ADDITIONAL_TRANSLATIONS</span> <span class="o">=</span> <span class="p">{</span>
    103. 

  103.     <span class="s2">&quot;dv&quot;</span><span class="p">:</span> <span class="s2">&quot;ދިވެހި (Dhivehi)&quot;</span><span class="p">,</span>
    104. 

  104.     <span class="s2">&quot;oc&quot;</span><span class="p">:</span> <span class="s2">&quot;Occitan&quot;</span><span class="p">,</span>
    105. 

  105.     <span class="s2">&quot;szl&quot;</span><span class="p">:</span> <span class="s2">&quot;Ślōnski (Silesian)&quot;</span><span class="p">,</span>
    106. 

  106.     <span class="s2">&quot;pap&quot;</span><span class="p">:</span> <span class="s2">&quot;Papiamento&quot;</span><span class="p">,</span>
    107. 

  107. <span class="p">}</span>
    108. 

  108. <span class="sd">&quot;&quot;&quot;Additional languages SearXNG has translations for but not supported by</span>
    109. 

  109. <span class="sd">python-babel (see :py:obj:`locales_initialize`).&quot;&quot;&quot;</span>
    110. 

  110. 

  111. <span class="n">LOCALE_BEST_MATCH</span> <span class="o">=</span> <span class="p">{</span>
    112. 

  112.     <span class="s2">&quot;dv&quot;</span><span class="p">:</span> <span class="s2">&quot;si&quot;</span><span class="p">,</span>
    113. 

  113.     <span class="s2">&quot;oc&quot;</span><span class="p">:</span> <span class="s1">&#39;fr-FR&#39;</span><span class="p">,</span>
    114. 

  114.     <span class="s2">&quot;szl&quot;</span><span class="p">:</span> <span class="s2">&quot;pl&quot;</span><span class="p">,</span>
    115. 

  115.     <span class="s2">&quot;nl-BE&quot;</span><span class="p">:</span> <span class="s2">&quot;nl&quot;</span><span class="p">,</span>
    116. 

  116.     <span class="s2">&quot;zh-HK&quot;</span><span class="p">:</span> <span class="s2">&quot;zh-Hant-TW&quot;</span><span class="p">,</span>
    117. 

  117.     <span class="s2">&quot;pap&quot;</span><span class="p">:</span> <span class="s2">&quot;pt-BR&quot;</span><span class="p">,</span>
    118. 

  118. <span class="p">}</span>
    119. 

  119. <span class="sd">&quot;&quot;&quot;Map a locale we do not have a translations for to a locale we have a</span>
    120. 

  120. <span class="sd">translation for.  By example: use Taiwan version of the translation for Hong</span>
    121. 

  121. <span class="sd">Kong.&quot;&quot;&quot;</span>
    122. 

  122. 

  123. 

  124. <span class="k">def</span><span class="w"> </span><span class="nf">localeselector</span><span class="p">():</span>
    125. 

  125.     <span class="n">locale</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
    126. 

  126.     <span class="k">if</span> <span class="n">has_request_context</span><span class="p">():</span>
    127. 

  127.         <span class="n">value</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">preferences</span><span class="o">.</span><span class="n">get_value</span><span class="p">(</span><span class="s1">&#39;locale&#39;</span><span class="p">)</span>
    128. 

  128.         <span class="k">if</span> <span class="n">value</span><span class="p">:</span>
    129. 

  129.             <span class="n">locale</span> <span class="o">=</span> <span class="n">value</span>
    130. 

  130. 

  131.     <span class="c1"># first, set the language that is not supported by babel</span>
    132. 

  132.     <span class="k">if</span> <span class="n">locale</span> <span class="ow">in</span> <span class="n">ADDITIONAL_TRANSLATIONS</span><span class="p">:</span>
    133. 

  133.         <span class="n">sxng_request</span><span class="o">.</span><span class="n">form</span><span class="p">[</span><span class="s1">&#39;use-translation&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">locale</span>
    134. 

  134. 

  135.     <span class="c1"># second, map locale to a value python-babel supports</span>
    136. 

  136.     <span class="n">locale</span> <span class="o">=</span> <span class="n">LOCALE_BEST_MATCH</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">locale</span><span class="p">,</span> <span class="n">locale</span><span class="p">)</span>
    137. 

  137. 

  138.     <span class="k">if</span> <span class="n">locale</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
    139. 

  139.         <span class="c1"># if there is an error loading the preferences</span>
    140. 

  140.         <span class="c1"># the locale is going to be &#39;&#39;</span>
    141. 

  141.         <span class="n">locale</span> <span class="o">=</span> <span class="s1">&#39;en&#39;</span>
    142. 

  142. 

  143.     <span class="c1"># babel uses underscore instead of hyphen.</span>
    144. 

  144.     <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</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>
    145. 

  145.     <span class="k">return</span> <span class="n">locale</span>
    146. 

  146. 

  147. 

  148. <div class="viewcode-block" id="get_translations">
    149. 

  149. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_translations">[docs]</a>
    150. 

  150. <span class="k">def</span><span class="w"> </span><span class="nf">get_translations</span><span class="p">():</span>
    151. 

  151. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Monkey patch of :py:obj:`flask_babel.get_translations`&quot;&quot;&quot;</span>
    152. 

  152.     <span class="k">if</span> <span class="n">has_request_context</span><span class="p">():</span>
    153. 

  153.         <span class="n">use_translation</span> <span class="o">=</span> <span class="n">sxng_request</span><span class="o">.</span><span class="n">form</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;use-translation&#39;</span><span class="p">)</span>
    154. 

  154.         <span class="k">if</span> <span class="n">use_translation</span> <span class="ow">in</span> <span class="n">ADDITIONAL_TRANSLATIONS</span><span class="p">:</span>
    155. 

  155.             <span class="n">babel_ext</span> <span class="o">=</span> <span class="n">flask_babel</span><span class="o">.</span><span class="n">current_app</span><span class="o">.</span><span class="n">extensions</span><span class="p">[</span><span class="s1">&#39;babel&#39;</span><span class="p">]</span>
    156. 

  156.             <span class="k">return</span> <span class="n">Translations</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">babel_ext</span><span class="o">.</span><span class="n">translation_directories</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">use_translation</span><span class="p">)</span>
    157. 

  157.     <span class="k">return</span> <span class="n">_flask_babel_get_translations</span><span class="p">()</span></div>
    158. 

  158. 

  159. 

  160. 

  161. <span class="n">_TR_LOCALES</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
    162. 

  162. 

  163. 

  164. <div class="viewcode-block" id="get_translation_locales">
    165. 

  165. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_translation_locales">[docs]</a>
    166. 

  166. <span class="k">def</span><span class="w"> </span><span class="nf">get_translation_locales</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
    167. 

  167. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns the list of translation locales (*underscore*).  The list is</span>
    168. 

  168. <span class="sd">    generated from the translation folders in :origin:`searx/translations`&quot;&quot;&quot;</span>
    169. 

  169. 

  170.     <span class="k">global</span> <span class="n">_TR_LOCALES</span>  <span class="c1"># pylint:disable=global-statement</span>
    171. 

  171.     <span class="k">if</span> <span class="n">_TR_LOCALES</span><span class="p">:</span>
    172. 

  172.         <span class="k">return</span> <span class="n">_TR_LOCALES</span>
    173. 

  173. 

  174.     <span class="n">tr_locales</span> <span class="o">=</span> <span class="p">[]</span>
    175. 

  175.     <span class="k">for</span> <span class="n">folder</span> <span class="ow">in</span> <span class="p">(</span><span class="n">Path</span><span class="p">(</span><span class="n">searx_dir</span><span class="p">)</span> <span class="o">/</span> <span class="s1">&#39;translations&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">iterdir</span><span class="p">():</span>
    176. 

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

  177.             <span class="k">continue</span>
    178. 

  178.         <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">folder</span> <span class="o">/</span> <span class="s1">&#39;LC_MESSAGES&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
    179. 

  179.             <span class="k">continue</span>
    180. 

  180.         <span class="n">tr_locales</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">folder</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
    181. 

  181.     <span class="n">_TR_LOCALES</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">tr_locales</span><span class="p">)</span>
    182. 

  182.     <span class="k">return</span> <span class="n">_TR_LOCALES</span></div>
    183. 

  183. 

  184. 

  185. 

  186. <div class="viewcode-block" id="locales_initialize">
    187. 

  187. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.locales_initialize">[docs]</a>
    188. 

  188. <span class="k">def</span><span class="w"> </span><span class="nf">locales_initialize</span><span class="p">():</span>
    189. 

  189. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Initialize locales environment of the SearXNG session.</span>
    190. 

  190. 

  191. <span class="sd">    - monkey patch :py:obj:`flask_babel.get_translations` by :py:obj:`get_translations`</span>
    192. 

  192. <span class="sd">    - init global names :py:obj:`LOCALE_NAMES`, :py:obj:`RTL_LOCALES`</span>
    193. 

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

  194.     <span class="n">flask_babel</span><span class="o">.</span><span class="n">get_translations</span> <span class="o">=</span> <span class="n">get_translations</span>
    195. 

  195.     <span class="n">LOCALE_NAMES</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">data</span><span class="o">.</span><span class="n">LOCALES</span><span class="p">[</span><span class="s2">&quot;LOCALE_NAMES&quot;</span><span class="p">])</span>
    196. 

  196.     <span class="n">RTL_LOCALES</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">data</span><span class="o">.</span><span class="n">LOCALES</span><span class="p">[</span><span class="s2">&quot;RTL_LOCALES&quot;</span><span class="p">])</span></div>
    197. 

  197. 

  198. 

  199. 

  200. <div class="viewcode-block" id="region_tag">
    201. 

  201. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.region_tag">[docs]</a>
    202. 

  202. <span class="k">def</span><span class="w"> </span><span class="nf">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">:</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
    203. 

  203. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns SearXNG&#39;s region tag from the locale (e.g. zh-TW , en-US).&quot;&quot;&quot;</span>
    204. 

  204.     <span class="k">if</span> <span class="ow">not</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
    205. 

  205.         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;babel.Locale </span><span class="si">%s</span><span class="s1">: missed a territory&#39;</span> <span class="o">%</span> <span class="n">locale</span><span class="p">)</span>
    206. 

  206.     <span class="k">return</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span></div>
    207. 

  207. 

  208. 

  209. 

  210. <div class="viewcode-block" id="language_tag">
    211. 

  211. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.language_tag">[docs]</a>
    212. 

  212. <span class="k">def</span><span class="w"> </span><span class="nf">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">:</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
    213. 

  213. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns SearXNG&#39;s language tag from the locale and if exits, the tag</span>
    214. 

  214. <span class="sd">    includes the script name (e.g. en, zh_Hant).</span>
    215. 

  215. <span class="sd">    &quot;&quot;&quot;</span>
    216. 

  216.     <span class="n">sxng_lang</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span>
    217. 

  217.     <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">script</span><span class="p">:</span>
    218. 

  218.         <span class="n">sxng_lang</span> <span class="o">+=</span> <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">locale</span><span class="o">.</span><span class="n">script</span>
    219. 

  219.     <span class="k">return</span> <span class="n">sxng_lang</span></div>
    220. 

  220. 

  221. 

  222. 

  223. <div class="viewcode-block" id="get_locale">
    224. 

  224. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_locale">[docs]</a>
    225. 

  225. <span class="k">def</span><span class="w"> </span><span class="nf">get_locale</span><span class="p">(</span><span class="n">locale_tag</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
    226. 

  226. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a :py:obj:`babel.Locale` object parsed from argument</span>
    227. 

  227. <span class="sd">    ``locale_tag``&quot;&quot;&quot;</span>
    228. 

  228.     <span class="k">try</span><span class="p">:</span>
    229. 

  229.         <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="n">locale_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>
    230. 

  230.         <span class="k">return</span> <span class="n">locale</span>
    231. 

  231. 

  232.     <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>
    233. 

  233.         <span class="k">return</span> <span class="kc">None</span></div>
    234. 

  234. 

  235. 

  236. 

  237. <div class="viewcode-block" id="get_official_locales">
    238. 

  238. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_official_locales">[docs]</a>
    239. 

  239. <span class="k">def</span><span class="w"> </span><span class="nf">get_official_locales</span><span class="p">(</span>
    240. 

  240.     <span class="n">territory</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">languages</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">regional</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">de_facto</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>
    241. 

  241. <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">set</span><span class="p">[</span><span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">]:</span>
    242. 

  242. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a list of :py:obj:`babel.Locale` with languages from</span>
    243. 

  243. <span class="sd">    :py:obj:`babel.languages.get_official_languages`.</span>
    244. 

  244. 

  245. <span class="sd">    :param territory: The territory (country or region) code.</span>
    246. 

  246. 

  247. <span class="sd">    :param languages: A list of language codes the languages from</span>
    248. 

  248. <span class="sd">      :py:obj:`babel.languages.get_official_languages` should be in</span>
    249. 

  249. <span class="sd">      (intersection).  If this argument is ``None``, all official languages in</span>
    250. 

  250. <span class="sd">      this territory are used.</span>
    251. 

  251. 

  252. <span class="sd">    :param regional: If the regional flag is set, then languages which are</span>
    253. 

  253. <span class="sd">      regionally official are also returned.</span>
    254. 

  254. 

  255. <span class="sd">    :param de_facto: If the de_facto flag is set to `False`, then languages</span>
    256. 

  256. <span class="sd">      which are “de facto” official are not returned.</span>
    257. 

  257. 

  258. <span class="sd">    &quot;&quot;&quot;</span>
    259. 

  259.     <span class="n">ret_val</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
    260. 

  260.     <span class="n">o_languages</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get_official_languages</span><span class="p">(</span><span class="n">territory</span><span class="p">,</span> <span class="n">regional</span><span class="o">=</span><span class="n">regional</span><span class="p">,</span> <span class="n">de_facto</span><span class="o">=</span><span class="n">de_facto</span><span class="p">)</span>
    261. 

  261. 

  262.     <span class="k">if</span> <span class="n">languages</span><span class="p">:</span>
    263. 

  263.         <span class="n">languages</span> <span class="o">=</span> <span class="p">[</span><span class="n">l</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">languages</span><span class="p">]</span>
    264. 

  264.         <span class="n">o_languages</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">l</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">o_languages</span> <span class="k">if</span> <span class="n">l</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="n">languages</span><span class="p">)</span>
    265. 

  265. 

  266.     <span class="k">for</span> <span class="n">lang</span> <span class="ow">in</span> <span class="n">o_languages</span><span class="p">:</span>
    267. 

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

  268.             <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="n">lang</span> <span class="o">+</span> <span class="s1">&#39;_&#39;</span> <span class="o">+</span> <span class="n">territory</span><span class="p">)</span>
    269. 

  269.             <span class="n">ret_val</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
    270. 

  270.         <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
    271. 

  271.             <span class="k">continue</span>
    272. 

  272. 

  273.     <span class="k">return</span> <span class="n">ret_val</span></div>
    274. 

  274. 

  275. 

  276. 

  277. <div class="viewcode-block" id="get_engine_locale">
    278. 

  278. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.get_engine_locale">[docs]</a>
    279. 

  279. <span class="k">def</span><span class="w"> </span><span class="nf">get_engine_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">,</span> <span class="n">engine_locales</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    280. 

  280. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return engine&#39;s language (aka locale) string that best fits to argument</span>
    281. 

  281. <span class="sd">    ``searxng_locale``.</span>
    282. 

  282. 

  283. <span class="sd">    Argument ``engine_locales`` is a python dict that maps *SearXNG locales* to</span>
    284. 

  284. <span class="sd">    corresponding *engine locales*::</span>
    285. 

  285. 

  286. <span class="sd">      &lt;engine&gt;: {</span>
    287. 

  287. <span class="sd">          # SearXNG string : engine-string</span>
    288. 

  288. <span class="sd">          &#39;ca-ES&#39;          : &#39;ca_ES&#39;,</span>
    289. 

  289. <span class="sd">          &#39;fr-BE&#39;          : &#39;fr_BE&#39;,</span>
    290. 

  290. <span class="sd">          &#39;fr-CA&#39;          : &#39;fr_CA&#39;,</span>
    291. 

  291. <span class="sd">          &#39;fr-CH&#39;          : &#39;fr_CH&#39;,</span>
    292. 

  292. <span class="sd">          &#39;fr&#39;             : &#39;fr_FR&#39;,</span>
    293. 

  293. <span class="sd">          ...</span>
    294. 

  294. <span class="sd">          &#39;pl-PL&#39;          : &#39;pl_PL&#39;,</span>
    295. 

  295. <span class="sd">          &#39;pt-PT&#39;          : &#39;pt_PT&#39;</span>
    296. 

  296. <span class="sd">          ..</span>
    297. 

  297. <span class="sd">          &#39;zh&#39;             : &#39;zh&#39;</span>
    298. 

  298. <span class="sd">          &#39;zh_Hans&#39;        : &#39;zh&#39;</span>
    299. 

  299. <span class="sd">          &#39;zh_Hant&#39;        : &#39;zh_TW&#39;</span>
    300. 

  300. <span class="sd">      }</span>
    301. 

  301. 

  302. <span class="sd">    .. hint::</span>
    303. 

  303. 

  304. <span class="sd">       The *SearXNG locale* string has to be known by babel!</span>
    305. 

  305. 

  306. <span class="sd">    If there is no direct 1:1 mapping, this functions tries to narrow down</span>
    307. 

  307. <span class="sd">    engine&#39;s language (locale).  If no value can be determined by these</span>
    308. 

  308. <span class="sd">    approximation attempts the ``default`` value is returned.</span>
    309. 

  309. 

  310. <span class="sd">    Assumptions:</span>
    311. 

  311. 

  312. <span class="sd">    A. When user select a language the results should be optimized according to</span>
    313. 

  313. <span class="sd">       the selected language.</span>
    314. 

  314. 

  315. <span class="sd">    B. When user select a language and a territory the results should be</span>
    316. 

  316. <span class="sd">       optimized with first priority on territory and second on language.</span>
    317. 

  317. 

  318. <span class="sd">    First approximation rule (*by territory*):</span>
    319. 

  319. 

  320. <span class="sd">      When the user selects a locale with territory (and a language), the</span>
    321. 

  321. <span class="sd">      territory has priority over the language.  If any of the official languages</span>
    322. 

  322. <span class="sd">      in the territory is supported by the engine (``engine_locales``) it will</span>
    323. 

  323. <span class="sd">      be used.</span>
    324. 

  324. 

  325. <span class="sd">    Second approximation rule (*by language*):</span>
    326. 

  326. 

  327. <span class="sd">      If &quot;First approximation rule&quot; brings no result or the user selects only a</span>
    328. 

  328. <span class="sd">      language without a territory.  Check in which territories the language</span>
    329. 

  329. <span class="sd">      has an official status and if one of these territories is supported by the</span>
    330. 

  330. <span class="sd">      engine.</span>
    331. 

  331. 

  332. <span class="sd">    &quot;&quot;&quot;</span>
    333. 

  333.     <span class="c1"># pylint: disable=too-many-branches, too-many-return-statements</span>
    334. 

  334. 

  335.     <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
    336. 

  336. 

  337.     <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    338. 

  338.         <span class="c1"># There was a 1:1 mapping (e.g. a region &quot;fr-BE --&gt; fr_BE&quot; or a language</span>
    339. 

  339.         <span class="c1"># &quot;zh --&gt; zh&quot;), no need to narrow language-script nor territory.</span>
    340. 

  340.         <span class="k">return</span> <span class="n">engine_locale</span>
    341. 

  341. 

  342.     <span class="k">try</span><span class="p">:</span>
    343. 

  343.         <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="n">searxng_locale</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">&#39;-&#39;</span><span class="p">)</span>
    344. 

  344.     <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>
    345. 

  345.         <span class="k">try</span><span class="p">:</span>
    346. 

  346.             <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="n">searxng_locale</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
    347. 

  347.         <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>
    348. 

  348.             <span class="k">return</span> <span class="n">default</span>
    349. 

  349. 

  350.     <span class="n">searxng_lang</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
    351. 

  351.     <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_lang</span><span class="p">)</span>
    352. 

  352.     <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    353. 

  353.         <span class="c1"># There was a 1:1 mapping (e.g. &quot;zh-HK --&gt; zh_Hant&quot; or &quot;zh-CN --&gt; zh_Hans&quot;)</span>
    354. 

  354.         <span class="k">return</span> <span class="n">engine_locale</span>
    355. 

  355. 

  356.     <span class="c1"># SearXNG&#39;s selected locale is not supported by the engine ..</span>
    357. 

  357. 

  358.     <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
    359. 

  359.         <span class="c1"># Try to narrow by *official* languages in the territory (??-XX).</span>
    360. 

  360. 

  361.         <span class="k">for</span> <span class="n">official_language</span> <span class="ow">in</span> <span class="n">babel</span><span class="o">.</span><span class="n">languages</span><span class="o">.</span><span class="n">get_official_languages</span><span class="p">(</span><span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">,</span> <span class="n">de_facto</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
    362. 

  362.             <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">official_language</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span>
    363. 

  363.             <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
    364. 

  364.             <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    365. 

  365.                 <span class="k">return</span> <span class="n">engine_locale</span>
    366. 

  366. 

  367.     <span class="c1"># Engine does not support one of the official languages in the territory or</span>
    368. 

  368.     <span class="c1"># there is only a language selected without a territory.</span>
    369. 

  369. 

  370.     <span class="c1"># Now lets have a look if the searxng_lang (the language selected by the</span>
    371. 

  371.     <span class="c1"># user) is a official language in other territories.  If so, check if</span>
    372. 

  372.     <span class="c1"># engine does support the searxng_lang in this other territory.</span>
    373. 

  373. 

  374.     <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span><span class="p">:</span>
    375. 

  375. 

  376.         <span class="n">terr_lang_dict</span> <span class="o">=</span> <span class="p">{}</span>
    377. 

  377.         <span class="k">for</span> <span class="n">territory</span><span class="p">,</span> <span class="n">langs</span> <span class="ow">in</span> <span class="n">babel</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">get_global</span><span class="p">(</span><span class="s2">&quot;territory_languages&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    378. 

  378.             <span class="k">if</span> <span class="ow">not</span> <span class="n">langs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_lang</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;official_status&#39;</span><span class="p">):</span>
    379. 

  379.                 <span class="k">continue</span>
    380. 

  380.             <span class="n">terr_lang_dict</span><span class="p">[</span><span class="n">territory</span><span class="p">]</span> <span class="o">=</span> <span class="n">langs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_lang</span><span class="p">)</span>
    381. 

  381. 

  382.         <span class="c1"># first: check fr-FR, de-DE .. is supported by the engine</span>
    383. 

  383.         <span class="c1"># exception: &#39;en&#39; --&gt; &#39;en-US&#39;</span>
    384. 

  384. 

  385.         <span class="n">territory</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
    386. 

  386.         <span class="k">if</span> <span class="n">territory</span> <span class="o">==</span> <span class="s1">&#39;EN&#39;</span><span class="p">:</span>
    387. 

  387.             <span class="n">territory</span> <span class="o">=</span> <span class="s1">&#39;US&#39;</span>
    388. 

  388. 

  389.         <span class="k">if</span> <span class="n">terr_lang_dict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">territory</span><span class="p">):</span>
    390. 

  390.             <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">territory</span>
    391. 

  391.             <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
    392. 

  392.             <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    393. 

  393.                 <span class="k">return</span> <span class="n">engine_locale</span>
    394. 

  394. 

  395.         <span class="c1"># second: sort by population_percent and take first match</span>
    396. 

  396. 

  397.         <span class="c1"># drawback of &quot;population percent&quot;: if there is a territory with a</span>
    398. 

  398.         <span class="c1">#   small number of people (e.g 100) but the majority speaks the</span>
    399. 

  399.         <span class="c1">#   language, then the percentage might be 100% (--&gt; 100 people) but in</span>
    400. 

  400.         <span class="c1">#   a different territory with more people (e.g. 10.000) where only 10%</span>
    401. 

  401.         <span class="c1">#   speak the language the total amount of speaker is higher (--&gt; 200</span>
    402. 

  402.         <span class="c1">#   people).</span>
    403. 

  403.         <span class="c1">#</span>
    404. 

  404.         <span class="c1">#   By example: The population of Saint-Martin is 33.000, of which 100%</span>
    405. 

  405.         <span class="c1">#   speak French, but this is less than the 30% of the approximately 2.5</span>
    406. 

  406.         <span class="c1">#   million Belgian citizens</span>
    407. 

  407.         <span class="c1">#</span>
    408. 

  408.         <span class="c1">#   - &#39;fr-MF&#39;, &#39;population_percent&#39;: 100.0, &#39;official_status&#39;: &#39;official&#39;</span>
    409. 

  409.         <span class="c1">#   - &#39;fr-BE&#39;, &#39;population_percent&#39;: 38.0, &#39;official_status&#39;: &#39;official&#39;</span>
    410. 

  410. 

  411.         <span class="n">terr_lang_list</span> <span class="o">=</span> <span class="p">[]</span>
    412. 

  412.         <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">terr_lang_dict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
    413. 

  413.             <span class="n">terr_lang_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">))</span>
    414. 

  414. 

  415.         <span class="k">for</span> <span class="n">territory</span><span class="p">,</span> <span class="n">_lang</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">terr_lang_list</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">item</span><span class="p">:</span> <span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="s1">&#39;population_percent&#39;</span><span class="p">],</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
    416. 

  416.             <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">language</span> <span class="o">+</span> <span class="s1">&#39;-&#39;</span> <span class="o">+</span> <span class="n">territory</span>
    417. 

  417.             <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">engine_locales</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
    418. 

  418.             <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    419. 

  419.                 <span class="k">return</span> <span class="n">engine_locale</span>
    420. 

  420. 

  421.     <span class="c1"># No luck: narrow by &quot;language from territory&quot; and &quot;territory from language&quot;</span>
    422. 

  422.     <span class="c1"># does not fit to a locale supported by the engine.</span>
    423. 

  423. 

  424.     <span class="k">if</span> <span class="n">engine_locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    425. 

  425.         <span class="n">engine_locale</span> <span class="o">=</span> <span class="n">default</span>
    426. 

  426. 

  427.     <span class="k">return</span> <span class="n">default</span></div>
    428. 

  428. 

  429. 

  430. 

  431. <div class="viewcode-block" id="match_locale">
    432. 

  432. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.match_locale">[docs]</a>
    433. 

  433. <span class="k">def</span><span class="w"> </span><span class="nf">match_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">locale_tag_list</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">fallback</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
    434. 

  434. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return tag from ``locale_tag_list`` that best fits to ``searxng_locale``.</span>
    435. 

  435. 

  436. <span class="sd">    :param str searxng_locale: SearXNG&#39;s internal representation of locale (de,</span>
    437. 

  437. <span class="sd">        de-DE, fr-BE, zh, zh-CN, zh-TW ..).</span>
    438. 

  438. 

  439. <span class="sd">    :param list locale_tag_list: The list of locale tags to select from</span>
    440. 

  440. 

  441. <span class="sd">    :param str fallback: fallback locale tag (if unset --&gt; ``None``)</span>
    442. 

  442. 

  443. <span class="sd">    The rules to find a match are implemented in :py:obj:`get_engine_locale`,</span>
    444. 

  444. <span class="sd">    the ``engine_locales`` is build up by :py:obj:`build_engine_locales`.</span>
    445. 

  445. 

  446. <span class="sd">    .. hint::</span>
    447. 

  447. 

  448. <span class="sd">       The *SearXNG locale* string and the members of ``locale_tag_list`` has to</span>
    449. 

  449. <span class="sd">       be known by babel!  The :py:obj:`ADDITIONAL_TRANSLATIONS` are used in the</span>
    450. 

  450. <span class="sd">       UI and are not known by babel --&gt; will be ignored.</span>
    451. 

  451. <span class="sd">    &quot;&quot;&quot;</span>
    452. 

  452. 

  453.     <span class="c1"># searxng_locale = &#39;es&#39;</span>
    454. 

  454.     <span class="c1"># locale_tag_list = [&#39;es-AR&#39;, &#39;es-ES&#39;, &#39;es-MX&#39;]</span>
    455. 

  455. 

  456.     <span class="k">if</span> <span class="ow">not</span> <span class="n">searxng_locale</span><span class="p">:</span>
    457. 

  457.         <span class="k">return</span> <span class="n">fallback</span>
    458. 

  458. 

  459.     <span class="n">locale</span> <span class="o">=</span> <span class="n">get_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">)</span>
    460. 

  460.     <span class="k">if</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    461. 

  461.         <span class="k">return</span> <span class="n">fallback</span>
    462. 

  462. 

  463.     <span class="c1"># normalize to a SearXNG locale that can be passed to get_engine_locale</span>
    464. 

  464. 

  465.     <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
    466. 

  466.     <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
    467. 

  467.         <span class="n">searxng_locale</span> <span class="o">=</span> <span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)</span>
    468. 

  468. 

  469.     <span class="c1"># clean up locale_tag_list</span>
    470. 

  470. 

  471.     <span class="n">tag_list</span> <span class="o">=</span> <span class="p">[]</span>
    472. 

  472.     <span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">locale_tag_list</span><span class="p">:</span>
    473. 

  473.         <span class="k">if</span> <span class="n">tag</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">&#39;all&#39;</span><span class="p">,</span> <span class="s1">&#39;auto&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">ADDITIONAL_TRANSLATIONS</span><span class="p">:</span>
    474. 

  474.             <span class="k">continue</span>
    475. 

  475.         <span class="n">tag_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
    476. 

  476. 

  477.     <span class="c1"># emulate fetch_traits</span>
    478. 

  478.     <span class="n">engine_locales</span> <span class="o">=</span> <span class="n">build_engine_locales</span><span class="p">(</span><span class="n">tag_list</span><span class="p">)</span>
    479. 

  479.     <span class="k">return</span> <span class="n">get_engine_locale</span><span class="p">(</span><span class="n">searxng_locale</span><span class="p">,</span> <span class="n">engine_locales</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">fallback</span><span class="p">)</span></div>
    480. 

  480. 

  481. 

  482. 

  483. <div class="viewcode-block" id="build_engine_locales">
    484. 

  484. <a class="viewcode-back" href="../../src/searx.locales.html#searx.locales.build_engine_locales">[docs]</a>
    485. 

  485. <span class="k">def</span><span class="w"> </span><span class="nf">build_engine_locales</span><span class="p">(</span><span class="n">tag_list</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span>
    486. 

  486. <span class="w">    </span><span class="sd">&quot;&quot;&quot;From a list of locale tags a dictionary is build that can be passed by</span>
    487. 

  487. <span class="sd">    argument ``engine_locales`` to :py:obj:`get_engine_locale`.  This function</span>
    488. 

  488. <span class="sd">    is mainly used by :py:obj:`match_locale` and is similar to what the</span>
    489. 

  489. <span class="sd">    ``fetch_traits(..)`` function of engines do.</span>
    490. 

  490. 

  491. <span class="sd">    If there are territory codes in the ``tag_list`` that have a *script code*</span>
    492. 

  492. <span class="sd">    additional keys are added to the returned dictionary.</span>
    493. 

  493. 

  494. <span class="sd">    .. code:: python</span>
    495. 

  495. 

  496. <span class="sd">       &gt;&gt;&gt; import locales</span>
    497. 

  497. <span class="sd">       &gt;&gt;&gt; engine_locales = locales.build_engine_locales([&#39;en&#39;, &#39;en-US&#39;, &#39;zh&#39;, &#39;zh-CN&#39;, &#39;zh-TW&#39;])</span>
    498. 

  498. <span class="sd">       &gt;&gt;&gt; engine_locales</span>
    499. 

  499. <span class="sd">       {</span>
    500. 

  500. <span class="sd">           &#39;en&#39;: &#39;en&#39;, &#39;en-US&#39;: &#39;en-US&#39;,</span>
    501. 

  501. <span class="sd">           &#39;zh&#39;: &#39;zh&#39;, &#39;zh-CN&#39;: &#39;zh-CN&#39;, &#39;zh_Hans&#39;: &#39;zh-CN&#39;,</span>
    502. 

  502. <span class="sd">           &#39;zh-TW&#39;: &#39;zh-TW&#39;, &#39;zh_Hant&#39;: &#39;zh-TW&#39;</span>
    503. 

  503. <span class="sd">       }</span>
    504. 

  504. <span class="sd">       &gt;&gt;&gt; get_engine_locale(&#39;zh-Hans&#39;, engine_locales)</span>
    505. 

  505. <span class="sd">       &#39;zh-CN&#39;</span>
    506. 

  506. 

  507. <span class="sd">    This function is a good example to understand the language/region model</span>
    508. 

  508. <span class="sd">    of SearXNG:</span>
    509. 

  509. 

  510. <span class="sd">      SearXNG only distinguishes between **search languages** and **search</span>
    511. 

  511. <span class="sd">      regions**, by adding the *script-tags*, languages with *script-tags* can</span>
    512. 

  512. <span class="sd">      be assigned to the **regions** that SearXNG supports.</span>
    513. 

  513. 

  514. <span class="sd">    &quot;&quot;&quot;</span>
    515. 

  515.     <span class="n">engine_locales</span> <span class="o">=</span> <span class="p">{}</span>
    516. 

  516. 

  517.     <span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">tag_list</span><span class="p">:</span>
    518. 

  518.         <span class="n">locale</span> <span class="o">=</span> <span class="n">get_locale</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span>
    519. 

  519.         <span class="k">if</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    520. 

  520.             <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;build_engine_locales: skip locale tag </span><span class="si">%s</span><span class="s2"> / unknown by babel&quot;</span><span class="p">,</span> <span class="n">tag</span><span class="p">)</span>
    521. 

  521.             <span class="k">continue</span>
    522. 

  522.         <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
    523. 

  523.             <span class="n">engine_locales</span><span class="p">[</span><span class="n">region_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">tag</span>
    524. 

  524.             <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">script</span><span class="p">:</span>
    525. 

  525.                 <span class="n">engine_locales</span><span class="p">[</span><span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">tag</span>
    526. 

  526.         <span class="k">else</span><span class="p">:</span>
    527. 

  527.             <span class="n">engine_locales</span><span class="p">[</span><span class="n">language_tag</span><span class="p">(</span><span class="n">locale</span><span class="p">)]</span> <span class="o">=</span> <span class="n">tag</span>
    528. 

  528.     <span class="k">return</span> <span class="n">engine_locales</span></div>
    529. 

  529. 

  530. </pre></div>
    531. 

  531. 

  532.             <div class="clearer"></div>
    533. 

  533.           </div>
    534. 

  534.         </div>
    535. 

  535.       </div>
    536. 

  536.   <span id="sidebar-top"></span>
    537. 

  537.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    538. 

  538.         <div class="sphinxsidebarwrapper">
    539. 

  539.   
    540. 

  540.     
    541. 

  541.             <p class="logo"><a href="../../index.html">
    542. 

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

  543.             </a></p>
    544. 

  544.   
    545. 

  545. 

  546. <h3><a href="../../index.html">Table of Contents</a></h3>
    547. 

  547. <ul>
    548. 

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

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

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

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

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

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

  554. </ul>
    555. 

  555. 

  556.   <h3>Project Links</h3>
    557. 

  557.   <ul>
    558. 

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

  559.   
    560. 

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

  561.   
    562. 

  562.     <li><a href="https://searx.space">Public instances</a>
    563. 

  563.   
    564. 

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

  565.   </ul><h3>Navigation</h3>
    566. 

  566. <ul>
    567. 

  567.   <li><a href="../../index.html">Overview</a>
    568. 

  568.     <ul>
    569. 

  569.       <li><a href="../index.html">Module code</a>
    570. 

  570.         
    571. 

  571.           
    572. 

  572.           </ul>
    573. 

  573.       </li>
    574. 

  574.     </ul>
    575. 

  575.   </li>
    576. 

  576. </ul>
    577. 

  577. <search id="searchbox" style="display: none" role="search">
    578. 

  578.   <h3 id="searchlabel">Quick search</h3>
    579. 

  579.     <div class="searchformwrapper">
    580. 

  580.     <form class="search" action="../../search.html" method="get">
    581. 

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

  582.       <input type="submit" value="Go" />
    583. 

  583.     </form>
    584. 

  584.     </div>
    585. 

  585. </search>
    586. 

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

  587.         </div>
    588. 

  588.       </div>
    589. 

  589.       <div class="clearer"></div>
    590. 

  590.     </div>
    591. 

  591.     <div class="footer" role="contentinfo">
    592. 

  592.     &#169; Copyright SearXNG team.
    593. 

  593.     </div>
    594. 

  594.   </body>
    595. 

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