Cutlery/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2025-11-08 15:54:21 -05:00
Code Issues Packages Projects Releases Wiki Activity
searxng/_modules/searx/engines/springer.html

286 lines
25 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.engines.springer &#8212; SearXNG Documentation (2025.11.7+b9b46431b)</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=abc48383"></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.7+b9b46431b" 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.7+b9b46431b)</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="../engines.html" accesskey="U">searx.engines</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">searx.engines.springer</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for searx.engines.springer</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;`Springer Nature`_ is a global publisher dedicated to providing service to</span>
<span class="sd">research community with official Springer-API_ (API-Playground_).</span>
<span class="sd">.. note::</span>
<span class="sd"> The Springer engine requires an API key, which can be obtained via the</span>
<span class="sd"> `Springer subscription`_.</span>
<span class="sd">Since the search term is passed 1:1 to the API, SearXNG users can use the</span>
<span class="sd">`Supported Query Parameters`_.</span>
<span class="sd">- ``!springer (doi:10.1007/s10948-025-07019-1 OR doi:10.1007/s10948-025-07035-1)``</span>
<span class="sd">- ``!springer keyword:ybco``</span>
<span class="sd">However, please note that the available options depend on the subscription type.</span>
<span class="sd">For example, the ``year:`` filter requires a *Premium Plan* subscription.</span>
<span class="sd">- ``!springer keyword:ybco year:2024``</span>
<span class="sd">The engine uses the REST Meta-API_ `v2` endpoint, but there is also a `Python</span>
<span class="sd">API Wrapper`_.</span>
<span class="sd">.. _Python API Wrapper: https://pypi.org/project/springernature-api-client/</span>
<span class="sd">.. _Springer Nature: https://www.springernature.com/</span>
<span class="sd">.. _Springer subscription: https://dev.springernature.com/subscription/</span>
<span class="sd">.. _Springer-API: https://dev.springernature.com/docs/introduction/</span>
<span class="sd">.. _API-Playground: https://dev.springernature.com/docs/live-documentation/</span>
<span class="sd">.. _Meta-API: https://dev.springernature.com/docs/api-endpoints/meta-api/</span>
<span class="sd">.. _Supported Query Parameters: https://dev.springernature.com/docs/supported-query-params/</span>
<span class="sd">Configuration</span>
<span class="sd">=============</span>
<span class="sd">The engine has the following additional settings:</span>
<span class="sd">- :py:obj:`api_key`</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> - name: springer nature</span>
<span class="sd"> api_key: &quot;...&quot;</span>
<span class="sd"> inactive: false</span>
<span class="sd">Implementations</span>
<span class="sd">===============</span>
<span class="sd">&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">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</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="kn">from</span><span class="w"> </span><span class="nn">searx.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">raise_for_httperror</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="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">searx.extended_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">SXNG_Response</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.processors</span><span class="w"> </span><span class="kn">import</span> <span class="n">OnlineParams</span>
<span class="n">about</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;website&quot;</span><span class="p">:</span> <span class="s2">&quot;https://www.springernature.com/&quot;</span><span class="p">,</span>
<span class="s2">&quot;wikidata_id&quot;</span><span class="p">:</span> <span class="s2">&quot;Q21096327&quot;</span><span class="p">,</span>
<span class="s2">&quot;official_api_documentation&quot;</span><span class="p">:</span> <span class="s2">&quot;https://dev.springernature.com/docs/live-documentation/&quot;</span><span class="p">,</span>
<span class="s2">&quot;use_official_api&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s2">&quot;require_api_key&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s2">&quot;results&quot;</span><span class="p">:</span> <span class="s2">&quot;JSON&quot;</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;science&quot;</span><span class="p">,</span> <span class="s2">&quot;scientific publications&quot;</span><span class="p">]</span>
<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">nb_per_page</span> <span class="o">=</span> <span class="mi">10</span>
<span class="sd">&quot;&quot;&quot;Number of results to return in the request, see `Pagination and Limits`_ for</span>
<span class="sd">more details.</span>
<span class="sd">.. _Pagination and Limits:</span>
<span class="sd"> https://dev.springernature.com/docs/advanced-querying/pagination-limits/</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="n">api_key</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;Key used for the Meta-API_. Get your API key from: `Springer subscription`_&quot;&quot;&quot;</span>
<span class="n">base_url</span> <span class="o">=</span> <span class="s2">&quot;https://api.springernature.com/meta/v2/json&quot;</span>
<span class="sd">&quot;&quot;&quot;An enhanced endpoint with additional metadata fields and optimized queries</span>
<span class="sd">for more efficient and comprehensive retrieval (Meta-API_ `v2`).</span>
<span class="sd">&quot;&quot;&quot;</span>
<div class="viewcode-block" id="setup">
<a class="viewcode-back" href="../../../dev/engines/online/springer.html#searx.engines.springer.setup">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">setup</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="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Initialization of the Springer engine, checks whether the</span>
<span class="sd"> :py:obj:`api_key` is set, otherwise the engine is inactive.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span><span class="p">:</span> <span class="nb">str</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">&quot;api_key&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># Springer&#39;s API key is a hex value</span>
<span class="nb">int</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="mi">16</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">except</span> <span class="ne">ValueError</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">&quot;Springer&#39;s API key is not set or invalid.&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</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="s2">&quot;OnlineParams&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;api_key&quot;</span><span class="p">:</span> <span class="n">api_key</span><span class="p">,</span>
<span class="s2">&quot;q&quot;</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
<span class="s2">&quot;s&quot;</span><span class="p">:</span> <span class="n">nb_per_page</span> <span class="o">*</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">&quot;pageno&quot;</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">),</span>
<span class="s2">&quot;p&quot;</span><span class="p">:</span> <span class="n">nb_per_page</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</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">urlencode</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="c1"># For example, the ``year:`` filter requires a *Premium Plan* subscription.</span>
<span class="n">params</span><span class="p">[</span><span class="s2">&quot;raise_for_httperror&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</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="s2">&quot;SXNG_Response&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EngineResults</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">json_data</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="k">if</span> <span class="p">(</span>
<span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">403</span>
<span class="ow">and</span> <span class="n">json_data</span><span class="p">[</span><span class="s2">&quot;status&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">&quot;fail&quot;</span>
<span class="ow">and</span> <span class="s2">&quot;premium feature&quot;</span> <span class="ow">in</span> <span class="n">json_data</span><span class="p">[</span><span class="s2">&quot;message&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="p">):</span>
<span class="k">return</span> <span class="n">res</span>
<span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">field</span><span class="p">(</span><span class="n">k</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">record</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">))</span>
<span class="k">for</span> <span class="n">record</span> <span class="ow">in</span> <span class="n">json_data</span><span class="p">[</span><span class="s2">&quot;records&quot;</span><span class="p">]:</span>
<span class="n">published</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">record</span><span class="p">[</span><span class="s2">&quot;publicationDate&quot;</span><span class="p">],</span> <span class="s2">&quot;%Y-%m-</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">authors</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">author</span><span class="p">[</span><span class="s2">&quot;creator&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;, &quot;</span><span class="p">)[::</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="k">for</span> <span class="n">author</span> <span class="ow">in</span> <span class="n">record</span><span class="p">[</span><span class="s2">&quot;creators&quot;</span><span class="p">]]</span>
<span class="n">pdf_url</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">html_url</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">url_list</span><span class="p">:</span> <span class="nb">list</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="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="n">record</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span>
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">url_list</span><span class="p">:</span>
<span class="k">if</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;platform&quot;</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">&quot;web&quot;</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;value&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;http://&quot;</span><span class="p">,</span> <span class="s2">&quot;https://&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;format&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;html&quot;</span><span class="p">:</span>
<span class="n">html_url</span> <span class="o">=</span> <span class="n">val</span>
<span class="k">elif</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;format&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;pdf&quot;</span><span class="p">:</span>
<span class="n">pdf_url</span> <span class="o">=</span> <span class="n">val</span>
<span class="n">paper</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Paper</span><span class="p">(</span>
<span class="n">url</span><span class="o">=</span><span class="n">html_url</span><span class="p">,</span>
<span class="c1"># html_url=html_url,</span>
<span class="n">pdf_url</span><span class="o">=</span><span class="n">pdf_url</span><span class="p">,</span>
<span class="n">title</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;title&quot;</span><span class="p">),</span>
<span class="n">content</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;abstract&quot;</span><span class="p">),</span>
<span class="n">comments</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;publicationName&quot;</span><span class="p">),</span>
<span class="n">tags</span><span class="o">=</span><span class="n">record</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;keyword&quot;</span><span class="p">,</span> <span class="p">[]),</span>
<span class="n">publishedDate</span><span class="o">=</span><span class="n">published</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;contentType&quot;</span><span class="p">),</span>
<span class="n">authors</span><span class="o">=</span><span class="n">authors</span><span class="p">,</span>
<span class="n">publisher</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;publisher&quot;</span><span class="p">),</span>
<span class="n">journal</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;publicationName&quot;</span><span class="p">),</span>
<span class="n">volume</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;volume&quot;</span><span class="p">),</span>
<span class="n">pages</span><span class="o">=</span><span class="s2">&quot;-&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">[</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;startingPage&quot;</span><span class="p">),</span> <span class="n">field</span><span class="p">(</span><span class="s2">&quot;endingPage&quot;</span><span class="p">)]</span> <span class="k">if</span> <span class="n">x</span><span class="p">]),</span>
<span class="n">number</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;number&quot;</span><span class="p">),</span>
<span class="n">doi</span><span class="o">=</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;doi&quot;</span><span class="p">),</span>
<span class="n">issn</span><span class="o">=</span><span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">[</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;issn&quot;</span><span class="p">)]</span> <span class="k">if</span> <span class="n">x</span><span class="p">],</span>
<span class="n">isbn</span><span class="o">=</span><span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">[</span><span class="n">field</span><span class="p">(</span><span class="s2">&quot;isbn&quot;</span><span class="p">)]</span> <span class="k">if</span> <span class="n">x</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">paper</span><span class="p">)</span>
<span class="k">return</span> <span class="n">res</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">
&#169; Copyright SearXNG team.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink