hash_plugin.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  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>Hash Values &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</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=b12b0e12"></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.4.30+fd33559cf" 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. <link rel="next" title="Hostnames" href="hostnames.html" />
  17. <link rel="prev" title="Calculator" href="calculator.html" />
  18. </head><body>
  19. <div class="related" role="navigation" aria-label="Related">
  20. <h3>Navigation</h3>
  21. <ul>
  22. <li class="right" style="margin-right: 10px">
  23. <a href="../../genindex.html" title="General Index"
  24. accesskey="I">index</a></li>
  25. <li class="right" >
  26. <a href="../../py-modindex.html" title="Python Module Index"
  27. >modules</a> |</li>
  28. <li class="right" >
  29. <a href="hostnames.html" title="Hostnames"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="calculator.html" title="Calculator"
  33. accesskey="P">previous</a> |</li>
  34. <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
  35. <li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> &#187;</li>
  36. <li class="nav-item nav-item-2"><a href="index.html" >Plugins</a> &#187;</li>
  37. <li class="nav-item nav-item-3"><a href="builtins.html" accesskey="U">Built-in Plugins</a> &#187;</li>
  38. <li class="nav-item nav-item-this"><a href="">Hash Values</a></li>
  39. </ul>
  40. </div>
  41. <div class="document">
  42. <div class="documentwrapper">
  43. <div class="bodywrapper">
  44. <div class="body" role="main">
  45. <section id="hash-values">
  46. <span id="hash-plugin-plugin"></span><h1>Hash Values<a class="headerlink" href="#hash-values" title="Link to this heading">¶</a></h1>
  47. <dl class="py class">
  48. <dt class="sig sig-object py" id="searx.plugins.hash_plugin.SXNGPlugin">
  49. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.plugins.hash_plugin.</span></span><span class="sig-name descname"><span class="pre">SXNGPlugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plg_cfg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="development.html#searx.plugins.PluginCfg" title="searx.plugins.PluginCfg"><span class="pre">PluginCfg</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/plugins/hash_plugin.html#SXNGPlugin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.hash_plugin.SXNGPlugin" title="Link to this definition">¶</a></dt>
  50. <dd><p>Plugin converts strings to different hash digests. The results are
  51. displayed in area for the “answers”.</p>
  52. <dl class="py attribute">
  53. <dt class="sig sig-object py" id="searx.plugins.hash_plugin.SXNGPlugin.id">
  54. <span class="sig-name descname"><span class="pre">id</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><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'hash_plugin'</span></em><a class="headerlink" href="#searx.plugins.hash_plugin.SXNGPlugin.id" title="Link to this definition">¶</a></dt>
  55. <dd><p>The ID (suffix) in the HTML form.</p>
  56. </dd></dl>
  57. <dl class="py attribute">
  58. <dt class="sig sig-object py" id="searx.plugins.hash_plugin.SXNGPlugin.keywords">
  59. <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><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['md5',</span> <span class="pre">'sha1',</span> <span class="pre">'sha224',</span> <span class="pre">'sha256',</span> <span class="pre">'sha384',</span> <span class="pre">'sha512']</span></em><a class="headerlink" href="#searx.plugins.hash_plugin.SXNGPlugin.keywords" title="Link to this definition">¶</a></dt>
  60. <dd><p>Keywords in the search query that activate the plugin. The <em>keyword</em> is
  61. the first word in a search query. If a plugin should be executed regardless
  62. of the search query, the list of keywords should be empty (which is also the
  63. default in the base class for Plugins).</p>
  64. </dd></dl>
  65. <dl class="py method">
  66. <dt class="sig sig-object py" id="searx.plugins.hash_plugin.SXNGPlugin.post_search">
  67. <span class="sig-name descname"><span class="pre">post_search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../extended_types.html#searx.extended_types.SXNG_Request" title="searx.extended_types.SXNG_Request"><span class="pre">SXNG_Request</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">search</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../../src/searx.search.html#searx.search.SearchWithPlugins" title="searx.search.SearchWithPlugins"><span class="pre">SearchWithPlugins</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 internal" href="../engines/index.html#searx.result_types.EngineResults" title="searx.result_types.EngineResults"><span class="pre">EngineResults</span></a></span></span><a class="reference internal" href="../../_modules/searx/plugins/hash_plugin.html#SXNGPlugin.post_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.plugins.hash_plugin.SXNGPlugin.post_search" title="Link to this definition">¶</a></dt>
  68. <dd><p>Returns a result list only for the first page.</p>
  69. </dd></dl>
  70. </dd></dl>
  71. </section>
  72. <div class="clearer"></div>
  73. </div>
  74. </div>
  75. </div>
  76. <span id="sidebar-top"></span>
  77. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  78. <div class="sphinxsidebarwrapper">
  79. <p class="logo"><a href="../../index.html">
  80. <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  81. </a></p>
  82. <h3><a href="../../index.html">Table of Contents</a></h3>
  83. <ul class="current">
  84. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
  85. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
  86. <li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
  87. <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
  88. <li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
  89. <li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
  90. <li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
  91. <li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
  92. <li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
  93. <li class="toctree-l2"><a class="reference internal" href="../result_types/index.html">Result Types</a></li>
  94. <li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
  95. <li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
  96. <li class="toctree-l2 current"><a class="reference internal" href="index.html">Plugins</a><ul class="current">
  97. <li class="toctree-l3"><a class="reference internal" href="development.html">Plugin Development</a></li>
  98. <li class="toctree-l3 current"><a class="reference internal" href="builtins.html">Built-in Plugins</a><ul class="current">
  99. <li class="toctree-l4"><a class="reference internal" href="calculator.html">Calculator</a></li>
  100. <li class="toctree-l4 current"><a class="current reference internal" href="#">Hash Values</a><ul>
  101. <li class="toctree-l5"><a class="reference internal" href="#searx.plugins.hash_plugin.SXNGPlugin"><code class="docutils literal notranslate"><span class="pre">SXNGPlugin</span></code></a></li>
  102. </ul>
  103. </li>
  104. <li class="toctree-l4"><a class="reference internal" href="hostnames.html">Hostnames</a></li>
  105. <li class="toctree-l4"><a class="reference internal" href="self_info.html">Self-Info</a></li>
  106. <li class="toctree-l4"><a class="reference internal" href="tor_check.html">Tor check</a></li>
  107. <li class="toctree-l4"><a class="reference internal" href="unit_converter.html">Unit Converter</a></li>
  108. </ul>
  109. </li>
  110. </ul>
  111. </li>
  112. <li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
  115. <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>
  116. <li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
  117. <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>
  118. </ul>
  119. </li>
  120. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
  121. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
  122. </ul>
  123. <h3>Project Links</h3>
  124. <ul>
  125. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  126. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  127. <li><a href="https://searx.space">Public instances</a>
  128. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  129. </ul><h3>Navigation</h3>
  130. <ul>
  131. <li><a href="../../index.html">Overview</a>
  132. <ul>
  133. <li><a href="../index.html">Developer documentation</a>
  134. <ul>
  135. <li><a href="index.html">Plugins</a>
  136. <ul>
  137. <li><a href="builtins.html">Built-in Plugins</a>
  138. <ul>
  139. <li>Previous: <a href="calculator.html" title="previous chapter">Calculator</a>
  140. <li>Next: <a href="hostnames.html" title="next chapter">Hostnames</a></ul>
  141. </li></ul>
  142. </li></ul>
  143. </li>
  144. </ul>
  145. </li>
  146. </ul>
  147. <search id="searchbox" style="display: none" role="search">
  148. <h3 id="searchlabel">Quick search</h3>
  149. <div class="searchformwrapper">
  150. <form class="search" action="../../search.html" method="get">
  151. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  152. <input type="submit" value="Go" />
  153. </form>
  154. </div>
  155. </search>
  156. <script>document.getElementById('searchbox').style.display = "block"</script>
  157. <div role="note" aria-label="source link">
  158. <h3>This Page</h3>
  159. <ul class="this-page-menu">
  160. <li><a href="../../_sources/dev/plugins/hash_plugin.rst.txt"
  161. rel="nofollow">Show Source</a></li>
  162. </ul>
  163. </div>
  164. </div>
  165. </div>
  166. <div class="clearer"></div>
  167. </div>
  168. <div class="footer" role="contentinfo">
  169. &#169; Copyright SearXNG team.
  170. </div>
  171. </body>
  172. </html>