unit_converter.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  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.plugins.unit_converter &#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" accesskey="U">Module code</a> &#187;</li>
  28. <li class="nav-item nav-item-this"><a href="">searx.plugins.unit_converter</a></li>
  29. </ul>
  30. </div>
  31. <div class="document">
  32. <div class="documentwrapper">
  33. <div class="bodywrapper">
  34. <div class="body" role="main">
  35. <h1>Source code for searx.plugins.unit_converter</h1><div class="highlight"><pre>
  36. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
  37. <span class="sd">&quot;&quot;&quot;A plugin for converting measured values from one unit to another unit (a</span>
  38. <span class="sd">unit converter).</span>
  39. <span class="sd">The plugin looks up the symbols (given in the query term) in a list of</span>
  40. <span class="sd">converters, each converter is one item in the list (compare</span>
  41. <span class="sd">:py:obj:`ADDITIONAL_UNITS`). If the symbols are ambiguous, the matching units</span>
  42. <span class="sd">of measurement are evaluated. The weighting in the evaluation results from the</span>
  43. <span class="sd">sorting of the :py:obj:`list of unit converters&lt;symbol_to_si&gt;`.</span>
  44. <span class="sd">&quot;&quot;&quot;</span>
  45. <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>
  46. <span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
  47. <span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
  48. <span class="kn">import</span><span class="w"> </span><span class="nn">babel.numbers</span>
  49. <span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span><span class="p">,</span> <span class="n">get_locale</span>
  50. <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">data</span>
  51. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">PluginInfo</span>
  52. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineResults</span>
  53. <span class="k">if</span> <span class="n">typing</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
  54. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.search</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchWithPlugins</span>
  55. <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>
  56. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.plugins</span><span class="w"> </span><span class="kn">import</span> <span class="n">PluginCfg</span>
  57. <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
  58. <span class="n">description</span> <span class="o">=</span> <span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
  59. <span class="n">plugin_id</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
  60. <span class="n">preference_section</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
  61. <span class="n">CONVERT_KEYWORDS</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;in&quot;</span><span class="p">,</span> <span class="s2">&quot;to&quot;</span><span class="p">,</span> <span class="s2">&quot;as&quot;</span><span class="p">]</span>
  62. <div class="viewcode-block" id="SXNGPlugin">
  63. <a class="viewcode-back" href="../../../dev/plugins/unit_converter.html#searx.plugins.unit_converter.SXNGPlugin">[docs]</a>
  64. <span class="k">class</span><span class="w"> </span><span class="nc">SXNGPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
  65. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Convert between units. The result is displayed in area for the</span>
  66. <span class="sd"> &quot;answers&quot;.</span>
  67. <span class="sd"> &quot;&quot;&quot;</span>
  68. <span class="nb">id</span> <span class="o">=</span> <span class="s2">&quot;unit_converter&quot;</span>
  69. <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plg_cfg</span><span class="p">:</span> <span class="s2">&quot;PluginCfg&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
  70. <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">plg_cfg</span><span class="p">)</span>
  71. <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
  72. <span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
  73. <span class="n">name</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Unit converter plugin&quot;</span><span class="p">),</span>
  74. <span class="n">description</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s2">&quot;Convert between units&quot;</span><span class="p">),</span>
  75. <span class="n">preference_section</span><span class="o">=</span><span class="s2">&quot;general&quot;</span><span class="p">,</span>
  76. <span class="p">)</span>
  77. <div class="viewcode-block" id="SXNGPlugin.post_search">
  78. <a class="viewcode-back" href="../../../dev/plugins/unit_converter.html#searx.plugins.unit_converter.SXNGPlugin.post_search">[docs]</a>
  79. <span class="k">def</span><span class="w"> </span><span class="nf">post_search</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="s2">&quot;SXNG_Request&quot;</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="s2">&quot;SearchWithPlugins&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</span><span class="p">:</span>
  80. <span class="n">results</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
  81. <span class="c1"># only convert between units on the first page</span>
  82. <span class="k">if</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
  83. <span class="k">return</span> <span class="n">results</span>
  84. <span class="n">query</span> <span class="o">=</span> <span class="n">search</span><span class="o">.</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span>
  85. <span class="n">query_parts</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">)</span>
  86. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">query_parts</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">3</span><span class="p">:</span>
  87. <span class="k">return</span> <span class="n">results</span>
  88. <span class="k">for</span> <span class="n">query_part</span> <span class="ow">in</span> <span class="n">query_parts</span><span class="p">:</span>
  89. <span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">CONVERT_KEYWORDS</span><span class="p">:</span>
  90. <span class="k">if</span> <span class="n">query_part</span> <span class="o">==</span> <span class="n">keyword</span><span class="p">:</span>
  91. <span class="n">from_query</span><span class="p">,</span> <span class="n">to_query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
  92. <span class="n">target_val</span> <span class="o">=</span> <span class="n">_parse_text_and_convert</span><span class="p">(</span><span class="n">from_query</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span> <span class="n">to_query</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
  93. <span class="k">if</span> <span class="n">target_val</span><span class="p">:</span>
  94. <span class="n">results</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">results</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="n">target_val</span><span class="p">))</span>
  95. <span class="k">return</span> <span class="n">results</span></div>
  96. </div>
  97. <span class="c1"># inspired from https://stackoverflow.com/a/42475086</span>
  98. <span class="n">RE_MEASURE</span> <span class="o">=</span> <span class="sa">r</span><span class="s1">&#39;&#39;&#39;</span>
  99. <span class="s1">(?P&lt;sign&gt;[-+]?) # +/- or nothing for positive</span>
  100. <span class="s1">(\s*) # separator: white space or nothing</span>
  101. <span class="s1">(?P&lt;number&gt;[\d\.,]*) # number: 1,000.00 (en) or 1.000,00 (de)</span>
  102. <span class="s1">(?P&lt;E&gt;[eE][-+]?\d+)? # scientific notation: e(+/-)2 (*10^2)</span>
  103. <span class="s1">(\s*) # separator: white space or nothing</span>
  104. <span class="s1">(?P&lt;unit&gt;\S+) # unit of measure</span>
  105. <span class="s1">&#39;&#39;&#39;</span>
  106. <span class="n">ADDITIONAL_UNITS</span> <span class="o">=</span> <span class="p">[</span>
  107. <span class="p">{</span>
  108. <span class="s2">&quot;si_name&quot;</span><span class="p">:</span> <span class="s2">&quot;Q11579&quot;</span><span class="p">,</span>
  109. <span class="s2">&quot;symbol&quot;</span><span class="p">:</span> <span class="s2">&quot;°C&quot;</span><span class="p">,</span>
  110. <span class="s2">&quot;to_si&quot;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">val</span><span class="p">:</span> <span class="n">val</span> <span class="o">+</span> <span class="mf">273.15</span><span class="p">,</span>
  111. <span class="s2">&quot;from_si&quot;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">val</span><span class="p">:</span> <span class="n">val</span> <span class="o">-</span> <span class="mf">273.15</span><span class="p">,</span>
  112. <span class="p">},</span>
  113. <span class="p">{</span>
  114. <span class="s2">&quot;si_name&quot;</span><span class="p">:</span> <span class="s2">&quot;Q11579&quot;</span><span class="p">,</span>
  115. <span class="s2">&quot;symbol&quot;</span><span class="p">:</span> <span class="s2">&quot;°F&quot;</span><span class="p">,</span>
  116. <span class="s2">&quot;to_si&quot;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">val</span><span class="p">:</span> <span class="p">(</span><span class="n">val</span> <span class="o">+</span> <span class="mf">459.67</span><span class="p">)</span> <span class="o">*</span> <span class="mi">5</span> <span class="o">/</span> <span class="mi">9</span><span class="p">,</span>
  117. <span class="s2">&quot;from_si&quot;</span><span class="p">:</span> <span class="k">lambda</span> <span class="n">val</span><span class="p">:</span> <span class="p">(</span><span class="n">val</span> <span class="o">*</span> <span class="mi">9</span> <span class="o">/</span> <span class="mi">5</span><span class="p">)</span> <span class="o">-</span> <span class="mf">459.67</span><span class="p">,</span>
  118. <span class="p">},</span>
  119. <span class="p">]</span>
  120. <span class="sd">&quot;&quot;&quot;Additional items to convert from a measure unit to a SI unit (vice versa).</span>
  121. <span class="sd">.. code:: python</span>
  122. <span class="sd"> {</span>
  123. <span class="sd"> &quot;si_name&quot;: &quot;Q11579&quot;, # Wikidata item ID of the SI unit (Kelvin)</span>
  124. <span class="sd"> &quot;symbol&quot;: &quot;°C&quot;, # symbol of the measure unit</span>
  125. <span class="sd"> &quot;to_si&quot;: lambda val: val + 273.15, # convert measure value (val) to SI unit</span>
  126. <span class="sd"> &quot;from_si&quot;: lambda val: val - 273.15, # convert SI value (val) measure unit</span>
  127. <span class="sd"> },</span>
  128. <span class="sd"> {</span>
  129. <span class="sd"> &quot;si_name&quot;: &quot;Q11573&quot;,</span>
  130. <span class="sd"> &quot;symbol&quot;: &quot;mi&quot;,</span>
  131. <span class="sd"> &quot;to_si&quot;: 1609.344, # convert measure value (val) to SI unit</span>
  132. <span class="sd"> &quot;from_si&quot;: 1 / 1609.344 # convert SI value (val) measure unit</span>
  133. <span class="sd"> },</span>
  134. <span class="sd">The values of ``to_si`` and ``from_si`` can be of :py:obj:`float` (a multiplier)</span>
  135. <span class="sd">or a callable_ (val in / converted value returned).</span>
  136. <span class="sd">.. _callable: https://docs.python.org/3/glossary.html#term-callable</span>
  137. <span class="sd">&quot;&quot;&quot;</span>
  138. <span class="n">ALIAS_SYMBOLS</span> <span class="o">=</span> <span class="p">{</span>
  139. <span class="s1">&#39;°C&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;C&#39;</span><span class="p">,),</span>
  140. <span class="s1">&#39;°F&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;F&#39;</span><span class="p">,),</span>
  141. <span class="s1">&#39;mi&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s1">&#39;L&#39;</span><span class="p">,),</span>
  142. <span class="p">}</span>
  143. <span class="sd">&quot;&quot;&quot;Alias symbols for known unit of measure symbols / by example::</span>
  144. <span class="sd"> &#39;°C&#39;: (&#39;C&#39;, ...), # list of alias symbols for °C (Q69362731)</span>
  145. <span class="sd"> &#39;°F&#39;: (&#39;F&#39;, ...), # list of alias symbols for °F (Q99490479)</span>
  146. <span class="sd"> &#39;mi&#39;: (&#39;L&#39;,), # list of alias symbols for mi (Q253276)</span>
  147. <span class="sd">&quot;&quot;&quot;</span>
  148. <span class="n">SYMBOL_TO_SI</span> <span class="o">=</span> <span class="p">[]</span>
  149. <div class="viewcode-block" id="symbol_to_si">
  150. <a class="viewcode-back" href="../../../dev/plugins/unit_converter.html#searx.plugins.unit_converter.symbol_to_si">[docs]</a>
  151. <span class="k">def</span><span class="w"> </span><span class="nf">symbol_to_si</span><span class="p">():</span>
  152. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Generates a list of tuples, each tuple is a measure unit and the fields</span>
  153. <span class="sd"> in the tuple are:</span>
  154. <span class="sd"> 0. Symbol of the measure unit (e.g. &#39;mi&#39; for measure unit &#39;miles&#39; Q253276)</span>
  155. <span class="sd"> 1. SI name of the measure unit (e.g. Q11573 for SI unit &#39;metre&#39;)</span>
  156. <span class="sd"> 2. Factor to get SI value from measure unit (e.g. 1mi is equal to SI 1m</span>
  157. <span class="sd"> multiplied by 1609.344)</span>
  158. <span class="sd"> 3. Factor to get measure value from from SI value (e.g. SI 100m is equal to</span>
  159. <span class="sd"> 100mi divided by 1609.344)</span>
  160. <span class="sd"> The returned list is sorted, the first items are created from</span>
  161. <span class="sd"> ``WIKIDATA_UNITS``, the second group of items is build from</span>
  162. <span class="sd"> :py:obj:`ADDITIONAL_UNITS` and items created from :py:obj:`ALIAS_SYMBOLS`.</span>
  163. <span class="sd"> If you search this list for a symbol, then a match with a symbol from</span>
  164. <span class="sd"> Wikidata has the highest weighting (first hit in the list), followed by the</span>
  165. <span class="sd"> symbols from the :py:obj:`ADDITIONAL_UNITS` and the lowest weighting is</span>
  166. <span class="sd"> given to the symbols resulting from the aliases :py:obj:`ALIAS_SYMBOLS`.</span>
  167. <span class="sd"> &quot;&quot;&quot;</span>
  168. <span class="k">global</span> <span class="n">SYMBOL_TO_SI</span> <span class="c1"># pylint: disable=global-statement</span>
  169. <span class="k">if</span> <span class="n">SYMBOL_TO_SI</span><span class="p">:</span>
  170. <span class="k">return</span> <span class="n">SYMBOL_TO_SI</span>
  171. <span class="c1"># filter out units which can&#39;t be normalized to a SI unit and filter out</span>
  172. <span class="c1"># units without a symbol / arcsecond does not have a symbol</span>
  173. <span class="c1"># https://www.wikidata.org/wiki/Q829073</span>
  174. <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">WIKIDATA_UNITS</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
  175. <span class="k">if</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;to_si_factor&#39;</span><span class="p">]</span> <span class="ow">and</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">]:</span>
  176. <span class="n">SYMBOL_TO_SI</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
  177. <span class="p">(</span>
  178. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">],</span>
  179. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;si_name&#39;</span><span class="p">],</span>
  180. <span class="mi">1</span> <span class="o">/</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;to_si_factor&#39;</span><span class="p">],</span> <span class="c1"># from_si</span>
  181. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;to_si_factor&#39;</span><span class="p">],</span> <span class="c1"># to_si</span>
  182. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">],</span>
  183. <span class="p">)</span>
  184. <span class="p">)</span>
  185. <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">ADDITIONAL_UNITS</span><span class="p">:</span>
  186. <span class="n">SYMBOL_TO_SI</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
  187. <span class="p">(</span>
  188. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">],</span>
  189. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;si_name&#39;</span><span class="p">],</span>
  190. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;from_si&#39;</span><span class="p">],</span>
  191. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;to_si&#39;</span><span class="p">],</span>
  192. <span class="n">item</span><span class="p">[</span><span class="s1">&#39;symbol&#39;</span><span class="p">],</span>
  193. <span class="p">)</span>
  194. <span class="p">)</span>
  195. <span class="n">alias_items</span> <span class="o">=</span> <span class="p">[]</span>
  196. <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">SYMBOL_TO_SI</span><span class="p">:</span>
  197. <span class="k">for</span> <span class="n">alias</span> <span class="ow">in</span> <span class="n">ALIAS_SYMBOLS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">()):</span>
  198. <span class="n">alias_items</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
  199. <span class="p">(</span>
  200. <span class="n">alias</span><span class="p">,</span>
  201. <span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span>
  202. <span class="n">item</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="c1"># from_si</span>
  203. <span class="n">item</span><span class="p">[</span><span class="mi">3</span><span class="p">],</span> <span class="c1"># to_si</span>
  204. <span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="c1"># origin unit</span>
  205. <span class="p">)</span>
  206. <span class="p">)</span>
  207. <span class="n">SYMBOL_TO_SI</span> <span class="o">=</span> <span class="n">SYMBOL_TO_SI</span> <span class="o">+</span> <span class="n">alias_items</span>
  208. <span class="k">return</span> <span class="n">SYMBOL_TO_SI</span></div>
  209. <span class="k">def</span><span class="w"> </span><span class="nf">_parse_text_and_convert</span><span class="p">(</span><span class="n">from_query</span><span class="p">,</span> <span class="n">to_query</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>
  210. <span class="c1"># pylint: disable=too-many-branches, too-many-locals</span>
  211. <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">from_query</span> <span class="ow">and</span> <span class="n">to_query</span><span class="p">):</span>
  212. <span class="k">return</span> <span class="kc">None</span>
  213. <span class="n">measured</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">RE_MEASURE</span><span class="p">,</span> <span class="n">from_query</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">VERBOSE</span><span class="p">)</span>
  214. <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">measured</span> <span class="ow">and</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;number&#39;</span><span class="p">),</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;unit&#39;</span><span class="p">)):</span>
  215. <span class="k">return</span> <span class="kc">None</span>
  216. <span class="c1"># Symbols are not unique, if there are several hits for the from-unit, then</span>
  217. <span class="c1"># the correct one must be determined by comparing it with the to-unit</span>
  218. <span class="c1"># https://github.com/searxng/searxng/pull/3378#issuecomment-2080974863</span>
  219. <span class="c1"># first: collecting possible units</span>
  220. <span class="n">source_list</span><span class="p">,</span> <span class="n">target_list</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
  221. <span class="k">for</span> <span class="n">symbol</span><span class="p">,</span> <span class="n">si_name</span><span class="p">,</span> <span class="n">from_si</span><span class="p">,</span> <span class="n">to_si</span><span class="p">,</span> <span class="n">orig_symbol</span> <span class="ow">in</span> <span class="n">symbol_to_si</span><span class="p">():</span>
  222. <span class="k">if</span> <span class="n">symbol</span> <span class="o">==</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;unit&#39;</span><span class="p">):</span>
  223. <span class="n">source_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">si_name</span><span class="p">,</span> <span class="n">to_si</span><span class="p">))</span>
  224. <span class="k">if</span> <span class="n">symbol</span> <span class="o">==</span> <span class="n">to_query</span><span class="p">:</span>
  225. <span class="n">target_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">si_name</span><span class="p">,</span> <span class="n">from_si</span><span class="p">,</span> <span class="n">orig_symbol</span><span class="p">))</span>
  226. <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">source_list</span> <span class="ow">and</span> <span class="n">target_list</span><span class="p">):</span>
  227. <span class="k">return</span> <span class="kc">None</span>
  228. <span class="n">source_to_si</span> <span class="o">=</span> <span class="n">target_from_si</span> <span class="o">=</span> <span class="n">target_symbol</span> <span class="o">=</span> <span class="kc">None</span>
  229. <span class="c1"># second: find the right unit by comparing list of from-units with list of to-units</span>
  230. <span class="k">for</span> <span class="n">source</span> <span class="ow">in</span> <span class="n">source_list</span><span class="p">:</span>
  231. <span class="k">for</span> <span class="n">target</span> <span class="ow">in</span> <span class="n">target_list</span><span class="p">:</span>
  232. <span class="k">if</span> <span class="n">source</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">target</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span> <span class="c1"># compare si_name</span>
  233. <span class="n">source_to_si</span> <span class="o">=</span> <span class="n">source</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
  234. <span class="n">target_from_si</span> <span class="o">=</span> <span class="n">target</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
  235. <span class="n">target_symbol</span> <span class="o">=</span> <span class="n">target</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
  236. <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">source_to_si</span> <span class="ow">and</span> <span class="n">target_from_si</span><span class="p">):</span>
  237. <span class="k">return</span> <span class="kc">None</span>
  238. <span class="n">_locale</span> <span class="o">=</span> <span class="n">get_locale</span><span class="p">()</span> <span class="ow">or</span> <span class="s1">&#39;en_US&#39;</span>
  239. <span class="n">value</span> <span class="o">=</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;sign&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;number&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="p">(</span><span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;E&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
  240. <span class="n">value</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">parse_decimal</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">_locale</span><span class="p">)</span>
  241. <span class="c1"># convert value to SI unit</span>
  242. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source_to_si</span><span class="p">,</span> <span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="nb">int</span><span class="p">)):</span>
  243. <span class="n">value</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">*</span> <span class="n">source_to_si</span>
  244. <span class="k">else</span><span class="p">:</span>
  245. <span class="n">value</span> <span class="o">=</span> <span class="n">source_to_si</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
  246. <span class="c1"># convert value from SI unit to target unit</span>
  247. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">target_from_si</span><span class="p">,</span> <span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="nb">int</span><span class="p">)):</span>
  248. <span class="n">value</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">*</span> <span class="n">target_from_si</span>
  249. <span class="k">else</span><span class="p">:</span>
  250. <span class="n">value</span> <span class="o">=</span> <span class="n">target_from_si</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
  251. <span class="k">if</span> <span class="n">measured</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;E&#39;</span><span class="p">):</span>
  252. <span class="c1"># when incoming notation is scientific, outgoing notation is scientific</span>
  253. <span class="n">result</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">format_scientific</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">_locale</span><span class="p">)</span>
  254. <span class="k">else</span><span class="p">:</span>
  255. <span class="n">result</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">numbers</span><span class="o">.</span><span class="n">format_decimal</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">_locale</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="s1">&#39;#,##0.##########;-#&#39;</span><span class="p">)</span>
  256. <span class="k">return</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">result</span><span class="si">}</span><span class="s1"> </span><span class="si">{</span><span class="n">target_symbol</span><span class="si">}</span><span class="s1">&#39;</span>
  257. </pre></div>
  258. <div class="clearer"></div>
  259. </div>
  260. </div>
  261. </div>
  262. <span id="sidebar-top"></span>
  263. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  264. <div class="sphinxsidebarwrapper">
  265. <p class="logo"><a href="../../../index.html">
  266. <img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  267. </a></p>
  268. <h3><a href="../../../index.html">Table of Contents</a></h3>
  269. <ul>
  270. <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
  271. <li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
  272. <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
  273. <li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
  274. <li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
  275. <li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
  276. </ul>
  277. <h3>Project Links</h3>
  278. <ul>
  279. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  280. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  281. <li><a href="https://searx.space">Public instances</a>
  282. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  283. </ul><h3>Navigation</h3>
  284. <ul>
  285. <li><a href="../../../index.html">Overview</a>
  286. <ul>
  287. <li><a href="../../index.html">Module code</a>
  288. </ul>
  289. </li>
  290. </ul>
  291. </li>
  292. </ul>
  293. <search id="searchbox" style="display: none" role="search">
  294. <h3 id="searchlabel">Quick search</h3>
  295. <div class="searchformwrapper">
  296. <form class="search" action="../../../search.html" method="get">
  297. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  298. <input type="submit" value="Go" />
  299. </form>
  300. </div>
  301. </search>
  302. <script>document.getElementById('searchbox').style.display = "block"</script>
  303. </div>
  304. </div>
  305. <div class="clearer"></div>
  306. </div>
  307. <div class="footer" role="contentinfo">
  308. &#169; Copyright SearXNG team.
  309. </div>
  310. </body>
  311. </html>