NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Tree: 9b01b2448a
Branches Tags
searxng
/
dev
/
answerers
/
development.html

development.html 34 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318 
  1. <!DOCTYPE html>
    2. 

  2. 

  3. <html lang="en" data-content_root="../../">
    4. 

  4.   <head>
    5. 

  5.     <meta charset="utf-8" />
    6. 

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <meta name="viewport" content="width=device-width, initial-scale=1">
    8. 

  8.     <title>Answerer Development &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
    9. 

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

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

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

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

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

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

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

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

  17.     <link rel="next" title="Built-in Answerers" href="builtins.html" />
    18. 

  18.     <link rel="prev" title="Answerers" href="index.html" /> 
    19. 

  19.   </head><body>
    20. 

  20.     <div class="related" role="navigation" aria-label="Related">
    21. 

  21.       <h3>Navigation</h3>
    22. 

  22.       <ul>
    23. 

  23.         <li class="right" style="margin-right: 10px">
    24. 

  24.           <a href="../../genindex.html" title="General Index"
    25. 

  25.              accesskey="I">index</a></li>
    26. 

  26.         <li class="right" >
    27. 

  27.           <a href="../../py-modindex.html" title="Python Module Index"
    28. 

  28.              >modules</a> |</li>
    29. 

  29.         <li class="right" >
    30. 

  30.           <a href="builtins.html" title="Built-in Answerers"
    31. 

  31.              accesskey="N">next</a> |</li>
    32. 

  32.         <li class="right" >
    33. 

  33.           <a href="index.html" title="Answerers"
    34. 

  34.              accesskey="P">previous</a> |</li>
    35. 

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

  36.           <li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> &#187;</li>
    37. 

  37.           <li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Answerers</a> &#187;</li>
    38. 

  38.         <li class="nav-item nav-item-this"><a href="">Answerer Development</a></li> 
    39. 

  39.       </ul>
    40. 

  40.     </div>  
    41. 

  41. 

  42.     <div class="document">
    43. 

  43.       <div class="documentwrapper">
    44. 

  44.         <div class="bodywrapper">
    45. 

  45.           <div class="body" role="main">
    46. 

  46.             
    47. 

  47.   <section id="module-searx.answerers">
    48. 

  48. <span id="answerer-development"></span><span id="dev-answerers"></span><h1>Answerer Development<a class="headerlink" href="#module-searx.answerers" title="Link to this heading">¶</a></h1>
    49. 

  49. <p>The <em>answerers</em> give instant answers related to the search query, they
    50. 

  50. usually provide answers of type <code class="xref py py-obj docutils literal notranslate"><span class="pre">Answer</span></code>.</p>
    51. 

  51. <p>Here is an example of a very simple answerer that adds a “Hello” into the answer
    52. 

  52. area:</p>
    53. 

  53. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">flask_babel</span><span class="w"> </span><span class="kn">import</span> <span class="n">gettext</span> <span class="k">as</span> <span class="n">_</span>
    54. 

  54. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.answerers</span><span class="w"> </span><span class="kn">import</span> <span class="n">Answerer</span>
    55. 

  55. <span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">Answer</span>
    56. 

  56. 

  57. <span class="k">class</span><span class="w"> </span><span class="nc">MyAnswerer</span><span class="p">(</span><span class="n">Answerer</span><span class="p">):</span>
    58. 

  58. 

  59.     <span class="n">keywords</span> <span class="o">=</span> <span class="p">[</span> <span class="s2">&quot;hello&quot;</span><span class="p">,</span> <span class="s2">&quot;hello world&quot;</span> <span class="p">]</span>
    60. 

  60. 

  61.     <span class="k">def</span><span class="w"> </span><span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    62. 

  62.         <span class="k">return</span> <span class="n">AnswererInfo</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;Hello&quot;</span><span class="p">),</span> <span class="n">description</span><span class="o">=</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;lorem ..&quot;</span><span class="p">),</span> <span class="n">keywords</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">keywords</span><span class="p">)</span>
    63. 

  63. 

  64.     <span class="k">def</span><span class="w"> </span><span class="nf">answer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">search</span><span class="p">):</span>
    65. 

  65.         <span class="k">return</span> <span class="p">[</span> <span class="n">Answer</span><span class="p">(</span><span class="n">answer</span><span class="o">=</span><span class="s2">&quot;Hello&quot;</span><span class="p">)</span> <span class="p">]</span>
    66. 

  66. </pre></div>
    67. 

  67. </div>
    68. 

  68. <hr class="docutils" />
    69. 

  69. <dl class="py class">
    70. 

  70. <dt class="sig sig-object py" id="searx.answerers.Answerer">
    71. 

  71. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers.</span></span><span class="sig-name descname"><span class="pre">Answerer</span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#Answerer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.Answerer" title="Link to this definition">¶</a></dt>
    72. 

  72. <dd><p>Abstract base class of answerers.</p>
    73. 

  73. <dl class="py attribute">
    74. 

  74. <dt class="sig sig-object py" id="searx.answerers.Answerer.keywords">
    75. 

  75. <span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.answerers.Answerer.keywords" title="Link to this definition">¶</a></dt>
    76. 

  76. <dd><p>Keywords to which the answerer has <em>answers</em>.</p>
    77. 

  77. </dd></dl>
    78. 

  78. 

  79. <dl class="py method">
    80. 

  80. <dt class="sig sig-object py" id="searx.answerers.Answerer.answer">
    81. 

  81. <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">answer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/answer.html#searx.result_types.answer.BaseAnswer" title="searx.result_types.answer.BaseAnswer"><span class="pre">BaseAnswer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#Answerer.answer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.Answerer.answer" title="Link to this definition">¶</a></dt>
    82. 

  82. <dd><p>Function that returns a list of answers to the question/query.</p>
    83. 

  83. </dd></dl>
    84. 

  84. 

  85. <dl class="py method">
    86. 

  86. <dt class="sig sig-object py" id="searx.answerers.Answerer.info">
    87. 

  87. <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#searx.answerers.AnswererInfo" title="searx.answerers._core.AnswererInfo"><span class="pre">AnswererInfo</span></a></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#Answerer.info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.Answerer.info" title="Link to this definition">¶</a></dt>
    88. 

  88. <dd><p>Informations about the <em>answerer</em>, see <a class="reference internal" href="#searx.answerers.AnswererInfo" title="searx.answerers.AnswererInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AnswererInfo</span></code></a>.</p>
    89. 

  89. </dd></dl>
    90. 

  90. 

  91. </dd></dl>
    92. 

  92. 

  93. <dl class="py class">
    94. 

  94. <dt class="sig sig-object py" id="searx.answerers.AnswererInfo">
    95. 

  95. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers.</span></span><span class="sig-name descname"><span class="pre">AnswererInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">examples</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswererInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswererInfo" title="Link to this definition">¶</a></dt>
    96. 

  96. <dd><p>Object that holds informations about an answerer, these infos are shown
    97. 

  97. to the user in the Preferences menu.</p>
    98. 

  98. <p>To be able to translate the information into other languages, the text must
    99. 

  99. be written in English and translated with <a class="reference external" href="https://python-babel.github.io/flask-babel/index.html#flask_babel.gettext" title="(in Flask-Babel)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">flask_babel.gettext</span></code></a>.</p>
    100. 

  100. <dl class="py attribute">
    101. 

  101. <dt class="sig sig-object py" id="searx.answerers.AnswererInfo.name">
    102. 

  102. <span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.answerers.AnswererInfo.name" title="Link to this definition">¶</a></dt>
    103. 

  103. <dd><p>Name of the <em>answerer</em>.</p>
    104. 

  104. </dd></dl>
    105. 

  105. 

  106. <dl class="py attribute">
    107. 

  107. <dt class="sig sig-object py" id="searx.answerers.AnswererInfo.description">
    108. 

  108. <span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.answerers.AnswererInfo.description" title="Link to this definition">¶</a></dt>
    109. 

  109. <dd><p>Short description of the <em>answerer</em>.</p>
    110. 

  110. </dd></dl>
    111. 

  111. 

  112. <dl class="py attribute">
    113. 

  113. <dt class="sig sig-object py" id="searx.answerers.AnswererInfo.examples">
    114. 

  114. <span class="sig-name descname"><span class="pre">examples</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.answerers.AnswererInfo.examples" title="Link to this definition">¶</a></dt>
    115. 

  115. <dd><p>List of short examples of the usage / of query terms.</p>
    116. 

  116. </dd></dl>
    117. 

  117. 

  118. <dl class="py attribute">
    119. 

  119. <dt class="sig sig-object py" id="searx.answerers.AnswererInfo.keywords">
    120. 

  120. <span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.answerers.AnswererInfo.keywords" title="Link to this definition">¶</a></dt>
    121. 

  121. <dd><p>See <a class="reference internal" href="#searx.answerers.Answerer.keywords" title="searx.answerers.Answerer.keywords"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Answerer.keywords</span></code></a></p>
    122. 

  122. </dd></dl>
    123. 

  123. 

  124. </dd></dl>
    125. 

  125. 

  126. <dl class="py class">
    127. 

  127. <dt class="sig sig-object py" id="searx.answerers.AnswerStorage">
    128. 

  128. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers.</span></span><span class="sig-name descname"><span class="pre">AnswerStorage</span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage" title="Link to this definition">¶</a></dt>
    129. 

  129. <dd><p>A storage for managing the <em>answerers</em> of SearXNG.  With the
    130. 

  130. <a class="reference internal" href="#searx.answerers.AnswerStorage.ask" title="searx.answerers.AnswerStorage.ask"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AnswerStorage.ask</span></code></a>” method, a caller can ask questions to all
    131. 

  131. <em>answerers</em> and receives a list of the results.</p>
    132. 

  132. <dl class="py attribute">
    133. 

  133. <dt class="sig sig-object py" id="searx.answerers.AnswerStorage.answerer_list">
    134. 

  134. <span class="sig-name descname"><span class="pre">answerer_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.13)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers._core.Answerer"><span class="pre">Answerer</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.answerers.AnswerStorage.answerer_list" title="Link to this definition">¶</a></dt>
    135. 

  135. <dd><p>The list of <a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers.Answerer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Answerer</span></code></a> in this storage.</p>
    136. 

  136. </dd></dl>
    137. 

  137. 

  138. <dl class="py method">
    139. 

  139. <dt class="sig sig-object py" id="searx.answerers.AnswerStorage.load_builtins">
    140. 

  140. <span class="sig-name descname"><span class="pre">load_builtins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage.load_builtins"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage.load_builtins" title="Link to this definition">¶</a></dt>
    141. 

  141. <dd><p>Loads <code class="docutils literal notranslate"><span class="pre">answerer.py</span></code> modules from the python packages in
    142. 

  142. <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/answerers">git://searx/answerers</a>.  The python modules are wrapped by
    143. 

  143. <code class="xref py py-obj docutils literal notranslate"><span class="pre">ModuleAnswerer</span></code>.</p>
    144. 

  144. </dd></dl>
    145. 

  145. 

  146. <dl class="py method">
    147. 

  147. <dt class="sig sig-object py" id="searx.answerers.AnswerStorage.register_by_fqn">
    148. 

  148. <span class="sig-name descname"><span class="pre">register_by_fqn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fqn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage.register_by_fqn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage.register_by_fqn" title="Link to this definition">¶</a></dt>
    149. 

  149. <dd><p>Register a <a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers.Answerer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Answerer</span></code></a> via its fully qualified class namen(FQN).</p>
    150. 

  150. </dd></dl>
    151. 

  151. 

  152. <dl class="py method">
    153. 

  153. <dt class="sig sig-object py" id="searx.answerers.AnswerStorage.register">
    154. 

  154. <span class="sig-name descname"><span class="pre">register</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">answerer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers._core.Answerer"><span class="pre">Answerer</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage.register"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage.register" title="Link to this definition">¶</a></dt>
    155. 

  155. <dd><p>Register a <a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers.Answerer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Answerer</span></code></a>.</p>
    156. 

  156. </dd></dl>
    157. 

  157. 

  158. <dl class="py method">
    159. 

  159. <dt class="sig sig-object py" id="searx.answerers.AnswerStorage.ask">
    160. 

  160. <span class="sig-name descname"><span class="pre">ask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/answer.html#searx.result_types.answer.BaseAnswer" title="searx.result_types.answer.BaseAnswer"><span class="pre">BaseAnswer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#AnswerStorage.ask"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers.AnswerStorage.ask" title="Link to this definition">¶</a></dt>
    161. 

  161. <dd><p>An answerer is identified via keywords, if there is a keyword at the
    162. 

  162. first position in the <code class="docutils literal notranslate"><span class="pre">query</span></code> for which there is one or more
    163. 

  163. answerers, then these are called, whereby the entire <code class="docutils literal notranslate"><span class="pre">query</span></code> is passed
    164. 

  164. as argument to the answerer function.</p>
    165. 

  165. </dd></dl>
    166. 

  166. 

  167. </dd></dl>
    168. 

  168. 

  169. <dl class="py class">
    170. 

  170. <dt class="sig sig-object py" id="searx.answerers._core.ModuleAnswerer">
    171. 

  171. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.answerers._core.</span></span><span class="sig-name descname"><span class="pre">ModuleAnswerer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mod</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#ModuleAnswerer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers._core.ModuleAnswerer" title="Link to this definition">¶</a></dt>
    172. 

  172. <dd><p>Bases: <a class="reference internal" href="#searx.answerers.Answerer" title="searx.answerers._core.Answerer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Answerer</span></code></a></p>
    173. 

  173. <p>A wrapper class for legacy <em>answerers</em> where the names (keywords, answer,
    174. 

  174. info) are implemented on the module level (not in a class).</p>
    175. 

  175. <div class="admonition note">
    176. 

  176. <p class="admonition-title">Note</p>
    177. 

  177. <p>For internal use only!</p>
    178. 

  178. </div>
    179. 

  179. <dl class="py method">
    180. 

  180. <dt class="sig sig-object py" id="searx.answerers._core.ModuleAnswerer.answer">
    181. 

  181. <span class="sig-name descname"><span class="pre">answer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../result_types/answer.html#searx.result_types.answer.BaseAnswer" title="searx.result_types.answer.BaseAnswer"><span class="pre">BaseAnswer</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#ModuleAnswerer.answer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers._core.ModuleAnswerer.answer" title="Link to this definition">¶</a></dt>
    182. 

  182. <dd><p>Function that returns a list of answers to the question/query.</p>
    183. 

  183. </dd></dl>
    184. 

  184. 

  185. <dl class="py method">
    186. 

  186. <dt class="sig sig-object py" id="searx.answerers._core.ModuleAnswerer.info">
    187. 

  187. <span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#searx.answerers.AnswererInfo" title="searx.answerers._core.AnswererInfo"><span class="pre">AnswererInfo</span></a></span></span><a class="reference internal" href="../../_modules/searx/answerers/_core.html#ModuleAnswerer.info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.answerers._core.ModuleAnswerer.info" title="Link to this definition">¶</a></dt>
    188. 

  188. <dd><p>Informations about the <em>answerer</em>, see <a class="reference internal" href="#searx.answerers.AnswererInfo" title="searx.answerers._core.AnswererInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AnswererInfo</span></code></a>.</p>
    189. 

  189. </dd></dl>
    190. 

  190. 

  191. </dd></dl>
    192. 

  192. 

  193. </section>
    194. 

  194. 

  195. 

  196.             <div class="clearer"></div>
    197. 

  197.           </div>
    198. 

  198.         </div>
    199. 

  199.       </div>
    200. 

  200.   <span id="sidebar-top"></span>
    201. 

  201.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    202. 

  202.         <div class="sphinxsidebarwrapper">
    203. 

  203.   
    204. 

  204.     
    205. 

  205.             <p class="logo"><a href="../../index.html">
    206. 

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

  207.             </a></p>
    208. 

  208.   
    209. 

  209. 

  210. <h3><a href="../../index.html">Table of Contents</a></h3>
    211. 

  211. <ul class="current">
    212. 

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

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

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

  215. <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
    216. 

  216. <li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
    217. 

  217. <li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
    218. 

  218. <li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
    219. 

  219. <li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
    220. 

  220. <li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
    221. 

  221. <li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
    222. 

  222. <li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
    223. 

  223. <li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
    224. 

  224. <li class="toctree-l2"><a class="reference internal" href="../plugins/index.html">Plugins</a></li>
    225. 

  225. <li class="toctree-l2 current"><a class="reference internal" href="index.html">Answerers</a><ul class="current">
    226. 

  226. <li class="toctree-l3 current"><a class="current reference internal" href="#">Answerer Development</a><ul>
    227. 

  227. <li class="toctree-l4"><a class="reference internal" href="#searx.answerers.Answerer"><code class="docutils literal notranslate"><span class="pre">Answerer</span></code></a><ul>
    228. 

  228. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.Answerer.keywords"><code class="docutils literal notranslate"><span class="pre">Answerer.keywords</span></code></a></li>
    229. 

  229. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.Answerer.answer"><code class="docutils literal notranslate"><span class="pre">Answerer.answer()</span></code></a></li>
    230. 

  230. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.Answerer.info"><code class="docutils literal notranslate"><span class="pre">Answerer.info()</span></code></a></li>
    231. 

  231. </ul>
    232. 

  232. </li>
    233. 

  233. <li class="toctree-l4"><a class="reference internal" href="#searx.answerers.AnswererInfo"><code class="docutils literal notranslate"><span class="pre">AnswererInfo</span></code></a><ul>
    234. 

  234. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswererInfo.name"><code class="docutils literal notranslate"><span class="pre">AnswererInfo.name</span></code></a></li>
    235. 

  235. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswererInfo.description"><code class="docutils literal notranslate"><span class="pre">AnswererInfo.description</span></code></a></li>
    236. 

  236. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswererInfo.examples"><code class="docutils literal notranslate"><span class="pre">AnswererInfo.examples</span></code></a></li>
    237. 

  237. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswererInfo.keywords"><code class="docutils literal notranslate"><span class="pre">AnswererInfo.keywords</span></code></a></li>
    238. 

  238. </ul>
    239. 

  239. </li>
    240. 

  240. <li class="toctree-l4"><a class="reference internal" href="#searx.answerers.AnswerStorage"><code class="docutils literal notranslate"><span class="pre">AnswerStorage</span></code></a><ul>
    241. 

  241. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.answerer_list"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.answerer_list</span></code></a></li>
    242. 

  242. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.load_builtins"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.load_builtins()</span></code></a></li>
    243. 

  243. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.register_by_fqn"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.register_by_fqn()</span></code></a></li>
    244. 

  244. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.register"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.register()</span></code></a></li>
    245. 

  245. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers.AnswerStorage.ask"><code class="docutils literal notranslate"><span class="pre">AnswerStorage.ask()</span></code></a></li>
    246. 

  246. </ul>
    247. 

  247. </li>
    248. 

  248. <li class="toctree-l4"><a class="reference internal" href="#searx.answerers._core.ModuleAnswerer"><code class="docutils literal notranslate"><span class="pre">ModuleAnswerer</span></code></a><ul>
    249. 

  249. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers._core.ModuleAnswerer.answer"><code class="docutils literal notranslate"><span class="pre">ModuleAnswerer.answer()</span></code></a></li>
    250. 

  250. <li class="toctree-l5"><a class="reference internal" href="#searx.answerers._core.ModuleAnswerer.info"><code class="docutils literal notranslate"><span class="pre">ModuleAnswerer.info()</span></code></a></li>
    251. 

  251. </ul>
    252. 

  252. </li>
    253. 

  253. </ul>
    254. 

  254. </li>
    255. 

  255. <li class="toctree-l3"><a class="reference internal" href="builtins.html">Built-in Answerers</a></li>
    256. 

  256. </ul>
    257. 

  257. </li>
    258. 

  258. <li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
    259. 

  259. <li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
    260. 

  260. <li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
    261. 

  261. <li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
    262. 

  262. <li class="toctree-l2"><a class="reference internal" href="../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
    263. 

  263. </ul>
    264. 

  264. </li>
    265. 

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

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

  267. </ul>
    268. 

  268. 

  269.   <h3>Project Links</h3>
    270. 

  270.   <ul>
    271. 

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

  272.   
    273. 

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

  274.   
    275. 

  275.     <li><a href="https://searx.space">Public instances</a>
    276. 

  276.   
    277. 

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

  278.   </ul><h3>Navigation</h3>
    279. 

  279. <ul>
    280. 

  280.   <li><a href="../../index.html">Overview</a>
    281. 

  281.     <ul>
    282. 

  282.       <li><a href="../index.html">Developer documentation</a>
    283. 

  283.         <ul>
    284. 

  284.       <li><a href="index.html">Answerers</a>
    285. 

  285.         <ul>
    286. 

  286.           <li>Previous: <a href="index.html" title="previous chapter">Answerers</a>
    287. 

  287.           <li>Next: <a href="builtins.html" title="next chapter">Built-in Answerers</a></ul>
    288. 

  288.       </li></ul>
    289. 

  289.       </li>
    290. 

  290.     </ul>
    291. 

  291.   </li>
    292. 

  292. </ul>
    293. 

  293. <search id="searchbox" style="display: none" role="search">
    294. 

  294.   <h3 id="searchlabel">Quick search</h3>
    295. 

  295.     <div class="searchformwrapper">
    296. 

  296.     <form class="search" action="../../search.html" method="get">
    297. 

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

  298.       <input type="submit" value="Go" />
    299. 

  299.     </form>
    300. 

  300.     </div>
    301. 

  301. </search>
    302. 

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

  303.   <div role="note" aria-label="source link">
    304. 

  304.     <h3>This Page</h3>
    305. 

  305.     <ul class="this-page-menu">
    306. 

  306.       <li><a href="../../_sources/dev/answerers/development.rst.txt"
    307. 

  307.             rel="nofollow">Show Source</a></li>
    308. 

  308.     </ul>
    309. 

  309.    </div>
    310. 

  310.         </div>
    311. 

  311.       </div>
    312. 

  312.       <div class="clearer"></div>
    313. 

  313.     </div>
    314. 

  314.     <div class="footer" role="contentinfo">
    315. 

  315.     &#169; Copyright SearXNG team.
    316. 

  316.     </div>
    317. 

  317.   </body>
    318. 

  318. </html>
    319.
© 2025 NTab仓库
Page: 233ms Template: 1ms 微信 微信二维码 哔哩哔哩 Sina Weibo Javascript Licenses Website