weather.html 90 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745
  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.weather &#8212; SearXNG Documentation (2025.6.1+d63bdcd77)</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=7f7d2b46"></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.6.1+d63bdcd77" 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.6.1+d63bdcd77)</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.weather</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.weather</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;Implementations used for weather conditions and forecast.&quot;&quot;&quot;</span>
  38. <span class="c1"># pylint: disable=too-few-public-methods</span>
  39. <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>
  40. <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
  41. <span class="s2">&quot;symbol_url&quot;</span><span class="p">,</span>
  42. <span class="s2">&quot;Temperature&quot;</span><span class="p">,</span>
  43. <span class="s2">&quot;Pressure&quot;</span><span class="p">,</span>
  44. <span class="s2">&quot;WindSpeed&quot;</span><span class="p">,</span>
  45. <span class="s2">&quot;RelativeHumidity&quot;</span><span class="p">,</span>
  46. <span class="s2">&quot;Compass&quot;</span><span class="p">,</span>
  47. <span class="s2">&quot;WeatherConditionType&quot;</span><span class="p">,</span>
  48. <span class="s2">&quot;DateTime&quot;</span><span class="p">,</span>
  49. <span class="s2">&quot;GeoLocation&quot;</span><span class="p">,</span>
  50. <span class="p">]</span>
  51. <span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
  52. <span class="kn">import</span><span class="w"> </span><span class="nn">base64</span>
  53. <span class="kn">import</span><span class="w"> </span><span class="nn">datetime</span>
  54. <span class="kn">import</span><span class="w"> </span><span class="nn">dataclasses</span>
  55. <span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">quote_plus</span>
  56. <span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
  57. <span class="kn">import</span><span class="w"> </span><span class="nn">babel.numbers</span>
  58. <span class="kn">import</span><span class="w"> </span><span class="nn">babel.dates</span>
  59. <span class="kn">import</span><span class="w"> </span><span class="nn">babel.languages</span>
  60. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">network</span>
  61. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.cache</span><span class="w"> </span><span class="kn">import</span> <span class="n">ExpireCache</span><span class="p">,</span> <span class="n">ExpireCacheCfg</span>
  62. <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>
  63. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.wikidata_units</span><span class="w"> </span><span class="kn">import</span> <span class="n">convert_to_si</span><span class="p">,</span> <span class="n">convert_from_si</span>
  64. <span class="n">WEATHER_DATA_CACHE</span><span class="p">:</span> <span class="n">ExpireCache</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># type: ignore</span>
  65. <span class="sd">&quot;&quot;&quot;A simple cache for weather data (geo-locations, icons, ..)&quot;&quot;&quot;</span>
  66. <span class="n">YR_WEATHER_SYMBOL_URL</span> <span class="o">=</span> <span class="s2">&quot;https://raw.githubusercontent.com/nrkno/yr-weather-symbols/refs/heads/master/symbols/outline&quot;</span>
  67. <span class="k">def</span><span class="w"> </span><span class="nf">get_WEATHER_DATA_CACHE</span><span class="p">():</span>
  68. <span class="k">global</span> <span class="n">WEATHER_DATA_CACHE</span> <span class="c1"># pylint: disable=global-statement</span>
  69. <span class="k">if</span> <span class="n">WEATHER_DATA_CACHE</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  70. <span class="n">WEATHER_DATA_CACHE</span> <span class="o">=</span> <span class="n">ExpireCache</span><span class="o">.</span><span class="n">build_cache</span><span class="p">(</span>
  71. <span class="n">ExpireCacheCfg</span><span class="p">(</span>
  72. <span class="n">name</span><span class="o">=</span><span class="s2">&quot;WEATHER_DATA_CACHE&quot;</span><span class="p">,</span>
  73. <span class="n">MAX_VALUE_LEN</span><span class="o">=</span><span class="mi">1024</span> <span class="o">*</span> <span class="mi">200</span><span class="p">,</span> <span class="c1"># max. 200kB per icon (icons have most often 10-20kB)</span>
  74. <span class="n">MAXHOLD_TIME</span><span class="o">=</span><span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">7</span> <span class="o">*</span> <span class="mi">4</span><span class="p">,</span> <span class="c1"># 4 weeks</span>
  75. <span class="p">)</span>
  76. <span class="p">)</span>
  77. <span class="k">return</span> <span class="n">WEATHER_DATA_CACHE</span>
  78. <span class="k">def</span><span class="w"> </span><span class="nf">_get_sxng_locale_tag</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
  79. <span class="c1"># The function should return a locale (the sxng-tag: de-DE.en-US, ..) that</span>
  80. <span class="c1"># can later be used to format and convert measured values for the output of</span>
  81. <span class="c1"># weather data to the user.</span>
  82. <span class="c1">#</span>
  83. <span class="c1"># In principle, SearXNG only has two possible parameters for determining</span>
  84. <span class="c1"># the locale: the UI language or the search- language/region. Since the</span>
  85. <span class="c1"># conversion of weather data and time information is usually</span>
  86. <span class="c1"># region-specific, the UI language is not suitable.</span>
  87. <span class="c1">#</span>
  88. <span class="c1"># It would probably be ideal to use the user&#39;s geolocation, but this will</span>
  89. <span class="c1"># probably never be available in SearXNG (privacy critical).</span>
  90. <span class="c1">#</span>
  91. <span class="c1"># Therefore, as long as no &quot;better&quot; parameters are available, this function</span>
  92. <span class="c1"># returns a locale based on the search region.</span>
  93. <span class="c1"># pylint: disable=import-outside-toplevel,disable=cyclic-import</span>
  94. <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">query</span>
  95. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.preferences</span><span class="w"> </span><span class="kn">import</span> <span class="n">ClientPref</span>
  96. <span class="n">query</span> <span class="o">=</span> <span class="n">query</span><span class="o">.</span><span class="n">RawTextQuery</span><span class="p">(</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="s2">&quot;q&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">),</span> <span class="p">[])</span>
  97. <span class="k">if</span> <span class="n">query</span><span class="o">.</span><span class="n">languages</span> <span class="ow">and</span> <span class="n">query</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;all&quot;</span><span class="p">,</span> <span class="s2">&quot;auto&quot;</span><span class="p">]:</span>
  98. <span class="k">return</span> <span class="n">query</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  99. <span class="n">search_lang</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="s2">&quot;language&quot;</span><span class="p">)</span>
  100. <span class="k">if</span> <span class="n">search_lang</span> <span class="ow">and</span> <span class="n">search_lang</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;all&quot;</span><span class="p">,</span> <span class="s2">&quot;auto&quot;</span><span class="p">]:</span>
  101. <span class="k">return</span> <span class="n">search_lang</span>
  102. <span class="n">client_pref</span> <span class="o">=</span> <span class="n">ClientPref</span><span class="o">.</span><span class="n">from_http_request</span><span class="p">(</span><span class="n">sxng_request</span><span class="p">)</span>
  103. <span class="n">search_lang</span> <span class="o">=</span> <span class="n">client_pref</span><span class="o">.</span><span class="n">locale_tag</span>
  104. <span class="k">if</span> <span class="n">search_lang</span> <span class="ow">and</span> <span class="n">search_lang</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;all&quot;</span><span class="p">,</span> <span class="s2">&quot;auto&quot;</span><span class="p">]:</span>
  105. <span class="k">return</span> <span class="n">search_lang</span>
  106. <span class="k">return</span> <span class="s2">&quot;en&quot;</span>
  107. <div class="viewcode-block" id="symbol_url">
  108. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.symbol_url">[docs]</a>
  109. <span class="k">def</span><span class="w"> </span><span class="nf">symbol_url</span><span class="p">(</span><span class="n">condition</span><span class="p">:</span> <span class="n">WeatherConditionType</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>
  110. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns ``data:`` URL for the weather condition symbol or ``None`` if</span>
  111. <span class="sd"> the condition is not of type :py:obj:`WeatherConditionType`.</span>
  112. <span class="sd"> If symbol (SVG) is not already in the :py:obj:`WEATHER_DATA_CACHE` its</span>
  113. <span class="sd"> fetched from https://github.com/nrkno/yr-weather-symbols</span>
  114. <span class="sd"> &quot;&quot;&quot;</span>
  115. <span class="c1"># Symbols for darkmode/lightmode? .. and day/night symbols? .. for the</span>
  116. <span class="c1"># latter we need a geopoint (critical in sense of privacy)</span>
  117. <span class="n">fname</span> <span class="o">=</span> <span class="n">YR_WEATHER_SYMBOL_MAP</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">condition</span><span class="p">)</span>
  118. <span class="k">if</span> <span class="n">fname</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  119. <span class="k">return</span> <span class="kc">None</span>
  120. <span class="n">ctx</span> <span class="o">=</span> <span class="s2">&quot;weather_symbol_url&quot;</span>
  121. <span class="n">cache</span> <span class="o">=</span> <span class="n">get_WEATHER_DATA_CACHE</span><span class="p">()</span>
  122. <span class="n">origin_url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">YR_WEATHER_SYMBOL_URL</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">fname</span><span class="si">}</span><span class="s2">.svg&quot;</span>
  123. <span class="n">data_url</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">origin_url</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
  124. <span class="k">if</span> <span class="n">data_url</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
  125. <span class="k">return</span> <span class="n">data_url</span>
  126. <span class="n">response</span> <span class="o">=</span> <span class="n">network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">origin_url</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
  127. <span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
  128. <span class="n">mimetype</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">&#39;Content-Type&#39;</span><span class="p">]</span>
  129. <span class="n">data_url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;data:</span><span class="si">{</span><span class="n">mimetype</span><span class="si">}</span><span class="s2">;base64,</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">),</span><span class="w"> </span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
  130. <span class="n">cache</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">origin_url</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">data_url</span><span class="p">,</span> <span class="n">expire</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
  131. <span class="k">return</span> <span class="n">data_url</span></div>
  132. <div class="viewcode-block" id="GeoLocation">
  133. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.GeoLocation">[docs]</a>
  134. <span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span>
  135. <span class="k">class</span><span class="w"> </span><span class="nc">GeoLocation</span><span class="p">:</span>
  136. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Minimal implementation of Geocoding.&quot;&quot;&quot;</span>
  137. <span class="c1"># The type definition was based on the properties from the geocoding API of</span>
  138. <span class="c1"># open-meteo.</span>
  139. <span class="c1">#</span>
  140. <span class="c1"># - https://open-meteo.com/en/docs/geocoding-api</span>
  141. <span class="c1"># - https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</span>
  142. <span class="c1"># - https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2</span>
  143. <span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
  144. <span class="n">latitude</span><span class="p">:</span> <span class="nb">float</span> <span class="c1"># Geographical WGS84 coordinates of this location</span>
  145. <span class="n">longitude</span><span class="p">:</span> <span class="nb">float</span>
  146. <span class="n">elevation</span><span class="p">:</span> <span class="nb">float</span> <span class="c1"># Elevation above mean sea level of this location</span>
  147. <span class="n">country_code</span><span class="p">:</span> <span class="nb">str</span> <span class="c1"># 2-Character ISO-3166-1 alpha2 country code. E.g. DE for Germany</span>
  148. <span class="n">timezone</span><span class="p">:</span> <span class="nb">str</span> <span class="c1"># Time zone using time zone database definitions</span>
  149. <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  150. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
  151. <span class="k">def</span><span class="w"> </span><span class="nf">locale</span><span class="p">(</span><span class="bp">self</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="p">:</span>
  152. <span class="c1"># by region of the search language</span>
  153. <span class="n">sxng_tag</span> <span class="o">=</span> <span class="n">_get_sxng_locale_tag</span><span class="p">()</span>
  154. <span class="k">if</span> <span class="s2">&quot;-&quot;</span> <span class="ow">in</span> <span class="n">sxng_tag</span><span class="p">:</span>
  155. <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">_get_sxng_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>
  156. <span class="k">return</span> <span class="n">locale</span>
  157. <span class="c1"># by most popular language in the region (country code)</span>
  158. <span class="k">for</span> <span class="n">lang</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="bp">self</span><span class="o">.</span><span class="n">country_code</span><span class="p">):</span>
  159. <span class="k">try</span><span class="p">:</span>
  160. <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="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">lang</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">country_code</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  161. <span class="k">return</span> <span class="n">locale</span>
  162. <span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
  163. <span class="k">continue</span>
  164. <span class="c1"># No locale could be determined. This does not actually occur, but if</span>
  165. <span class="c1"># it does, the English language is used by default. But not region US.</span>
  166. <span class="c1"># US has some units that are only used in US but not in the rest of the</span>
  167. <span class="c1"># world (e.g. °F instead of °C)</span>
  168. <span class="k">return</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="p">(</span><span class="s2">&quot;en&quot;</span><span class="p">,</span> <span class="n">territory</span><span class="o">=</span><span class="s2">&quot;DE&quot;</span><span class="p">)</span>
  169. <div class="viewcode-block" id="GeoLocation.by_query">
  170. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.GeoLocation.by_query">[docs]</a>
  171. <span class="nd">@classmethod</span>
  172. <span class="k">def</span><span class="w"> </span><span class="nf">by_query</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">search_term</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">GeoLocation</span><span class="p">:</span>
  173. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Factory method to get a GeoLocation object by a search term. If no</span>
  174. <span class="sd"> location can be determined for the search term, a :py:obj:`ValueError`</span>
  175. <span class="sd"> is thrown.</span>
  176. <span class="sd"> &quot;&quot;&quot;</span>
  177. <span class="n">ctx</span> <span class="o">=</span> <span class="s2">&quot;weather_geolocation_by_query&quot;</span>
  178. <span class="n">cache</span> <span class="o">=</span> <span class="n">get_WEATHER_DATA_CACHE</span><span class="p">()</span>
  179. <span class="n">geo_props</span> <span class="o">=</span> <span class="n">cache</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">search_term</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
  180. <span class="k">if</span> <span class="ow">not</span> <span class="n">geo_props</span><span class="p">:</span>
  181. <span class="n">geo_props</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_query_open_meteo</span><span class="p">(</span><span class="n">search_term</span><span class="o">=</span><span class="n">search_term</span><span class="p">)</span>
  182. <span class="n">cache</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">search_term</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">geo_props</span><span class="p">,</span> <span class="n">expire</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ctx</span><span class="o">=</span><span class="n">ctx</span><span class="p">)</span>
  183. <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="o">**</span><span class="n">geo_props</span><span class="p">)</span></div>
  184. <span class="nd">@classmethod</span>
  185. <span class="k">def</span><span class="w"> </span><span class="nf">_query_open_meteo</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">search_term</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
  186. <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;https://geocoding-api.open-meteo.com/v1/search?name=</span><span class="si">{</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">search_term</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
  187. <span class="n">resp</span> <span class="o">=</span> <span class="n">network</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
  188. <span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span>
  189. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;unknown geo location: &#39;</span><span class="si">{</span><span class="n">search_term</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
  190. <span class="n">results</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;results&quot;</span><span class="p">)</span>
  191. <span class="k">if</span> <span class="ow">not</span> <span class="n">results</span><span class="p">:</span>
  192. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;unknown geo location: &#39;</span><span class="si">{</span><span class="n">search_term</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
  193. <span class="n">location</span> <span class="o">=</span> <span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  194. <span class="k">return</span> <span class="p">{</span><span class="n">field</span><span class="o">.</span><span class="n">name</span><span class="p">:</span> <span class="n">location</span><span class="p">[</span><span class="n">field</span><span class="o">.</span><span class="n">name</span><span class="p">]</span> <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">fields</span><span class="p">(</span><span class="bp">cls</span><span class="p">)}</span></div>
  195. <span class="n">DateTimeFormats</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;full&quot;</span><span class="p">,</span> <span class="s2">&quot;long&quot;</span><span class="p">,</span> <span class="s2">&quot;medium&quot;</span><span class="p">,</span> <span class="s2">&quot;short&quot;</span><span class="p">]</span>
  196. <div class="viewcode-block" id="DateTime">
  197. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.DateTime">[docs]</a>
  198. <span class="k">class</span><span class="w"> </span><span class="nc">DateTime</span><span class="p">:</span>
  199. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Class to represent date &amp; time. Essentially, it is a wrapper that</span>
  200. <span class="sd"> conveniently combines :py:obj:`datetime.datetime` and</span>
  201. <span class="sd"> :py:obj:`babel.dates.format_datetime`. A conversion of time zones is not</span>
  202. <span class="sd"> provided (in the current version).</span>
  203. <span class="sd"> &quot;&quot;&quot;</span>
  204. <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">time</span><span class="p">:</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">):</span>
  205. <span class="bp">self</span><span class="o">.</span><span class="n">datetime</span> <span class="o">=</span> <span class="n">time</span>
  206. <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  207. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">l10n</span><span class="p">()</span>
  208. <div class="viewcode-block" id="DateTime.l10n">
  209. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.DateTime.l10n">[docs]</a>
  210. <span class="k">def</span><span class="w"> </span><span class="nf">l10n</span><span class="p">(</span>
  211. <span class="bp">self</span><span class="p">,</span>
  212. <span class="n">fmt</span><span class="p">:</span> <span class="n">DateTimeFormats</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;medium&quot;</span><span class="p">,</span>
  213. <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="o">|</span> <span class="n">GeoLocation</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  214. <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
  215. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Localized representation of date &amp; time.&quot;&quot;&quot;</span>
  216. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">locale</span><span class="p">,</span> <span class="n">GeoLocation</span><span class="p">):</span>
  217. <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">locale</span><span class="p">()</span>
  218. <span class="k">elif</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  219. <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">_get_sxng_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>
  220. <span class="k">return</span> <span class="n">babel</span><span class="o">.</span><span class="n">dates</span><span class="o">.</span><span class="n">format_datetime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">datetime</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="n">fmt</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="n">locale</span><span class="p">)</span></div>
  221. </div>
  222. <div class="viewcode-block" id="Temperature">
  223. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.Temperature">[docs]</a>
  224. <span class="k">class</span><span class="w"> </span><span class="nc">Temperature</span><span class="p">:</span>
  225. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Class for converting temperature units and for string representation of</span>
  226. <span class="sd"> measured values.&quot;&quot;&quot;</span>
  227. <span class="n">si_name</span> <span class="o">=</span> <span class="s2">&quot;Q11579&quot;</span>
  228. <span class="n">Units</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;°C&quot;</span><span class="p">,</span> <span class="s2">&quot;°F&quot;</span><span class="p">,</span> <span class="s2">&quot;K&quot;</span><span class="p">]</span>
  229. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Supported temperature units.&quot;&quot;&quot;</span>
  230. <span class="n">units</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">get_args</span><span class="p">(</span><span class="n">Units</span><span class="p">))</span>
  231. <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">value</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span><span class="p">):</span>
  232. <span class="k">if</span> <span class="n">unit</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">units</span><span class="p">:</span>
  233. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;invalid unit: </span><span class="si">{</span><span class="n">unit</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  234. <span class="bp">self</span><span class="o">.</span><span class="n">si</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">convert_to_si</span><span class="p">(</span> <span class="c1"># pylint: disable=invalid-name</span>
  235. <span class="n">si_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si_name</span><span class="p">,</span>
  236. <span class="n">symbol</span><span class="o">=</span><span class="n">unit</span><span class="p">,</span>
  237. <span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">,</span>
  238. <span class="p">)</span>
  239. <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  240. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">l10n</span><span class="p">()</span>
  241. <span class="k">def</span><span class="w"> </span><span class="nf">value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
  242. <span class="k">return</span> <span class="n">convert_from_si</span><span class="p">(</span><span class="n">si_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si_name</span><span class="p">,</span> <span class="n">symbol</span><span class="o">=</span><span class="n">unit</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si</span><span class="p">)</span>
  243. <div class="viewcode-block" id="Temperature.l10n">
  244. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.Temperature.l10n">[docs]</a>
  245. <span class="k">def</span><span class="w"> </span><span class="nf">l10n</span><span class="p">(</span>
  246. <span class="bp">self</span><span class="p">,</span>
  247. <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  248. <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="o">|</span> <span class="n">GeoLocation</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  249. <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{value}</span><span class="s2"> </span><span class="si">{unit}</span><span class="s2">&quot;</span><span class="p">,</span>
  250. <span class="n">num_pattern</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;#,##0&quot;</span><span class="p">,</span>
  251. <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
  252. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Localized representation of a measured value.</span>
  253. <span class="sd"> If the ``unit`` is not set, an attempt is made to determine a ``unit``</span>
  254. <span class="sd"> matching the territory of the ``locale``. If the locale is not set, an</span>
  255. <span class="sd"> attempt is made to determine it from the HTTP request.</span>
  256. <span class="sd"> The value is converted into the respective unit before formatting.</span>
  257. <span class="sd"> The argument ``num_pattern`` is used to determine the string formatting</span>
  258. <span class="sd"> of the numerical value:</span>
  259. <span class="sd"> - https://babel.pocoo.org/en/latest/numbers.html#pattern-syntax</span>
  260. <span class="sd"> - https://unicode.org/reports/tr35/tr35-numbers.html#Number_Format_Patterns</span>
  261. <span class="sd"> The argument ``template`` specifies how the **string formatted** value</span>
  262. <span class="sd"> and unit are to be arranged.</span>
  263. <span class="sd"> - `Format Specification Mini-Language</span>
  264. <span class="sd"> &lt;https://docs.python.org/3/library/string.html#format-specification-mini-language&gt;`.</span>
  265. <span class="sd"> &quot;&quot;&quot;</span>
  266. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">locale</span><span class="p">,</span> <span class="n">GeoLocation</span><span class="p">):</span>
  267. <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">locale</span><span class="p">()</span>
  268. <span class="k">elif</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  269. <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">_get_sxng_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>
  270. <span class="k">if</span> <span class="n">unit</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># unit by territory</span>
  271. <span class="n">unit</span> <span class="o">=</span> <span class="s2">&quot;°C&quot;</span>
  272. <span class="k">if</span> <span class="n">locale</span><span class="o">.</span><span class="n">territory</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">&quot;US&quot;</span><span class="p">]:</span>
  273. <span class="n">unit</span> <span class="o">=</span> <span class="s2">&quot;°F&quot;</span>
  274. <span class="n">val_str</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="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="n">unit</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="n">num_pattern</span><span class="p">)</span>
  275. <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="n">val_str</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="n">unit</span><span class="p">)</span></div>
  276. </div>
  277. <div class="viewcode-block" id="Pressure">
  278. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.Pressure">[docs]</a>
  279. <span class="k">class</span><span class="w"> </span><span class="nc">Pressure</span><span class="p">:</span>
  280. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Class for converting pressure units and for string representation of</span>
  281. <span class="sd"> measured values.&quot;&quot;&quot;</span>
  282. <span class="n">si_name</span> <span class="o">=</span> <span class="s2">&quot;Q44395&quot;</span>
  283. <span class="n">Units</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;Pa&quot;</span><span class="p">,</span> <span class="s2">&quot;hPa&quot;</span><span class="p">,</span> <span class="s2">&quot;cm Hg&quot;</span><span class="p">,</span> <span class="s2">&quot;bar&quot;</span><span class="p">]</span>
  284. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Supported units.&quot;&quot;&quot;</span>
  285. <span class="n">units</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">get_args</span><span class="p">(</span><span class="n">Units</span><span class="p">))</span>
  286. <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">value</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span><span class="p">):</span>
  287. <span class="k">if</span> <span class="n">unit</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">units</span><span class="p">:</span>
  288. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;invalid unit: </span><span class="si">{</span><span class="n">unit</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  289. <span class="c1"># pylint: disable=invalid-name</span>
  290. <span class="bp">self</span><span class="o">.</span><span class="n">si</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">convert_to_si</span><span class="p">(</span><span class="n">si_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si_name</span><span class="p">,</span> <span class="n">symbol</span><span class="o">=</span><span class="n">unit</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">)</span>
  291. <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  292. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">l10n</span><span class="p">()</span>
  293. <span class="k">def</span><span class="w"> </span><span class="nf">value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
  294. <span class="k">return</span> <span class="n">convert_from_si</span><span class="p">(</span><span class="n">si_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si_name</span><span class="p">,</span> <span class="n">symbol</span><span class="o">=</span><span class="n">unit</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si</span><span class="p">)</span>
  295. <span class="k">def</span><span class="w"> </span><span class="nf">l10n</span><span class="p">(</span>
  296. <span class="bp">self</span><span class="p">,</span>
  297. <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  298. <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="o">|</span> <span class="n">GeoLocation</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  299. <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{value}</span><span class="s2"> </span><span class="si">{unit}</span><span class="s2">&quot;</span><span class="p">,</span>
  300. <span class="n">num_pattern</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;#,##0&quot;</span><span class="p">,</span>
  301. <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
  302. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">locale</span><span class="p">,</span> <span class="n">GeoLocation</span><span class="p">):</span>
  303. <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">locale</span><span class="p">()</span>
  304. <span class="k">elif</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  305. <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">_get_sxng_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>
  306. <span class="k">if</span> <span class="n">unit</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># unit by territory?</span>
  307. <span class="n">unit</span> <span class="o">=</span> <span class="s2">&quot;hPa&quot;</span>
  308. <span class="n">val_str</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="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="n">unit</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="n">num_pattern</span><span class="p">)</span>
  309. <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="n">val_str</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="n">unit</span><span class="p">)</span></div>
  310. <div class="viewcode-block" id="WindSpeed">
  311. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.WindSpeed">[docs]</a>
  312. <span class="k">class</span><span class="w"> </span><span class="nc">WindSpeed</span><span class="p">:</span>
  313. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Class for converting speed or velocity units and for string</span>
  314. <span class="sd"> representation of measured values.</span>
  315. <span class="sd"> .. hint::</span>
  316. <span class="sd"> Working with unit ``Bft`` (:py:obj:`searx.wikidata_units.Beaufort`) will</span>
  317. <span class="sd"> throw a :py:obj:`ValueError` for egative values or values greater 16 Bft</span>
  318. <span class="sd"> (55.6 m/s)</span>
  319. <span class="sd"> &quot;&quot;&quot;</span>
  320. <span class="n">si_name</span> <span class="o">=</span> <span class="s2">&quot;Q182429&quot;</span>
  321. <span class="n">Units</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;m/s&quot;</span><span class="p">,</span> <span class="s2">&quot;km/h&quot;</span><span class="p">,</span> <span class="s2">&quot;kn&quot;</span><span class="p">,</span> <span class="s2">&quot;mph&quot;</span><span class="p">,</span> <span class="s2">&quot;mi/h&quot;</span><span class="p">,</span> <span class="s2">&quot;Bft&quot;</span><span class="p">]</span>
  322. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Supported units.&quot;&quot;&quot;</span>
  323. <span class="n">units</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">get_args</span><span class="p">(</span><span class="n">Units</span><span class="p">))</span>
  324. <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">value</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span><span class="p">):</span>
  325. <span class="k">if</span> <span class="n">unit</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">units</span><span class="p">:</span>
  326. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;invalid unit: </span><span class="si">{</span><span class="n">unit</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  327. <span class="c1"># pylint: disable=invalid-name</span>
  328. <span class="bp">self</span><span class="o">.</span><span class="n">si</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">convert_to_si</span><span class="p">(</span><span class="n">si_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si_name</span><span class="p">,</span> <span class="n">symbol</span><span class="o">=</span><span class="n">unit</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">)</span>
  329. <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  330. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">l10n</span><span class="p">()</span>
  331. <span class="k">def</span><span class="w"> </span><span class="nf">value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
  332. <span class="k">return</span> <span class="n">convert_from_si</span><span class="p">(</span><span class="n">si_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si_name</span><span class="p">,</span> <span class="n">symbol</span><span class="o">=</span><span class="n">unit</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">si</span><span class="p">)</span>
  333. <span class="k">def</span><span class="w"> </span><span class="nf">l10n</span><span class="p">(</span>
  334. <span class="bp">self</span><span class="p">,</span>
  335. <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  336. <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="o">|</span> <span class="n">GeoLocation</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  337. <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{value}</span><span class="s2"> </span><span class="si">{unit}</span><span class="s2">&quot;</span><span class="p">,</span>
  338. <span class="n">num_pattern</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;#,##0&quot;</span><span class="p">,</span>
  339. <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
  340. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">locale</span><span class="p">,</span> <span class="n">GeoLocation</span><span class="p">):</span>
  341. <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">locale</span><span class="p">()</span>
  342. <span class="k">elif</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  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">_get_sxng_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>
  344. <span class="k">if</span> <span class="n">unit</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># unit by territory?</span>
  345. <span class="n">unit</span> <span class="o">=</span> <span class="s2">&quot;m/s&quot;</span>
  346. <span class="n">val_str</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="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="n">unit</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="n">num_pattern</span><span class="p">)</span>
  347. <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="n">val_str</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="n">unit</span><span class="p">)</span></div>
  348. <div class="viewcode-block" id="RelativeHumidity">
  349. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.RelativeHumidity">[docs]</a>
  350. <span class="k">class</span><span class="w"> </span><span class="nc">RelativeHumidity</span><span class="p">:</span>
  351. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Amount of relative humidity in the air. The unit is ``%``&quot;&quot;&quot;</span>
  352. <span class="n">Units</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;%&quot;</span><span class="p">]</span>
  353. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Supported unit.&quot;&quot;&quot;</span>
  354. <span class="n">units</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">get_args</span><span class="p">(</span><span class="n">Units</span><span class="p">))</span>
  355. <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">humidity</span><span class="p">:</span> <span class="nb">float</span><span class="p">):</span>
  356. <span class="bp">self</span><span class="o">.</span><span class="n">humidity</span> <span class="o">=</span> <span class="n">humidity</span>
  357. <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  358. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">l10n</span><span class="p">()</span>
  359. <span class="k">def</span><span class="w"> </span><span class="nf">value</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
  360. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">humidity</span>
  361. <span class="k">def</span><span class="w"> </span><span class="nf">l10n</span><span class="p">(</span>
  362. <span class="bp">self</span><span class="p">,</span>
  363. <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="o">|</span> <span class="n">GeoLocation</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  364. <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{value}{unit}</span><span class="s2">&quot;</span><span class="p">,</span>
  365. <span class="n">num_pattern</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;#,##0&quot;</span><span class="p">,</span>
  366. <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
  367. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">locale</span><span class="p">,</span> <span class="n">GeoLocation</span><span class="p">):</span>
  368. <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">locale</span><span class="p">()</span>
  369. <span class="k">elif</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  370. <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">_get_sxng_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>
  371. <span class="n">unit</span> <span class="o">=</span> <span class="s2">&quot;%&quot;</span>
  372. <span class="n">val_str</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="bp">self</span><span class="o">.</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="n">num_pattern</span><span class="p">)</span>
  373. <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="n">val_str</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="n">unit</span><span class="p">)</span></div>
  374. <div class="viewcode-block" id="Compass">
  375. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.Compass">[docs]</a>
  376. <span class="k">class</span><span class="w"> </span><span class="nc">Compass</span><span class="p">:</span>
  377. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Class for converting compass points and azimuth values (360°)&quot;&quot;&quot;</span>
  378. <span class="n">Units</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;°&quot;</span><span class="p">,</span> <span class="s2">&quot;Point&quot;</span><span class="p">]</span>
  379. <span class="n">Point</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span>
  380. <span class="s2">&quot;N&quot;</span><span class="p">,</span> <span class="s2">&quot;NNE&quot;</span><span class="p">,</span> <span class="s2">&quot;NE&quot;</span><span class="p">,</span> <span class="s2">&quot;ENE&quot;</span><span class="p">,</span> <span class="s2">&quot;E&quot;</span><span class="p">,</span> <span class="s2">&quot;ESE&quot;</span><span class="p">,</span> <span class="s2">&quot;SE&quot;</span><span class="p">,</span> <span class="s2">&quot;SSE&quot;</span><span class="p">,</span> <span class="s2">&quot;S&quot;</span><span class="p">,</span> <span class="s2">&quot;SSW&quot;</span><span class="p">,</span> <span class="s2">&quot;SW&quot;</span><span class="p">,</span> <span class="s2">&quot;WSW&quot;</span><span class="p">,</span> <span class="s2">&quot;W&quot;</span><span class="p">,</span> <span class="s2">&quot;WNW&quot;</span><span class="p">,</span> <span class="s2">&quot;NW&quot;</span><span class="p">,</span> <span class="s2">&quot;NNW&quot;</span>
  381. <span class="p">]</span>
  382. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Compass point type definition&quot;&quot;&quot;</span>
  383. <span class="n">TURN</span> <span class="o">=</span> <span class="mf">360.0</span>
  384. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Full turn (360°)&quot;&quot;&quot;</span>
  385. <span class="n">POINTS</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">get_args</span><span class="p">(</span><span class="n">Point</span><span class="p">))</span>
  386. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Compass points.&quot;&quot;&quot;</span>
  387. <span class="n">RANGE</span> <span class="o">=</span> <span class="n">TURN</span> <span class="o">/</span> <span class="nb">len</span><span class="p">(</span><span class="n">POINTS</span><span class="p">)</span>
  388. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Angle sector of a compass point&quot;&quot;&quot;</span>
  389. <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">azimuth</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="nb">int</span> <span class="o">|</span> <span class="n">Point</span><span class="p">):</span>
  390. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">azimuth</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
  391. <span class="k">if</span> <span class="n">azimuth</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">POINTS</span><span class="p">:</span>
  392. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Invalid compass point: </span><span class="si">{</span><span class="n">azimuth</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  393. <span class="n">azimuth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">POINTS</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">azimuth</span><span class="p">)</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">RANGE</span>
  394. <span class="bp">self</span><span class="o">.</span><span class="n">azimuth</span> <span class="o">=</span> <span class="n">azimuth</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">TURN</span>
  395. <span class="k">def</span><span class="w"> </span><span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  396. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">l10n</span><span class="p">()</span>
  397. <span class="k">def</span><span class="w"> </span><span class="nf">value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span><span class="p">):</span>
  398. <span class="k">if</span> <span class="n">unit</span> <span class="o">==</span> <span class="s2">&quot;Point&quot;</span><span class="p">:</span>
  399. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">point</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">azimuth</span><span class="p">)</span>
  400. <span class="k">if</span> <span class="n">unit</span> <span class="o">==</span> <span class="s2">&quot;°&quot;</span><span class="p">:</span>
  401. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">azimuth</span>
  402. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;unknown unit: </span><span class="si">{</span><span class="n">unit</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
  403. <div class="viewcode-block" id="Compass.point">
  404. <a class="viewcode-back" href="../../src/searx.weather.html#searx.weather.Compass.point">[docs]</a>
  405. <span class="nd">@classmethod</span>
  406. <span class="k">def</span><span class="w"> </span><span class="nf">point</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">azimuth</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Point</span><span class="p">:</span>
  407. <span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns the compass point to an azimuth value.&quot;&quot;&quot;</span>
  408. <span class="n">azimuth</span> <span class="o">=</span> <span class="n">azimuth</span> <span class="o">%</span> <span class="bp">cls</span><span class="o">.</span><span class="n">TURN</span>
  409. <span class="c1"># The angle sector of a compass point starts 1/2 sector range before</span>
  410. <span class="c1"># and after compass point (example: &quot;N&quot; goes from -11.25° to +11.25°)</span>
  411. <span class="n">azimuth</span> <span class="o">=</span> <span class="n">azimuth</span> <span class="o">-</span> <span class="bp">cls</span><span class="o">.</span><span class="n">RANGE</span> <span class="o">/</span> <span class="mi">2</span>
  412. <span class="n">idx</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">azimuth</span> <span class="o">//</span> <span class="bp">cls</span><span class="o">.</span><span class="n">RANGE</span><span class="p">)</span>
  413. <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">POINTS</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span></div>
  414. <span class="k">def</span><span class="w"> </span><span class="nf">l10n</span><span class="p">(</span>
  415. <span class="bp">self</span><span class="p">,</span>
  416. <span class="n">unit</span><span class="p">:</span> <span class="n">Units</span> <span class="o">=</span> <span class="s2">&quot;Point&quot;</span><span class="p">,</span>
  417. <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="o">|</span> <span class="n">GeoLocation</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
  418. <span class="n">template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{value}{unit}</span><span class="s2">&quot;</span><span class="p">,</span>
  419. <span class="n">num_pattern</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;#,##0&quot;</span><span class="p">,</span>
  420. <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
  421. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">locale</span><span class="p">,</span> <span class="n">GeoLocation</span><span class="p">):</span>
  422. <span class="n">locale</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">locale</span><span class="p">()</span>
  423. <span class="k">elif</span> <span class="n">locale</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  424. <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">_get_sxng_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>
  425. <span class="k">if</span> <span class="n">unit</span> <span class="o">==</span> <span class="s2">&quot;Point&quot;</span><span class="p">:</span>
  426. <span class="n">val_str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="n">unit</span><span class="p">)</span>
  427. <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="n">val_str</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
  428. <span class="n">val_str</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="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">(</span><span class="n">unit</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="n">num_pattern</span><span class="p">)</span>
  429. <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="n">val_str</span><span class="p">,</span> <span class="n">unit</span><span class="o">=</span><span class="n">unit</span><span class="p">)</span></div>
  430. <span class="n">WeatherConditionType</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span>
  431. <span class="c1"># The capitalized string goes into to i18n/l10n (en: &quot;Clear sky&quot; -&gt; de: &quot;wolkenloser Himmel&quot;)</span>
  432. <span class="s2">&quot;clear sky&quot;</span><span class="p">,</span>
  433. <span class="s2">&quot;cloudy&quot;</span><span class="p">,</span>
  434. <span class="s2">&quot;fair&quot;</span><span class="p">,</span>
  435. <span class="s2">&quot;fog&quot;</span><span class="p">,</span>
  436. <span class="s2">&quot;heavy rain and thunder&quot;</span><span class="p">,</span>
  437. <span class="s2">&quot;heavy rain showers and thunder&quot;</span><span class="p">,</span>
  438. <span class="s2">&quot;heavy rain showers&quot;</span><span class="p">,</span>
  439. <span class="s2">&quot;heavy rain&quot;</span><span class="p">,</span>
  440. <span class="s2">&quot;heavy sleet and thunder&quot;</span><span class="p">,</span>
  441. <span class="s2">&quot;heavy sleet showers and thunder&quot;</span><span class="p">,</span>
  442. <span class="s2">&quot;heavy sleet showers&quot;</span><span class="p">,</span>
  443. <span class="s2">&quot;heavy sleet&quot;</span><span class="p">,</span>
  444. <span class="s2">&quot;heavy snow and thunder&quot;</span><span class="p">,</span>
  445. <span class="s2">&quot;heavy snow showers and thunder&quot;</span><span class="p">,</span>
  446. <span class="s2">&quot;heavy snow showers&quot;</span><span class="p">,</span>
  447. <span class="s2">&quot;heavy snow&quot;</span><span class="p">,</span>
  448. <span class="s2">&quot;light rain and thunder&quot;</span><span class="p">,</span>
  449. <span class="s2">&quot;light rain showers and thunder&quot;</span><span class="p">,</span>
  450. <span class="s2">&quot;light rain showers&quot;</span><span class="p">,</span>
  451. <span class="s2">&quot;light rain&quot;</span><span class="p">,</span>
  452. <span class="s2">&quot;light sleet and thunder&quot;</span><span class="p">,</span>
  453. <span class="s2">&quot;light sleet showers and thunder&quot;</span><span class="p">,</span>
  454. <span class="s2">&quot;light sleet showers&quot;</span><span class="p">,</span>
  455. <span class="s2">&quot;light sleet&quot;</span><span class="p">,</span>
  456. <span class="s2">&quot;light snow and thunder&quot;</span><span class="p">,</span>
  457. <span class="s2">&quot;light snow showers and thunder&quot;</span><span class="p">,</span>
  458. <span class="s2">&quot;light snow showers&quot;</span><span class="p">,</span>
  459. <span class="s2">&quot;light snow&quot;</span><span class="p">,</span>
  460. <span class="s2">&quot;partly cloudy&quot;</span><span class="p">,</span>
  461. <span class="s2">&quot;rain and thunder&quot;</span><span class="p">,</span>
  462. <span class="s2">&quot;rain showers and thunder&quot;</span><span class="p">,</span>
  463. <span class="s2">&quot;rain showers&quot;</span><span class="p">,</span>
  464. <span class="s2">&quot;rain&quot;</span><span class="p">,</span>
  465. <span class="s2">&quot;sleet and thunder&quot;</span><span class="p">,</span>
  466. <span class="s2">&quot;sleet showers and thunder&quot;</span><span class="p">,</span>
  467. <span class="s2">&quot;sleet showers&quot;</span><span class="p">,</span>
  468. <span class="s2">&quot;sleet&quot;</span><span class="p">,</span>
  469. <span class="s2">&quot;snow and thunder&quot;</span><span class="p">,</span>
  470. <span class="s2">&quot;snow showers and thunder&quot;</span><span class="p">,</span>
  471. <span class="s2">&quot;snow showers&quot;</span><span class="p">,</span>
  472. <span class="s2">&quot;snow&quot;</span><span class="p">,</span>
  473. <span class="p">]</span>
  474. <span class="sd">&quot;&quot;&quot;Standardized designations for weather conditions. The designators were</span>
  475. <span class="sd">taken from a collaboration between NRK and Norwegian Meteorological Institute</span>
  476. <span class="sd">(yr.no_). `Weather symbols`_ can be assigned to the identifiers</span>
  477. <span class="sd">(weathericons_) and they are included in the translation (i18n/l10n</span>
  478. <span class="sd">:origin:`searx/searxng.msg`).</span>
  479. <span class="sd">.. _yr.no: https://www.yr.no/en</span>
  480. <span class="sd">.. _Weather symbols: https://github.com/nrkno/yr-weather-symbols</span>
  481. <span class="sd">.. _weathericons: https://github.com/metno/weathericons</span>
  482. <span class="sd">&quot;&quot;&quot;</span>
  483. <span class="n">YR_WEATHER_SYMBOL_MAP</span> <span class="o">=</span> <span class="p">{</span>
  484. <span class="s2">&quot;clear sky&quot;</span><span class="p">:</span> <span class="s2">&quot;01d&quot;</span><span class="p">,</span> <span class="c1"># 01d clearsky_day</span>
  485. <span class="s2">&quot;fair&quot;</span><span class="p">:</span> <span class="s2">&quot;02d&quot;</span><span class="p">,</span> <span class="c1"># 02d fair_day</span>
  486. <span class="s2">&quot;partly cloudy&quot;</span><span class="p">:</span> <span class="s2">&quot;03d&quot;</span><span class="p">,</span> <span class="c1"># 03d partlycloudy_day</span>
  487. <span class="s2">&quot;cloudy&quot;</span><span class="p">:</span> <span class="s2">&quot;04&quot;</span><span class="p">,</span> <span class="c1"># 04 cloudy</span>
  488. <span class="s2">&quot;light rain showers&quot;</span><span class="p">:</span> <span class="s2">&quot;40d&quot;</span><span class="p">,</span> <span class="c1"># 40d lightrainshowers_day</span>
  489. <span class="s2">&quot;rain showers&quot;</span><span class="p">:</span> <span class="s2">&quot;05d&quot;</span><span class="p">,</span> <span class="c1"># 05d rainshowers_day</span>
  490. <span class="s2">&quot;heavy rain showers&quot;</span><span class="p">:</span> <span class="s2">&quot;41d&quot;</span><span class="p">,</span> <span class="c1"># 41d heavyrainshowers_day</span>
  491. <span class="s2">&quot;light rain showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;24d&quot;</span><span class="p">,</span> <span class="c1"># 24d lightrainshowersandthunder_day</span>
  492. <span class="s2">&quot;rain showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;06d&quot;</span><span class="p">,</span> <span class="c1"># 06d rainshowersandthunder_day</span>
  493. <span class="s2">&quot;heavy rain showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;25d&quot;</span><span class="p">,</span> <span class="c1"># 25d heavyrainshowersandthunder_day</span>
  494. <span class="s2">&quot;light sleet showers&quot;</span><span class="p">:</span> <span class="s2">&quot;42d&quot;</span><span class="p">,</span> <span class="c1"># 42d lightsleetshowers_day</span>
  495. <span class="s2">&quot;sleet showers&quot;</span><span class="p">:</span> <span class="s2">&quot;07d&quot;</span><span class="p">,</span> <span class="c1"># 07d sleetshowers_day</span>
  496. <span class="s2">&quot;heavy sleet showers&quot;</span><span class="p">:</span> <span class="s2">&quot;43d&quot;</span><span class="p">,</span> <span class="c1"># 43d heavysleetshowers_day</span>
  497. <span class="s2">&quot;light sleet showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;26d&quot;</span><span class="p">,</span> <span class="c1"># 26d lightssleetshowersandthunder_day</span>
  498. <span class="s2">&quot;sleet showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;20d&quot;</span><span class="p">,</span> <span class="c1"># 20d sleetshowersandthunder_day</span>
  499. <span class="s2">&quot;heavy sleet showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;27d&quot;</span><span class="p">,</span> <span class="c1"># 27d heavysleetshowersandthunder_day</span>
  500. <span class="s2">&quot;light snow showers&quot;</span><span class="p">:</span> <span class="s2">&quot;44d&quot;</span><span class="p">,</span> <span class="c1"># 44d lightsnowshowers_day</span>
  501. <span class="s2">&quot;snow showers&quot;</span><span class="p">:</span> <span class="s2">&quot;08d&quot;</span><span class="p">,</span> <span class="c1"># 08d snowshowers_day</span>
  502. <span class="s2">&quot;heavy snow showers&quot;</span><span class="p">:</span> <span class="s2">&quot;45d&quot;</span><span class="p">,</span> <span class="c1"># 45d heavysnowshowers_day</span>
  503. <span class="s2">&quot;light snow showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;28d&quot;</span><span class="p">,</span> <span class="c1"># 28d lightssnowshowersandthunder_day</span>
  504. <span class="s2">&quot;snow showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;21d&quot;</span><span class="p">,</span> <span class="c1"># 21d snowshowersandthunder_day</span>
  505. <span class="s2">&quot;heavy snow showers and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;29d&quot;</span><span class="p">,</span> <span class="c1"># 29d heavysnowshowersandthunder_day</span>
  506. <span class="s2">&quot;light rain&quot;</span><span class="p">:</span> <span class="s2">&quot;46&quot;</span><span class="p">,</span> <span class="c1"># 46 lightrain</span>
  507. <span class="s2">&quot;rain&quot;</span><span class="p">:</span> <span class="s2">&quot;09&quot;</span><span class="p">,</span> <span class="c1"># 09 rain</span>
  508. <span class="s2">&quot;heavy rain&quot;</span><span class="p">:</span> <span class="s2">&quot;10&quot;</span><span class="p">,</span> <span class="c1"># 10 heavyrain</span>
  509. <span class="s2">&quot;light rain and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;30&quot;</span><span class="p">,</span> <span class="c1"># 30 lightrainandthunder</span>
  510. <span class="s2">&quot;rain and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;22&quot;</span><span class="p">,</span> <span class="c1"># 22 rainandthunder</span>
  511. <span class="s2">&quot;heavy rain and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;11&quot;</span><span class="p">,</span> <span class="c1"># 11 heavyrainandthunder</span>
  512. <span class="s2">&quot;light sleet&quot;</span><span class="p">:</span> <span class="s2">&quot;47&quot;</span><span class="p">,</span> <span class="c1"># 47 lightsleet</span>
  513. <span class="s2">&quot;sleet&quot;</span><span class="p">:</span> <span class="s2">&quot;12&quot;</span><span class="p">,</span> <span class="c1"># 12 sleet</span>
  514. <span class="s2">&quot;heavy sleet&quot;</span><span class="p">:</span> <span class="s2">&quot;48&quot;</span><span class="p">,</span> <span class="c1"># 48 heavysleet</span>
  515. <span class="s2">&quot;light sleet and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;31&quot;</span><span class="p">,</span> <span class="c1"># 31 lightsleetandthunder</span>
  516. <span class="s2">&quot;sleet and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;23&quot;</span><span class="p">,</span> <span class="c1"># 23 sleetandthunder</span>
  517. <span class="s2">&quot;heavy sleet and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;32&quot;</span><span class="p">,</span> <span class="c1"># 32 heavysleetandthunder</span>
  518. <span class="s2">&quot;light snow&quot;</span><span class="p">:</span> <span class="s2">&quot;49&quot;</span><span class="p">,</span> <span class="c1"># 49 lightsnow</span>
  519. <span class="s2">&quot;snow&quot;</span><span class="p">:</span> <span class="s2">&quot;13&quot;</span><span class="p">,</span> <span class="c1"># 13 snow</span>
  520. <span class="s2">&quot;heavy snow&quot;</span><span class="p">:</span> <span class="s2">&quot;50&quot;</span><span class="p">,</span> <span class="c1"># 50 heavysnow</span>
  521. <span class="s2">&quot;light snow and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;33&quot;</span><span class="p">,</span> <span class="c1"># 33 lightsnowandthunder</span>
  522. <span class="s2">&quot;snow and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;14&quot;</span><span class="p">,</span> <span class="c1"># 14 snowandthunder</span>
  523. <span class="s2">&quot;heavy snow and thunder&quot;</span><span class="p">:</span> <span class="s2">&quot;34&quot;</span><span class="p">,</span> <span class="c1"># 34 heavysnowandthunder</span>
  524. <span class="s2">&quot;fog&quot;</span><span class="p">:</span> <span class="s2">&quot;15&quot;</span><span class="p">,</span> <span class="c1"># 15 fog</span>
  525. <span class="p">}</span>
  526. <span class="sd">&quot;&quot;&quot;Map a :py:obj:`WeatherConditionType` to a `YR weather symbol`_</span>
  527. <span class="sd">.. code::</span>
  528. <span class="sd"> base_url = &quot;https://raw.githubusercontent.com/nrkno/yr-weather-symbols/refs/heads/master/symbols&quot;</span>
  529. <span class="sd"> icon_url = f&quot;{base_url}/outline/{YR_WEATHER_SYMBOL_MAP[&#39;sleet showers&#39;]}.svg&quot;</span>
  530. <span class="sd">.. _YR weather symbol: https://github.com/nrkno/yr-weather-symbols/blob/master/locales/en.json</span>
  531. <span class="sd">&quot;&quot;&quot;</span>
  532. <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
  533. <span class="c1"># test: fetch all symbols of the type catalog ..</span>
  534. <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">typing</span><span class="o">.</span><span class="n">get_args</span><span class="p">(</span><span class="n">WeatherConditionType</span><span class="p">):</span>
  535. <span class="n">symbol_url</span><span class="p">(</span><span class="n">condition</span><span class="o">=</span><span class="n">c</span><span class="p">)</span>
  536. <span class="n">_cache</span> <span class="o">=</span> <span class="n">get_WEATHER_DATA_CACHE</span><span class="p">()</span>
  537. <span class="n">title</span> <span class="o">=</span> <span class="s2">&quot;cached weather condition symbols&quot;</span>
  538. <span class="nb">print</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
  539. <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">title</span><span class="p">))</span>
  540. <span class="nb">print</span><span class="p">(</span><span class="n">_cache</span><span class="o">.</span><span class="n">state</span><span class="p">()</span><span class="o">.</span><span class="n">report</span><span class="p">())</span>
  541. <span class="nb">print</span><span class="p">()</span>
  542. <span class="n">title</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;properties of </span><span class="si">{</span><span class="n">_cache</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span>
  543. <span class="nb">print</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
  544. <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=&quot;</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">title</span><span class="p">))</span>
  545. <span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">_cache</span><span class="o">.</span><span class="n">properties</span><span class="p">))</span> <span class="c1"># type: ignore</span>
  546. </pre></div>
  547. <div class="clearer"></div>
  548. </div>
  549. </div>
  550. </div>
  551. <span id="sidebar-top"></span>
  552. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  553. <div class="sphinxsidebarwrapper">
  554. <p class="logo"><a href="../../index.html">
  555. <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  556. </a></p>
  557. <h3><a href="../../index.html">Table of Contents</a></h3>
  558. <ul>
  559. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
  560. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
  561. <li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
  562. <li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
  563. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
  564. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
  565. </ul>
  566. <h3>Project Links</h3>
  567. <ul>
  568. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  569. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  570. <li><a href="https://searx.space">Public instances</a>
  571. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  572. </ul><h3>Navigation</h3>
  573. <ul>
  574. <li><a href="../../index.html">Overview</a>
  575. <ul>
  576. <li><a href="../index.html">Module code</a>
  577. </ul>
  578. </li>
  579. </ul>
  580. </li>
  581. </ul>
  582. <search id="searchbox" style="display: none" role="search">
  583. <h3 id="searchlabel">Quick search</h3>
  584. <div class="searchformwrapper">
  585. <form class="search" action="../../search.html" method="get">
  586. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  587. <input type="submit" value="Go" />
  588. </form>
  589. </div>
  590. </search>
  591. <script>document.getElementById('searchbox').style.display = "block"</script>
  592. </div>
  593. </div>
  594. <div class="clearer"></div>
  595. </div>
  596. <div class="footer" role="contentinfo">
  597. &#169; Copyright SearXNG team.
  598. </div>
  599. </body>
  600. </html>