Cutlery/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2025-11-20 21:43:12 -05:00
Code Issues Packages Projects Releases Wiki Activity
searxng/_modules/searx/search/processors/online_currency.html

236 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en" data-content_root="../../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>searx.search.processors.online_currency &#8212; SearXNG Documentation (2025.11.18+576c8ca99)</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../../../_static/searxng.css?v=52e4ff28" />
<script src="../../../../_static/documentation_options.js?v=31b10172"></script>
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.11.18+576c8ca99" src="../../../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">SearXNG Documentation (2025.11.18+576c8ca99)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../search.html" accesskey="U">searx.search</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">searx.search.processors.online_currency</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for searx.search.processors.online_currency</h1><div class="highlight"><pre>
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
<span class="sd">&quot;&quot;&quot;Processor used for ``online_currency`` engines.&quot;&quot;&quot;</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">unicodedata</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">flask_babel</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.data</span><span class="w"> </span><span class="kn">import</span> <span class="n">CURRENCIES</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.online</span><span class="w"> </span><span class="kn">import</span> <span class="n">OnlineProcessor</span><span class="p">,</span> <span class="n">OnlineParams</span>
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.abstract</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineProcessor</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchQuery</span>
<span class="n">search_syntax</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;.*?(\d+(?:\.\d+)?) ([^.0-9]+) (?:in|to) ([^.0-9]+)&quot;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">I</span><span class="p">)</span>
<span class="sd">&quot;&quot;&quot;Search syntax used for from/to currency (e.g. ``10 usd to eur``)&quot;&quot;&quot;</span>
<div class="viewcode-block" id="CurrenciesParams">
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_currency.CurrenciesParams">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">CurrenciesParams</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Currencies request parameters.&quot;&quot;&quot;</span>
<span class="n">amount</span><span class="p">:</span> <span class="nb">float</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Currency amount to be converted&quot;&quot;&quot;</span>
<span class="n">to_iso4217</span><span class="p">:</span> <span class="nb">str</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;ISO_4217_ alpha code of the currency used as the basis for conversion.</span>
<span class="sd"> .. _ISO_4217: https://en.wikipedia.org/wiki/ISO_4217</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">from_iso4217</span><span class="p">:</span> <span class="nb">str</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;ISO_4217_ alpha code of the currency to be converted.&quot;&quot;&quot;</span>
<span class="n">from_name</span><span class="p">:</span> <span class="nb">str</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Name of the currency used as the basis for conversion.&quot;&quot;&quot;</span>
<span class="n">to_name</span><span class="p">:</span> <span class="nb">str</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Name of the currency of the currency to be converted.&quot;&quot;&quot;</span></div>
<div class="viewcode-block" id="OnlineCurrenciesParams">
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_currency.OnlineCurrenciesParams">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineCurrenciesParams</span><span class="p">(</span><span class="n">CurrenciesParams</span><span class="p">,</span> <span class="n">OnlineParams</span><span class="p">):</span> <span class="c1"># pylint: disable=duplicate-bases</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Request parameters of a ``online_currency`` engine.&quot;&quot;&quot;</span></div>
<div class="viewcode-block" id="OnlineCurrencyProcessor">
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_currency.OnlineCurrencyProcessor">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineCurrencyProcessor</span><span class="p">(</span><span class="n">OnlineProcessor</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Processor class used by ``online_currency`` engines.&quot;&quot;&quot;</span>
<span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;online_currency&quot;</span>
<div class="viewcode-block" id="OnlineCurrencyProcessor.get_params">
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_currency.OnlineCurrencyProcessor.get_params">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">:</span> <span class="s2">&quot;SearchQuery&quot;</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">OnlineCurrenciesParams</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns a dictionary with the :ref:`request params &lt;engine request</span>
<span class="sd"> online_currency&gt;` (:py:obj:`OnlineCurrenciesParams`). ``None`` is</span>
<span class="sd"> returned if the search query does not match :py:obj:`search_syntax`.&quot;&quot;&quot;</span>
<span class="n">online_params</span><span class="p">:</span> <span class="n">OnlineParams</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_params</span><span class="p">(</span><span class="n">search_query</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">)</span>
<span class="k">if</span> <span class="n">online_params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">search_syntax</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="n">amount_str</span><span class="p">,</span> <span class="n">from_currency</span><span class="p">,</span> <span class="n">to_currency</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">amount</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">amount_str</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="c1"># most often $ stands for USD</span>
<span class="k">if</span> <span class="n">from_currency</span> <span class="o">==</span> <span class="s2">&quot;$&quot;</span><span class="p">:</span>
<span class="n">from_currency</span> <span class="o">=</span> <span class="s2">&quot;$ us&quot;</span>
<span class="k">if</span> <span class="n">to_currency</span> <span class="o">==</span> <span class="s2">&quot;$&quot;</span><span class="p">:</span>
<span class="n">to_currency</span> <span class="o">=</span> <span class="s2">&quot;$ us&quot;</span>
<span class="n">from_iso4217</span> <span class="o">=</span> <span class="n">from_currency</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">is_iso4217</span><span class="p">(</span><span class="n">from_iso4217</span><span class="p">):</span>
<span class="n">from_iso4217</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">name_to_iso4217</span><span class="p">(</span><span class="n">_normalize_name</span><span class="p">(</span><span class="n">from_currency</span><span class="p">))</span>
<span class="n">to_iso4217</span> <span class="o">=</span> <span class="n">to_currency</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">is_iso4217</span><span class="p">(</span><span class="n">to_iso4217</span><span class="p">):</span>
<span class="n">to_iso4217</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">name_to_iso4217</span><span class="p">(</span><span class="n">_normalize_name</span><span class="p">(</span><span class="n">to_currency</span><span class="p">))</span>
<span class="k">if</span> <span class="n">from_iso4217</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">to_iso4217</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="n">ui_locale</span> <span class="o">=</span> <span class="n">flask_babel</span><span class="o">.</span><span class="n">get_locale</span><span class="p">()</span> <span class="ow">or</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="s2">&quot;en&quot;</span><span class="p">)</span>
<span class="n">from_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">iso4217_to_name</span><span class="p">(</span>
<span class="n">from_iso4217</span><span class="p">,</span> <span class="n">ui_locale</span><span class="o">.</span><span class="n">language</span>
<span class="p">)</span> <span class="c1"># pyright: ignore[reportAssignmentType]</span>
<span class="n">to_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">iso4217_to_name</span><span class="p">(</span>
<span class="n">to_iso4217</span><span class="p">,</span> <span class="n">ui_locale</span><span class="o">.</span><span class="n">language</span>
<span class="p">)</span> <span class="c1"># pyright: ignore[reportAssignmentType]</span>
<span class="n">params</span><span class="p">:</span> <span class="n">OnlineCurrenciesParams</span> <span class="o">=</span> <span class="p">{</span>
<span class="o">**</span><span class="n">online_params</span><span class="p">,</span>
<span class="s2">&quot;amount&quot;</span><span class="p">:</span> <span class="n">amount</span><span class="p">,</span>
<span class="s2">&quot;from_iso4217&quot;</span><span class="p">:</span> <span class="n">from_iso4217</span><span class="p">,</span>
<span class="s2">&quot;to_iso4217&quot;</span><span class="p">:</span> <span class="n">to_iso4217</span><span class="p">,</span>
<span class="s2">&quot;from_name&quot;</span><span class="p">:</span> <span class="n">from_name</span><span class="p">,</span>
<span class="s2">&quot;to_name&quot;</span><span class="p">:</span> <span class="n">to_name</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">return</span> <span class="n">params</span></div>
</div>
<span class="k">def</span><span class="w"> </span><span class="nf">_normalize_name</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">,</span> <span class="s2">&quot; &quot;</span><span class="p">)</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">&quot; +&quot;</span><span class="p">,</span> <span class="s2">&quot; &quot;</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">return</span> <span class="n">unicodedata</span><span class="o">.</span><span class="n">normalize</span><span class="p">(</span><span class="s2">&quot;NFKD&quot;</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../../index.html">
<img class="logo" src="../../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../../../index.html">Table of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../dev/index.html">Developer documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../../../index.html">Overview</a>
<ul>
<li><a href="../../../index.html">Module code</a>
<ul>
<li><a href="../../search.html">searx.search</a>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink