mirror of
https://github.com/searxng/searxng.git
synced 2025-08-15 00:06:45 +02:00
239 lines
No EOL
16 KiB
HTML
239 lines
No EOL
16 KiB
HTML
<!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.engines.marginalia — SearXNG Documentation (2025.8.12+6b1516d6a)</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=7af8b2f2"></script>
|
|
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
|
|
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script data-project="searxng" data-version="2025.8.12+6b1516d6a" 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.8.12+6b1516d6a)</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">searx.engines.marginalia</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for searx.engines.marginalia</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
|
<span class="sd">"""`Marginalia Search`_ is an independent open source Internet search engine</span>
|
|
<span class="sd">operating out of Sweden. It is principally developed and operated by Viktor</span>
|
|
<span class="sd">Lofgren .</span>
|
|
|
|
<span class="sd">.. _Marginalia Search:</span>
|
|
<span class="sd"> https://about.marginalia-search.com/</span>
|
|
|
|
<span class="sd">Configuration</span>
|
|
<span class="sd">=============</span>
|
|
|
|
<span class="sd">The engine has the following required settings:</span>
|
|
|
|
<span class="sd">- :py:obj:`api_key`</span>
|
|
|
|
<span class="sd">You can configure a Marginalia engine by:</span>
|
|
|
|
<span class="sd">.. code:: yaml</span>
|
|
|
|
<span class="sd"> - name: marginalia</span>
|
|
<span class="sd"> engine: marginalia</span>
|
|
<span class="sd"> shortcut: mar</span>
|
|
<span class="sd"> api_key: ...</span>
|
|
|
|
<span class="sd">Implementations</span>
|
|
<span class="sd">===============</span>
|
|
|
|
<span class="sd">"""</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
|
|
|
|
<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">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span><span class="p">,</span> <span class="n">quote_plus</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">searxng_useragent</span>
|
|
<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">EngineResults</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Response</span>
|
|
|
|
<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"website"</span><span class="p">:</span> <span class="s2">"https://marginalia.nu"</span><span class="p">,</span>
|
|
<span class="s2">"wikidata_id"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
|
<span class="s2">"official_api_documentation"</span><span class="p">:</span> <span class="s2">"https://about.marginalia-search.com/article/api/"</span><span class="p">,</span>
|
|
<span class="s2">"use_official_api"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
|
<span class="s2">"require_api_key"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
|
<span class="s2">"results"</span><span class="p">:</span> <span class="s2">"JSON"</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">base_url</span> <span class="o">=</span> <span class="s2">"https://api.marginalia.nu"</span>
|
|
<span class="n">safesearch</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"general"</span><span class="p">]</span>
|
|
<span class="n">paging</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="n">results_per_page</span> <span class="o">=</span> <span class="mi">20</span>
|
|
<span class="n">api_key</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="sd">"""To get an API key, please follow the instructions from `Key and license`_</span>
|
|
|
|
<span class="sd">.. _Key and license:</span>
|
|
<span class="sd"> https://about.marginalia-search.com/article/api/</span>
|
|
|
|
<span class="sd">"""</span>
|
|
|
|
|
|
<div class="viewcode-block" id="ApiSearchResult">
|
|
<a class="viewcode-back" href="../../../dev/engines/online/marginalia.html#searx.engines.marginalia.ApiSearchResult">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">ApiSearchResult</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">"""Marginalia's ApiSearchResult_ class definition.</span>
|
|
|
|
<span class="sd"> .. _ApiSearchResult:</span>
|
|
<span class="sd"> https://github.com/MarginaliaSearch/MarginaliaSearch/blob/master/code/services-application/api-service/java/nu/marginalia/api/model/ApiSearchResult.java</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">url</span><span class="p">:</span> <span class="nb">str</span>
|
|
<span class="n">title</span><span class="p">:</span> <span class="nb">str</span>
|
|
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span>
|
|
<span class="n">quality</span><span class="p">:</span> <span class="nb">float</span>
|
|
<span class="nb">format</span><span class="p">:</span> <span class="nb">str</span>
|
|
<span class="n">details</span><span class="p">:</span> <span class="nb">str</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="ApiSearchResults">
|
|
<a class="viewcode-back" href="../../../dev/engines/online/marginalia.html#searx.engines.marginalia.ApiSearchResults">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">ApiSearchResults</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">"""Marginalia's ApiSearchResults_ class definition.</span>
|
|
|
|
<span class="sd"> .. _ApiSearchResults:</span>
|
|
<span class="sd"> https://github.com/MarginaliaSearch/MarginaliaSearch/blob/master/code/services-application/api-service/java/nu/marginalia/api/model/ApiSearchResults.java</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">license</span><span class="p">:</span> <span class="nb">str</span>
|
|
<span class="n">query</span><span class="p">:</span> <span class="nb">str</span>
|
|
<span class="n">results</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">ApiSearchResult</span><span class="p">]</span></div>
|
|
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]):</span>
|
|
|
|
<span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"count"</span><span class="p">:</span> <span class="n">results_per_page</span><span class="p">,</span>
|
|
<span class="s2">"nsfw"</span><span class="p">:</span> <span class="nb">min</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">"safesearch"</span><span class="p">],</span> <span class="mi">1</span><span class="p">),</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="n">params</span><span class="p">[</span><span class="s2">"url"</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base_url</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">api_key</span><span class="si">}</span><span class="s2">/search/</span><span class="si">{</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="si">}</span><span class="s2">?</span><span class="si">{</span><span class="n">urlencode</span><span class="p">(</span><span class="n">query_params</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="n">params</span><span class="p">[</span><span class="s2">"headers"</span><span class="p">][</span><span class="s2">"User-Agent"</span><span class="p">]</span> <span class="o">=</span> <span class="n">searxng_useragent</span><span class="p">()</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">:</span> <span class="n">SXNG_Response</span><span class="p">):</span>
|
|
|
|
<span class="n">res</span> <span class="o">=</span> <span class="n">EngineResults</span><span class="p">()</span>
|
|
<span class="n">resp_json</span><span class="p">:</span> <span class="n">ApiSearchResults</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span> <span class="c1"># type: ignore</span>
|
|
|
|
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">resp_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"results"</span><span class="p">,</span> <span class="p">[]):</span>
|
|
<span class="n">res</span><span class="o">.</span><span class="n">add</span><span class="p">(</span>
|
|
<span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">MainResult</span><span class="p">(</span>
|
|
<span class="n">title</span><span class="o">=</span><span class="n">item</span><span class="p">[</span><span class="s2">"title"</span><span class="p">],</span>
|
|
<span class="n">url</span><span class="o">=</span><span class="n">item</span><span class="p">[</span><span class="s2">"url"</span><span class="p">],</span>
|
|
<span class="n">content</span><span class="o">=</span><span class="n">item</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"description"</span><span class="p">,</span> <span class="s2">""</span><span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">res</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">init</span><span class="p">(</span><span class="n">engine_settings</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]):</span>
|
|
|
|
<span class="n">_api_key</span> <span class="o">=</span> <span class="n">engine_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"api_key"</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">_api_key</span><span class="p">:</span>
|
|
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"missing api_key: see https://about.marginalia-search.com/article/api"</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
<span class="k">if</span> <span class="n">_api_key</span> <span class="o">==</span> <span class="s2">"public"</span><span class="p">:</span>
|
|
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"invalid api_key (</span><span class="si">%s</span><span class="s2">): see https://about.marginalia-search.com/article/api"</span><span class="p">,</span> <span class="n">api_key</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="kc">True</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="../engines.html">searx.engines</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">
|
|
© Copyright SearXNG team.
|
|
</div>
|
|
</body>
|
|
</html> |