<!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.exceptions — SearXNG Documentation (2024.4.28+fd93d0c60)</title> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=4f649999" /> <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" /> <link rel="stylesheet" type="text/css" href="../../_static/tabs.css?v=a5c4661c" /> <script src="../../_static/documentation_options.js?v=88ac209d"></script> <script src="../../_static/doctools.js?v=9a2dae69"></script> <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../../_static/tabs.js?v=3030b3cb"></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 navigation"> <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 (2024.4.28+fd93d0c60)</a> »</li> <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> <li class="nav-item nav-item-this"><a href="">searx.exceptions</a></li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <h1>Source code for searx.exceptions</h1><div class="highlight"><pre> <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span> <span class="sd">"""Exception types raised by SearXNG modules.</span> <span class="sd">"""</span> <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span> <div class="viewcode-block" id="SearxException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxException">[docs]</a> <span class="k">class</span> <span class="nc">SearxException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Base SearXNG exception."""</span></div> <div class="viewcode-block" id="SearxParameterException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxParameterException">[docs]</a> <span class="k">class</span> <span class="nc">SearxParameterException</span><span class="p">(</span><span class="n">SearxException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Raised when query miss a required parameter"""</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span> <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">''</span> <span class="ow">or</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="n">message</span> <span class="o">=</span> <span class="s1">'Empty '</span> <span class="o">+</span> <span class="n">name</span> <span class="o">+</span> <span class="s1">' parameter'</span> <span class="k">else</span><span class="p">:</span> <span class="n">message</span> <span class="o">=</span> <span class="s1">'Invalid value "'</span> <span class="o">+</span> <span class="n">value</span> <span class="o">+</span> <span class="s1">'" for parameter '</span> <span class="o">+</span> <span class="n">name</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameter_name</span> <span class="o">=</span> <span class="n">name</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameter_value</span> <span class="o">=</span> <span class="n">value</span></div> <div class="viewcode-block" id="SearxSettingsException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxSettingsException">[docs]</a> <span class="k">class</span> <span class="nc">SearxSettingsException</span><span class="p">(</span><span class="n">SearxException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Error while loading the settings"""</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="ne">Exception</span><span class="p">],</span> <span class="n">filename</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> <span class="bp">self</span><span class="o">.</span><span class="n">filename</span> <span class="o">=</span> <span class="n">filename</span></div> <div class="viewcode-block" id="SearxEngineException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineException">[docs]</a> <span class="k">class</span> <span class="nc">SearxEngineException</span><span class="p">(</span><span class="n">SearxException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Error inside an engine"""</span></div> <div class="viewcode-block" id="SearxXPathSyntaxException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxXPathSyntaxException">[docs]</a> <span class="k">class</span> <span class="nc">SearxXPathSyntaxException</span><span class="p">(</span><span class="n">SearxEngineException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Syntax error in a XPATH"""</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xpath_spec</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span> <span class="o">+</span> <span class="s2">" "</span> <span class="o">+</span> <span class="n">message</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> <span class="c1"># str(xpath_spec) to deal with str and XPath instance</span> <span class="bp">self</span><span class="o">.</span><span class="n">xpath_str</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span></div> <div class="viewcode-block" id="SearxEngineResponseException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineResponseException">[docs]</a> <span class="k">class</span> <span class="nc">SearxEngineResponseException</span><span class="p">(</span><span class="n">SearxEngineException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Impossible to parse the result of an engine"""</span></div> <div class="viewcode-block" id="SearxEngineAPIException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineAPIException">[docs]</a> <span class="k">class</span> <span class="nc">SearxEngineAPIException</span><span class="p">(</span><span class="n">SearxEngineResponseException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""The website has returned an application error"""</span></div> <div class="viewcode-block" id="SearxEngineAccessDeniedException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineAccessDeniedException">[docs]</a> <span class="k">class</span> <span class="nc">SearxEngineAccessDeniedException</span><span class="p">(</span><span class="n">SearxEngineResponseException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""The website is blocking the access"""</span> <span class="n">SUSPEND_TIME_SETTING</span> <span class="o">=</span> <span class="s2">"search.suspended_times.SearxEngineAccessDenied"</span> <span class="w"> </span><span class="sd">"""This settings contains the default suspended time (default 86400 sec / 1</span> <span class="sd"> day)."""</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">suspended_time</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'Access denied'</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Generic exception to raise when an engine denies access to the results.</span> <span class="sd"> :param suspended_time: How long the engine is going to be suspended in</span> <span class="sd"> second. Defaults to None.</span> <span class="sd"> :type suspended_time: int, None</span> <span class="sd"> :param message: Internal message. Defaults to ``Access denied``</span> <span class="sd"> :type message: str</span> <span class="sd"> """</span> <span class="n">suspended_time</span> <span class="o">=</span> <span class="n">suspended_time</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_default_suspended_time</span><span class="p">()</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span> <span class="o">+</span> <span class="s1">', suspended_time='</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">suspended_time</span><span class="p">))</span> <span class="bp">self</span><span class="o">.</span><span class="n">suspended_time</span> <span class="o">=</span> <span class="n">suspended_time</span> <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> <span class="k">def</span> <span class="nf">_get_default_suspended_time</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="kn">from</span> <span class="nn">searx</span> <span class="kn">import</span> <span class="n">get_setting</span> <span class="c1"># pylint: disable=C0415</span> <span class="k">return</span> <span class="n">get_setting</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SUSPEND_TIME_SETTING</span><span class="p">)</span></div> <div class="viewcode-block" id="SearxEngineCaptchaException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineCaptchaException">[docs]</a> <span class="k">class</span> <span class="nc">SearxEngineCaptchaException</span><span class="p">(</span><span class="n">SearxEngineAccessDeniedException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""The website has returned a CAPTCHA."""</span> <span class="n">SUSPEND_TIME_SETTING</span> <span class="o">=</span> <span class="s2">"search.suspended_times.SearxEngineCaptcha"</span> <span class="w"> </span><span class="sd">"""This settings contains the default suspended time (default 86400 sec / 1</span> <span class="sd"> day)."""</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">suspended_time</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s1">'CAPTCHA'</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">,</span> <span class="n">suspended_time</span><span class="o">=</span><span class="n">suspended_time</span><span class="p">)</span></div> <div class="viewcode-block" id="SearxEngineTooManyRequestsException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineTooManyRequestsException">[docs]</a> <span class="k">class</span> <span class="nc">SearxEngineTooManyRequestsException</span><span class="p">(</span><span class="n">SearxEngineAccessDeniedException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""The website has returned a Too Many Request status code</span> <span class="sd"> By default, searx stops sending requests to this engine for 1 hour.</span> <span class="sd"> """</span> <span class="n">SUSPEND_TIME_SETTING</span> <span class="o">=</span> <span class="s2">"search.suspended_times.SearxEngineTooManyRequests"</span> <span class="w"> </span><span class="sd">"""This settings contains the default suspended time (default 3660 sec / 1</span> <span class="sd"> hour)."""</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">suspended_time</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s1">'Too many request'</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="n">message</span><span class="p">,</span> <span class="n">suspended_time</span><span class="o">=</span><span class="n">suspended_time</span><span class="p">)</span></div> <div class="viewcode-block" id="SearxEngineXPathException"> <a class="viewcode-back" href="../../src/searx.exceptions.html#searx.exceptions.SearxEngineXPathException">[docs]</a> <span class="k">class</span> <span class="nc">SearxEngineXPathException</span><span class="p">(</span><span class="n">SearxEngineResponseException</span><span class="p">):</span> <span class="w"> </span><span class="sd">"""Error while getting the result of an XPath expression"""</span> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xpath_spec</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span> <span class="o">+</span> <span class="s2">" "</span> <span class="o">+</span> <span class="n">message</span><span class="p">)</span> <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="n">message</span> <span class="c1"># str(xpath_spec) to deal with str and XPath instance</span> <span class="bp">self</span><span class="o">.</span><span class="n">xpath_str</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">xpath_spec</span><span class="p">)</span></div> </pre></div> <div class="clearer"></div> </div> </div> </div> <span id="sidebar-top"></span> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <p class="logo"><a href="../../index.html"> <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo"/> </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/Fauli1221/PonySearch/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> </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"> © Copyright SearXNG team. </div> <script src="../../_static/version_warning_offset.js"></script> </body> </html>