mirror of
https://github.com/searxng/searxng.git
synced 2025-09-02 08:18:35 +02:00
361 lines
No EOL
33 KiB
HTML
361 lines
No EOL
33 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.github_code — SearXNG Documentation (2025.9.1+501327ddf)</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=015ee560"></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.9.1+501327ddf" 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.9.1+501327ddf)</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.github_code</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for searx.engines.github_code</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-lat_er</span>
|
|
<span class="sd">"""GitHub code search with `search syntax`_ as described in `Constructing a</span>
|
|
<span class="sd">search query`_ in the documentation of GitHub's REST API.</span>
|
|
|
|
<span class="sd">.. _search syntax:</span>
|
|
<span class="sd"> https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax</span>
|
|
<span class="sd">.. _Constructing a search query:</span>
|
|
<span class="sd"> https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#constructing-a-search-query</span>
|
|
<span class="sd">.. _Github REST API for code search:</span>
|
|
<span class="sd"> https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-code</span>
|
|
<span class="sd">.. _Github REST API auth for code search:</span>
|
|
<span class="sd"> https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-code--fine-grained-access-tokens</span>
|
|
|
|
<span class="sd">Configuration</span>
|
|
<span class="sd">=============</span>
|
|
|
|
<span class="sd">The engine has the following mandatory setting:</span>
|
|
|
|
<span class="sd">- :py:obj:`ghc_auth`</span>
|
|
<span class="sd"> Change the authentication method used when using the API, defaults to none.</span>
|
|
|
|
<span class="sd">Optional settings are:</span>
|
|
|
|
<span class="sd">- :py:obj:`ghc_highlight_matching_lines`</span>
|
|
<span class="sd"> Control the highlighting of the matched text (turns off/on).</span>
|
|
<span class="sd">- :py:obj:`ghc_strip_new_lines`</span>
|
|
<span class="sd"> Strip new lines at the start or end of each code fragment.</span>
|
|
<span class="sd">- :py:obj:`ghc_strip_whitespace`</span>
|
|
<span class="sd"> Strip any whitespace at the start or end of each code fragment.</span>
|
|
<span class="sd">- :py:obj:`ghc_insert_block_separator`</span>
|
|
<span class="sd"> Add a `...` between each code fragment before merging them.</span>
|
|
|
|
<span class="sd">.. code:: yaml</span>
|
|
|
|
<span class="sd"> - name: github code</span>
|
|
<span class="sd"> engine: github_code</span>
|
|
<span class="sd"> shortcut: ghc</span>
|
|
<span class="sd"> ghc_auth:</span>
|
|
<span class="sd"> type: "none"</span>
|
|
|
|
<span class="sd"> - name: github code</span>
|
|
<span class="sd"> engine: github_code</span>
|
|
<span class="sd"> shortcut: ghc</span>
|
|
<span class="sd"> ghc_auth:</span>
|
|
<span class="sd"> type: "personal_access_token"</span>
|
|
<span class="sd"> token: "<token>"</span>
|
|
<span class="sd"> ghc_highlight_matching_lines: true</span>
|
|
<span class="sd"> ghc_strip_whitespace: true</span>
|
|
<span class="sd"> ghc_strip_new_lines: true</span>
|
|
|
|
|
|
<span class="sd"> - name: github code</span>
|
|
<span class="sd"> engine: github_code</span>
|
|
<span class="sd"> shortcut: ghc</span>
|
|
<span class="sd"> ghc_auth:</span>
|
|
<span class="sd"> type: "bearer"</span>
|
|
<span class="sd"> token: "<token>"</span>
|
|
|
|
<span class="sd">Implementation</span>
|
|
<span class="sd">===============</span>
|
|
|
|
<span class="sd">GitHub does not return the code line indices alongside the code fragment in the</span>
|
|
<span class="sd">search API. Since these are not super important for the user experience all the</span>
|
|
<span class="sd">code lines are just relabeled (starting from 1) and appended (a disjoint set of</span>
|
|
<span class="sd">code blocks in a single file might be returned from the API).</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="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="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="c1"># about</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="s1">'https://github.com/'</span><span class="p">,</span>
|
|
<span class="s2">"wikidata_id"</span><span class="p">:</span> <span class="s1">'Q364'</span><span class="p">,</span>
|
|
<span class="s2">"official_api_documentation"</span><span class="p">:</span> <span class="s1">'https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-code'</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">False</span><span class="p">,</span>
|
|
<span class="s2">"results"</span><span class="p">:</span> <span class="s1">'JSON'</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1"># engine dependent config</span>
|
|
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'code'</span><span class="p">]</span>
|
|
|
|
|
|
<span class="n">search_url</span> <span class="o">=</span> <span class="s1">'https://api.github.com/search/code?sort=indexed&</span><span class="si">{query}</span><span class="s1">&</span><span class="si">{page}</span><span class="s1">'</span>
|
|
<span class="c1"># https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#text-match-metadata</span>
|
|
<span class="n">accept_header</span> <span class="o">=</span> <span class="s1">'application/vnd.github.text-match+json'</span>
|
|
<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
|
<span class="n">ghc_auth</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"none"</span><span class="p">,</span>
|
|
<span class="s2">"token"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
<span class="sd">"""Change the method of authenticating to the github API.</span>
|
|
|
|
<span class="sd">``type`` needs to be one of ``none``, ``personal_access_token``, or ``bearer``.</span>
|
|
<span class="sd">When type is not `none` a token is expected to be passed as well in</span>
|
|
<span class="sd">``auth.token``.</span>
|
|
|
|
<span class="sd">If there is any privacy concerns about generating a token, one can use the API</span>
|
|
<span class="sd">without authentication. The calls will be heavily rate limited, this is what the</span>
|
|
<span class="sd">API returns on such calls::</span>
|
|
|
|
<span class="sd"> API rate limit exceeded for <redacted ip>.</span>
|
|
<span class="sd"> (But here's the good news: Authenticated requests get a higher rate limit)</span>
|
|
|
|
<span class="sd">The personal access token or a bearer for an org or a group can be generated [in</span>
|
|
<span class="sd">the `GitHub settings`_.</span>
|
|
|
|
<span class="sd">.. _GitHub settings:</span>
|
|
<span class="sd"> https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-code--fine-grained-access-tokens</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="n">ghc_highlight_matching_lines</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="sd">"""Highlight the matching code lines."""</span>
|
|
|
|
<span class="n">ghc_strip_new_lines</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="sd">"""Strip leading and trailing newlines for each returned fragment.</span>
|
|
<span class="sd">Single file might return multiple code fragments.</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="n">ghc_strip_whitespace</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="sd">"""Strip all leading and trailing whitespace for each returned fragment.</span>
|
|
<span class="sd">Single file might return multiple code fragments. Enabling this might break</span>
|
|
<span class="sd">code indentation.</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="n">ghc_api_version</span> <span class="o">=</span> <span class="s2">"2022-11-28"</span>
|
|
<span class="sd">"""The version of the GitHub REST API.</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="n">ghc_insert_block_separator</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="sd">"""Each file possibly consists of more than one code block that matches the</span>
|
|
<span class="sd">search, if this is set to true, the blocks will be separated with ``...`` line.</span>
|
|
<span class="sd">This might break the lexer and thus result in the lack of code highlighting.</span>
|
|
<span class="sd">"""</span>
|
|
|
|
|
|
<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="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
|
|
<span class="n">params</span><span class="p">[</span><span class="s1">'url'</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">'q'</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span> <span class="n">page</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">'page'</span><span class="p">:</span> <span class="n">params</span><span class="p">[</span><span class="s1">'pageno'</span><span class="p">]}))</span>
|
|
<span class="n">params</span><span class="p">[</span><span class="s1">'headers'</span><span class="p">][</span><span class="s1">'Accept'</span><span class="p">]</span> <span class="o">=</span> <span class="n">accept_header</span>
|
|
<span class="n">params</span><span class="p">[</span><span class="s1">'headers'</span><span class="p">][</span><span class="s1">'X-GitHub-Api-Version'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ghc_api_version</span>
|
|
|
|
<span class="k">if</span> <span class="n">ghc_auth</span><span class="p">[</span><span class="s1">'type'</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"none"</span><span class="p">:</span>
|
|
<span class="c1"># Without the auth header the query fails, so add a dummy instead.</span>
|
|
<span class="c1"># Queries without auth are heavily rate limited.</span>
|
|
<span class="n">params</span><span class="p">[</span><span class="s1">'headers'</span><span class="p">][</span><span class="s1">'Authorization'</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"placeholder"</span>
|
|
<span class="k">if</span> <span class="n">ghc_auth</span><span class="p">[</span><span class="s1">'type'</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"personal_access_token"</span><span class="p">:</span>
|
|
<span class="n">params</span><span class="p">[</span><span class="s1">'headers'</span><span class="p">][</span><span class="s1">'Authorization'</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"token </span><span class="si">{</span><span class="n">ghc_auth</span><span class="p">[</span><span class="s1">'token'</span><span class="p">]</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="k">if</span> <span class="n">ghc_auth</span><span class="p">[</span><span class="s1">'type'</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"bearer"</span><span class="p">:</span>
|
|
<span class="n">params</span><span class="p">[</span><span class="s1">'headers'</span><span class="p">][</span><span class="s1">'Authorization'</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Bearer </span><span class="si">{</span><span class="n">ghc_auth</span><span class="p">[</span><span class="s1">'token'</span><span class="p">]</span><span class="si">}</span><span class="s2">"</span>
|
|
|
|
<span class="n">params</span><span class="p">[</span><span class="s1">'raise_for_httperror'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
|
|
<div class="viewcode-block" id="extract_code">
|
|
<a class="viewcode-back" href="../../../dev/engines/online/github_code.html#searx.engines.github_code.extract_code">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">extract_code</span><span class="p">(</span><span class="n">code_matches</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="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]])</span> <span class="o">-></span> <span class="nb">tuple</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="nb">set</span><span class="p">[</span><span class="nb">int</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Iterate over multiple possible matches, for each extract a code fragment.</span>
|
|
<span class="sd"> Github additionally sends context for _word_ highlights; pygments supports</span>
|
|
<span class="sd"> highlighting lines, as such we calculate which lines to highlight while</span>
|
|
<span class="sd"> traversing the text.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">lines</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="n">highlighted_lines_index</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
|
|
|
|
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">match</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">code_matches</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">i</span> <span class="o">></span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">ghc_insert_block_separator</span><span class="p">:</span>
|
|
<span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"..."</span><span class="p">)</span>
|
|
<span class="n">buffer</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="n">highlight_groups</span> <span class="o">=</span> <span class="p">[</span><span class="n">highlight_group</span><span class="p">[</span><span class="s1">'indices'</span><span class="p">]</span> <span class="k">for</span> <span class="n">highlight_group</span> <span class="ow">in</span> <span class="n">match</span><span class="p">[</span><span class="s1">'matches'</span><span class="p">]]</span>
|
|
|
|
<span class="n">code</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">match</span><span class="p">[</span><span class="s1">'fragment'</span><span class="p">]</span>
|
|
<span class="n">original_code_lenght</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">code</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">ghc_strip_whitespace</span><span class="p">:</span>
|
|
<span class="n">code</span> <span class="o">=</span> <span class="n">code</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">ghc_strip_new_lines</span><span class="p">:</span>
|
|
<span class="n">code</span> <span class="o">=</span> <span class="n">code</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
|
|
|
<span class="n">offset</span> <span class="o">=</span> <span class="n">original_code_lenght</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">code</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">ghc_strip_whitespace</span><span class="p">:</span>
|
|
<span class="n">code</span> <span class="o">=</span> <span class="n">code</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="n">ghc_strip_new_lines</span><span class="p">:</span>
|
|
<span class="n">code</span> <span class="o">=</span> <span class="n">code</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
|
|
|
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">letter</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">code</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">highlight_groups</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
|
|
<span class="c1"># the API ensures these are sorted already, and we have a</span>
|
|
<span class="c1"># guaranteed match in the code (all indices are in the range 0</span>
|
|
<span class="c1"># and len(fragment)), so only check the first highlight group</span>
|
|
<span class="p">[</span><span class="n">after</span><span class="p">,</span> <span class="n">before</span><span class="p">]</span> <span class="o">=</span> <span class="n">highlight_groups</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
<span class="k">if</span> <span class="n">after</span> <span class="o"><=</span> <span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="n">offset</span><span class="p">)</span> <span class="o"><</span> <span class="n">before</span><span class="p">:</span>
|
|
<span class="c1"># pygments enumerates lines from 1, highlight the next line</span>
|
|
<span class="n">highlighted_lines_index</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">lines</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
|
|
<span class="n">highlight_groups</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">letter</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">:</span>
|
|
<span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">buffer</span><span class="p">))</span>
|
|
<span class="n">buffer</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">continue</span>
|
|
|
|
<span class="n">buffer</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">letter</span><span class="p">)</span>
|
|
<span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">buffer</span><span class="p">))</span>
|
|
<span class="k">return</span> <span class="n">lines</span><span class="p">,</span> <span class="n">highlighted_lines_index</span></div>
|
|
|
|
|
|
|
|
<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="o">-></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="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">422</span><span class="p">:</span>
|
|
<span class="c1"># on a invalid search term the status code 422 "Unprocessable Content"</span>
|
|
<span class="c1"># is returned / e.g. search term is "user: foo" instead "user:foo"</span>
|
|
<span class="k">return</span> <span class="n">res</span>
|
|
<span class="c1"># raise for other errors</span>
|
|
<span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
|
|
|
|
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'items'</span><span class="p">,</span> <span class="p">[]):</span>
|
|
<span class="n">repo</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">item</span><span class="p">[</span><span class="s1">'repository'</span><span class="p">]</span> <span class="c1"># pyright: ignore[reportAny]</span>
|
|
<span class="n">text_matches</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">item</span><span class="p">[</span><span class="s1">'text_matches'</span><span class="p">]</span> <span class="c1"># pyright: ignore[reportAny]</span>
|
|
<span class="c1"># ensure picking only the code contents in the blob</span>
|
|
<span class="n">code_matches</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="n">match</span> <span class="k">for</span> <span class="n">match</span> <span class="ow">in</span> <span class="n">text_matches</span> <span class="k">if</span> <span class="n">match</span><span class="p">[</span><span class="s2">"object_type"</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"FileContent"</span> <span class="ow">and</span> <span class="n">match</span><span class="p">[</span><span class="s2">"property"</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"content"</span>
|
|
<span class="p">]</span>
|
|
<span class="n">lines</span><span class="p">,</span> <span class="n">highlighted_lines_index</span> <span class="o">=</span> <span class="n">extract_code</span><span class="p">(</span><span class="n">code_matches</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">ghc_highlight_matching_lines</span><span class="p">:</span>
|
|
<span class="n">highlighted_lines_index</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</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">Code</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">"html_url"</span><span class="p">],</span> <span class="c1"># pyright: ignore[reportAny]</span>
|
|
<span class="n">title</span><span class="o">=</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">repo</span><span class="p">[</span><span class="s1">'full_name'</span><span class="p">]</span><span class="si">}</span><span class="s2"> · </span><span class="si">{</span><span class="n">item</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span>
|
|
<span class="n">filename</span><span class="o">=</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">item</span><span class="p">[</span><span class="s1">'path'</span><span class="p">]</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span>
|
|
<span class="n">content</span><span class="o">=</span><span class="n">repo</span><span class="p">[</span><span class="s1">'description'</span><span class="p">],</span>
|
|
<span class="n">repository</span><span class="o">=</span><span class="n">repo</span><span class="p">[</span><span class="s1">'html_url'</span><span class="p">],</span>
|
|
<span class="n">codelines</span><span class="o">=</span><span class="p">[(</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span> <span class="k">for</span> <span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">lines</span><span class="p">)],</span>
|
|
<span class="n">hl_lines</span><span class="o">=</span><span class="n">highlighted_lines_index</span><span class="p">,</span>
|
|
<span class="n">strip_whitespace</span><span class="o">=</span><span class="n">ghc_strip_whitespace</span><span class="p">,</span>
|
|
<span class="n">strip_new_lines</span><span class="o">=</span><span class="n">ghc_strip_new_lines</span><span class="p">,</span>
|
|
<span class="p">)</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">
|
|
© Copyright SearXNG team.
|
|
</div>
|
|
</body>
|
|
</html> |