NTab仓库
fjmwkj
/
searxng
mirror of https://github.com/searxng/searxng
1
0
Fork 0
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
searxng
/
_modules
/
searx
/
redislib.html

redislib.html 23 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362 
  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>searx.redislib &#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.   </head><body>
    18. 

  18.     <div class="related" role="navigation" aria-label="Related">
    19. 

  19.       <h3>Navigation</h3>
    20. 

  20.       <ul>
    21. 

  21.         <li class="right" style="margin-right: 10px">
    22. 

  22.           <a href="../../genindex.html" title="General Index"
    23. 

  23.              accesskey="I">index</a></li>
    24. 

  24.         <li class="right" >
    25. 

  25.           <a href="../../py-modindex.html" title="Python Module Index"
    26. 

  26.              >modules</a> |</li>
    27. 

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

  28.           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
    29. 

  29.         <li class="nav-item nav-item-this"><a href="">searx.redislib</a></li> 
    30. 

  30.       </ul>
    31. 

  31.     </div>  
    32. 

  32. 

  33.     <div class="document">
    34. 

  34.       <div class="documentwrapper">
    35. 

  35.         <div class="bodywrapper">
    36. 

  36.           <div class="body" role="main">
    37. 

  37.             
    38. 

  38.   <h1>Source code for searx.redislib</h1><div class="highlight"><pre>
    39. 

  39. <span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
    40. 

  40. <span class="sd">&quot;&quot;&quot;A collection of convenient functions and redis/lua scripts.</span>
    41. 

  41. 

  42. <span class="sd">This code was partial inspired by the `Bullet-Proofing Lua Scripts in RedisPy`_</span>
    43. 

  43. <span class="sd">article.</span>
    44. 

  44. 

  45. <span class="sd">.. _Bullet-Proofing Lua Scripts in RedisPy:</span>
    46. 

  46. <span class="sd">   https://redis.com/blog/bullet-proofing-lua-scripts-in-redispy/</span>
    47. 

  47. 

  48. <span class="sd">&quot;&quot;&quot;</span>
    49. 

  49. 

  50. <span class="kn">import</span><span class="w"> </span><span class="nn">hmac</span>
    51. 

  51. 

  52. <span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_setting</span>
    53. 

  53. 

  54. <span class="n">LUA_SCRIPT_STORAGE</span> <span class="o">=</span> <span class="p">{}</span>
    55. 

  55. <span class="sd">&quot;&quot;&quot;A global dictionary to cache client&#39;s ``Script`` objects, used by</span>
    56. 

  56. <span class="sd">:py:obj:`lua_script_storage`&quot;&quot;&quot;</span>
    57. 

  57. 

  58. 

  59. <div class="viewcode-block" id="lua_script_storage">
    60. 

  60. <a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.lua_script_storage">[docs]</a>
    61. 

  61. <span class="k">def</span><span class="w"> </span><span class="nf">lua_script_storage</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">script</span><span class="p">):</span>
    62. 

  62. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns a redis :py:obj:`Script</span>
    63. 

  63. <span class="sd">    &lt;redis.commands.core.CoreCommands.register_script&gt;` instance.</span>
    64. 

  64. 

  65. <span class="sd">    Due to performance reason the ``Script`` object is instantiated only once</span>
    66. 

  66. <span class="sd">    for a client (``client.register_script(..)``) and is cached in</span>
    67. 

  67. <span class="sd">    :py:obj:`LUA_SCRIPT_STORAGE`.</span>
    68. 

  68. 

  69. <span class="sd">    &quot;&quot;&quot;</span>
    70. 

  70. 

  71.     <span class="c1"># redis connection can be closed, lets use the id() of the redis connector</span>
    72. 

  72.     <span class="c1"># as key in the script-storage:</span>
    73. 

  73.     <span class="n">client_id</span> <span class="o">=</span> <span class="nb">id</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
    74. 

  74. 

  75.     <span class="k">if</span> <span class="n">LUA_SCRIPT_STORAGE</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">client_id</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    76. 

  76.         <span class="n">LUA_SCRIPT_STORAGE</span><span class="p">[</span><span class="n">client_id</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
    77. 

  77. 

  78.     <span class="k">if</span> <span class="n">LUA_SCRIPT_STORAGE</span><span class="p">[</span><span class="n">client_id</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">script</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    79. 

  79.         <span class="n">LUA_SCRIPT_STORAGE</span><span class="p">[</span><span class="n">client_id</span><span class="p">][</span><span class="n">script</span><span class="p">]</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">register_script</span><span class="p">(</span><span class="n">script</span><span class="p">)</span>
    80. 

  80. 

  81.     <span class="k">return</span> <span class="n">LUA_SCRIPT_STORAGE</span><span class="p">[</span><span class="n">client_id</span><span class="p">][</span><span class="n">script</span><span class="p">]</span></div>
    82. 

  82. 

  83. 

  84. 

  85. <span class="n">PURGE_BY_PREFIX</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
    86. 

  86. <span class="s2">local prefix = tostring(ARGV[1])</span>
    87. 

  87. <span class="s2">for i, name in ipairs(redis.call(&#39;KEYS&#39;, prefix .. &#39;*&#39;)) do</span>
    88. 

  88. <span class="s2">    redis.call(&#39;EXPIRE&#39;, name, 0)</span>
    89. 

  89. <span class="s2">end</span>
    90. 

  90. <span class="s2">&quot;&quot;&quot;</span>
    91. 

  91. 

  92. 

  93. <div class="viewcode-block" id="purge_by_prefix">
    94. 

  94. <a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.purge_by_prefix">[docs]</a>
    95. 

  95. <span class="k">def</span><span class="w"> </span><span class="nf">purge_by_prefix</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">prefix</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;SearXNG_&quot;</span><span class="p">):</span>
    96. 

  96. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Purge all keys with ``prefix`` from database.</span>
    97. 

  97. 

  98. <span class="sd">    Queries all keys in the database by the given prefix and set expire time to</span>
    99. 

  99. <span class="sd">    zero.  The default prefix will drop all keys which has been set by SearXNG</span>
    100. 

  100. <span class="sd">    (drops SearXNG schema entirely from database).</span>
    101. 

  101. 

  102. <span class="sd">    The implementation is the lua script from string :py:obj:`PURGE_BY_PREFIX`.</span>
    103. 

  103. <span class="sd">    The lua script uses EXPIRE_ instead of DEL_: if there are a lot keys to</span>
    104. 

  104. <span class="sd">    delete and/or their values are big, `DEL` could take more time and blocks</span>
    105. 

  105. <span class="sd">    the command loop while `EXPIRE` turns back immediate.</span>
    106. 

  106. 

  107. <span class="sd">    :param prefix: prefix of the key to delete (default: ``SearXNG_``)</span>
    108. 

  108. <span class="sd">    :type name: str</span>
    109. 

  109. 

  110. <span class="sd">    .. _EXPIRE: https://redis.io/commands/expire/</span>
    111. 

  111. <span class="sd">    .. _DEL: https://redis.io/commands/del/</span>
    112. 

  112. 

  113. <span class="sd">    &quot;&quot;&quot;</span>
    114. 

  114.     <span class="n">script</span> <span class="o">=</span> <span class="n">lua_script_storage</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">PURGE_BY_PREFIX</span><span class="p">)</span>
    115. 

  115.     <span class="n">script</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="n">prefix</span><span class="p">])</span></div>
    116. 

  116. 

  117. 

  118. 

  119. <div class="viewcode-block" id="secret_hash">
    120. 

  120. <a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.secret_hash">[docs]</a>
    121. 

  121. <span class="k">def</span><span class="w"> </span><span class="nf">secret_hash</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    122. 

  122. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Creates a hash of the ``name``.</span>
    123. 

  123. 

  124. <span class="sd">    Combines argument ``name`` with the ``secret_key`` from :ref:`settings</span>
    125. 

  125. <span class="sd">    server`.  This function can be used to get a more anonymized name of a Redis</span>
    126. 

  126. <span class="sd">    KEY.</span>
    127. 

  127. 

  128. <span class="sd">    :param name: the name to create a secret hash for</span>
    129. 

  129. <span class="sd">    :type name: str</span>
    130. 

  130. <span class="sd">    &quot;&quot;&quot;</span>
    131. 

  131.     <span class="n">m</span> <span class="o">=</span> <span class="n">hmac</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">bytes</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">),</span> <span class="n">digestmod</span><span class="o">=</span><span class="s1">&#39;sha256&#39;</span><span class="p">)</span>
    132. 

  132.     <span class="n">m</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="nb">bytes</span><span class="p">(</span><span class="n">get_setting</span><span class="p">(</span><span class="s1">&#39;server.secret_key&#39;</span><span class="p">),</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">))</span>
    133. 

  133.     <span class="k">return</span> <span class="n">m</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span></div>
    134. 

  134. 

  135. 

  136. 

  137. <span class="n">INCR_COUNTER</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
    138. 

  138. <span class="s2">local limit = tonumber(ARGV[1])</span>
    139. 

  139. <span class="s2">local expire = tonumber(ARGV[2])</span>
    140. 

  140. <span class="s2">local c_name = KEYS[1]</span>
    141. 

  141. 

  142. <span class="s2">local c = redis.call(&#39;GET&#39;, c_name)</span>
    143. 

  143. 

  144. <span class="s2">if not c then</span>
    145. 

  145. <span class="s2">    c = redis.call(&#39;INCR&#39;, c_name)</span>
    146. 

  146. <span class="s2">    if expire &gt; 0 then</span>
    147. 

  147. <span class="s2">        redis.call(&#39;EXPIRE&#39;, c_name, expire)</span>
    148. 

  148. <span class="s2">    end</span>
    149. 

  149. <span class="s2">else</span>
    150. 

  150. <span class="s2">    c = tonumber(c)</span>
    151. 

  151. <span class="s2">    if limit == 0 or c &lt; limit then</span>
    152. 

  152. <span class="s2">       c = redis.call(&#39;INCR&#39;, c_name)</span>
    153. 

  153. <span class="s2">    end</span>
    154. 

  154. <span class="s2">end</span>
    155. 

  155. <span class="s2">return c</span>
    156. 

  156. <span class="s2">&quot;&quot;&quot;</span>
    157. 

  157. 

  158. 

  159. <div class="viewcode-block" id="incr_counter">
    160. 

  160. <a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.incr_counter">[docs]</a>
    161. 

  161. <span class="k">def</span><span class="w"> </span><span class="nf">incr_counter</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">expire</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
    162. 

  162. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Increment a counter and return the new value.</span>
    163. 

  163. 

  164. <span class="sd">    If counter with redis key ``SearXNG_counter_&lt;name&gt;`` does not exists it is</span>
    165. 

  165. <span class="sd">    created with initial value 1 returned.  The replacement ``&lt;name&gt;`` is a</span>
    166. 

  166. <span class="sd">    *secret hash* of the value from argument ``name`` (see</span>
    167. 

  167. <span class="sd">    :py:func:`secret_hash`).</span>
    168. 

  168. 

  169. <span class="sd">    The implementation of the redis counter is the lua script from string</span>
    170. 

  170. <span class="sd">    :py:obj:`INCR_COUNTER`.</span>
    171. 

  171. 

  172. <span class="sd">    :param name: name of the counter</span>
    173. 

  173. <span class="sd">    :type name: str</span>
    174. 

  174. 

  175. <span class="sd">    :param expire: live-time of the counter in seconds (default ``None`` means</span>
    176. 

  176. <span class="sd">      infinite).</span>
    177. 

  177. <span class="sd">    :type expire: int / see EXPIRE_</span>
    178. 

  178. 

  179. <span class="sd">    :param limit: limit where the counter stops to increment (default ``None``)</span>
    180. 

  180. <span class="sd">    :type limit: int / limit is 2^64 see INCR_</span>
    181. 

  181. 

  182. <span class="sd">    :return: value of the incremented counter</span>
    183. 

  183. <span class="sd">    :type return: int</span>
    184. 

  184. 

  185. <span class="sd">    .. _EXPIRE: https://redis.io/commands/expire/</span>
    186. 

  186. <span class="sd">    .. _INCR: https://redis.io/commands/incr/</span>
    187. 

  187. 

  188. <span class="sd">    A simple demo of a counter with expire time and limit::</span>
    189. 

  189. 

  190. <span class="sd">      &gt;&gt;&gt; for i in range(6):</span>
    191. 

  191. <span class="sd">      ...   i, incr_counter(client, &quot;foo&quot;, 3, 5) # max 3, duration 5 sec</span>
    192. 

  192. <span class="sd">      ...   time.sleep(1) # from the third call on max has been reached</span>
    193. 

  193. <span class="sd">      ...</span>
    194. 

  194. <span class="sd">      (0, 1)</span>
    195. 

  195. <span class="sd">      (1, 2)</span>
    196. 

  196. <span class="sd">      (2, 3)</span>
    197. 

  197. <span class="sd">      (3, 3)</span>
    198. 

  198. <span class="sd">      (4, 3)</span>
    199. 

  199. <span class="sd">      (5, 1)</span>
    200. 

  200. 

  201. <span class="sd">    &quot;&quot;&quot;</span>
    202. 

  202.     <span class="n">script</span> <span class="o">=</span> <span class="n">lua_script_storage</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">INCR_COUNTER</span><span class="p">)</span>
    203. 

  203.     <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;SearXNG_counter_&quot;</span> <span class="o">+</span> <span class="n">secret_hash</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    204. 

  204.     <span class="n">c</span> <span class="o">=</span> <span class="n">script</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="n">limit</span><span class="p">,</span> <span class="n">expire</span><span class="p">],</span> <span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="n">name</span><span class="p">])</span>
    205. 

  205.     <span class="k">return</span> <span class="n">c</span></div>
    206. 

  206. 

  207. 

  208. 

  209. <div class="viewcode-block" id="drop_counter">
    210. 

  210. <a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.drop_counter">[docs]</a>
    211. 

  211. <span class="k">def</span><span class="w"> </span><span class="nf">drop_counter</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
    212. 

  212. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Drop counter with redis key ``SearXNG_counter_&lt;name&gt;``</span>
    213. 

  213. 

  214. <span class="sd">    The replacement ``&lt;name&gt;`` is a *secret hash* of the value from argument</span>
    215. 

  215. <span class="sd">    ``name`` (see :py:func:`incr_counter` and :py:func:`incr_sliding_window`).</span>
    216. 

  216. <span class="sd">    &quot;&quot;&quot;</span>
    217. 

  217.     <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;SearXNG_counter_&quot;</span> <span class="o">+</span> <span class="n">secret_hash</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    218. 

  218.     <span class="n">client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
    219. 

  219. 

  220. 

  221. 

  222. <span class="n">INCR_SLIDING_WINDOW</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
    223. 

  223. <span class="s2">local expire = tonumber(ARGV[1])</span>
    224. 

  224. <span class="s2">local name = KEYS[1]</span>
    225. 

  225. <span class="s2">local current_time = redis.call(&#39;TIME&#39;)</span>
    226. 

  226. 

  227. <span class="s2">redis.call(&#39;ZREMRANGEBYSCORE&#39;, name, 0, current_time[1] - expire)</span>
    228. 

  228. <span class="s2">redis.call(&#39;ZADD&#39;, name, current_time[1], current_time[1] .. current_time[2])</span>
    229. 

  229. <span class="s2">local result = redis.call(&#39;ZCOUNT&#39;, name, 0, current_time[1] + 1)</span>
    230. 

  230. <span class="s2">redis.call(&#39;EXPIRE&#39;, name, expire)</span>
    231. 

  231. <span class="s2">return result</span>
    232. 

  232. <span class="s2">&quot;&quot;&quot;</span>
    233. 

  233. 

  234. 

  235. <div class="viewcode-block" id="incr_sliding_window">
    236. 

  236. <a class="viewcode-back" href="../../src/searx.redislib.html#searx.redislib.incr_sliding_window">[docs]</a>
    237. 

  237. <span class="k">def</span><span class="w"> </span><span class="nf">incr_sliding_window</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">duration</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
    238. 

  238. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Increment a sliding-window counter and return the new value.</span>
    239. 

  239. 

  240. <span class="sd">    If counter with redis key ``SearXNG_counter_&lt;name&gt;`` does not exists it is</span>
    241. 

  241. <span class="sd">    created with initial value 1 returned.  The replacement ``&lt;name&gt;`` is a</span>
    242. 

  242. <span class="sd">    *secret hash* of the value from argument ``name`` (see</span>
    243. 

  243. <span class="sd">    :py:func:`secret_hash`).</span>
    244. 

  244. 

  245. <span class="sd">    :param name: name of the counter</span>
    246. 

  246. <span class="sd">    :type name: str</span>
    247. 

  247. 

  248. <span class="sd">    :param duration: live-time of the sliding window in seconds</span>
    249. 

  249. <span class="sd">    :typeduration: int</span>
    250. 

  250. 

  251. <span class="sd">    :return: value of the incremented counter</span>
    252. 

  252. <span class="sd">    :type return: int</span>
    253. 

  253. 

  254. <span class="sd">    The implementation of the redis counter is the lua script from string</span>
    255. 

  255. <span class="sd">    :py:obj:`INCR_SLIDING_WINDOW`.  The lua script uses `sorted sets in Redis`_</span>
    256. 

  256. <span class="sd">    to implement a sliding window for the redis key ``SearXNG_counter_&lt;name&gt;``</span>
    257. 

  257. <span class="sd">    (ZADD_).  The current TIME_ is used to score the items in the sorted set and</span>
    258. 

  258. <span class="sd">    the time window is moved by removing items with a score lower current time</span>
    259. 

  259. <span class="sd">    minus *duration* time (ZREMRANGEBYSCORE_).</span>
    260. 

  260. 

  261. <span class="sd">    The EXPIRE_ time (the duration of the sliding window) is refreshed on each</span>
    262. 

  262. <span class="sd">    call (increment) and if there is no call in this duration, the sorted</span>
    263. 

  263. <span class="sd">    set expires from the redis DB.</span>
    264. 

  264. 

  265. <span class="sd">    The return value is the amount of items in the sorted set (ZCOUNT_), what</span>
    266. 

  266. <span class="sd">    means the number of calls in the sliding window.</span>
    267. 

  267. 

  268. <span class="sd">    .. _Sorted sets in Redis:</span>
    269. 

  269. <span class="sd">       https://redis.com/ebook/part-1-getting-started/chapter-1-getting-to-know-redis/1-2-what-redis-data-structures-look-like/1-2-5-sorted-sets-in-redis/</span>
    270. 

  270. <span class="sd">    .. _TIME: https://redis.io/commands/time/</span>
    271. 

  271. <span class="sd">    .. _ZADD: https://redis.io/commands/zadd/</span>
    272. 

  272. <span class="sd">    .. _EXPIRE: https://redis.io/commands/expire/</span>
    273. 

  273. <span class="sd">    .. _ZREMRANGEBYSCORE: https://redis.io/commands/zremrangebyscore/</span>
    274. 

  274. <span class="sd">    .. _ZCOUNT: https://redis.io/commands/zcount/</span>
    275. 

  275. 

  276. <span class="sd">    A simple demo of the sliding window::</span>
    277. 

  277. 

  278. <span class="sd">      &gt;&gt;&gt; for i in range(5):</span>
    279. 

  279. <span class="sd">      ...   incr_sliding_window(client, &quot;foo&quot;, 3) # duration 3 sec</span>
    280. 

  280. <span class="sd">      ...   time.sleep(1) # from the third call (second) on the window is moved</span>
    281. 

  281. <span class="sd">      ...</span>
    282. 

  282. <span class="sd">      1</span>
    283. 

  283. <span class="sd">      2</span>
    284. 

  284. <span class="sd">      3</span>
    285. 

  285. <span class="sd">      3</span>
    286. 

  286. <span class="sd">      3</span>
    287. 

  287. <span class="sd">      &gt;&gt;&gt; time.sleep(3)  # wait until expire</span>
    288. 

  288. <span class="sd">      &gt;&gt;&gt; incr_sliding_window(client, &quot;foo&quot;, 3)</span>
    289. 

  289. <span class="sd">      1</span>
    290. 

  290. 

  291. <span class="sd">    &quot;&quot;&quot;</span>
    292. 

  292.     <span class="n">script</span> <span class="o">=</span> <span class="n">lua_script_storage</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">INCR_SLIDING_WINDOW</span><span class="p">)</span>
    293. 

  293.     <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;SearXNG_counter_&quot;</span> <span class="o">+</span> <span class="n">secret_hash</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    294. 

  294.     <span class="n">c</span> <span class="o">=</span> <span class="n">script</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="p">[</span><span class="n">duration</span><span class="p">],</span> <span class="n">keys</span><span class="o">=</span><span class="p">[</span><span class="n">name</span><span class="p">])</span>
    295. 

  295.     <span class="k">return</span> <span class="n">c</span></div>
    296. 

  296. 

  297. </pre></div>
    298. 

  298. 

  299.             <div class="clearer"></div>
    300. 

  300.           </div>
    301. 

  301.         </div>
    302. 

  302.       </div>
    303. 

  303.   <span id="sidebar-top"></span>
    304. 

  304.       <div class="sphinxsidebar" role="navigation" aria-label="Main">
    305. 

  305.         <div class="sphinxsidebarwrapper">
    306. 

  306.   
    307. 

  307.     
    308. 

  308.             <p class="logo"><a href="../../index.html">
    309. 

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

  310.             </a></p>
    311. 

  311.   
    312. 

  312. 

  313. <h3><a href="../../index.html">Table of Contents</a></h3>
    314. 

  314. <ul>
    315. 

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

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

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

  318. <li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
    319. 

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

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

  321. </ul>
    322. 

  322. 

  323.   <h3>Project Links</h3>
    324. 

  324.   <ul>
    325. 

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

  326.   
    327. 

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

  328.   
    329. 

  329.     <li><a href="https://searx.space">Public instances</a>
    330. 

  330.   
    331. 

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

  332.   </ul><h3>Navigation</h3>
    333. 

  333. <ul>
    334. 

  334.   <li><a href="../../index.html">Overview</a>
    335. 

  335.     <ul>
    336. 

  336.       <li><a href="../index.html">Module code</a>
    337. 

  337.         
    338. 

  338.           
    339. 

  339.           </ul>
    340. 

  340.       </li>
    341. 

  341.     </ul>
    342. 

  342.   </li>
    343. 

  343. </ul>
    344. 

  344. <search id="searchbox" style="display: none" role="search">
    345. 

  345.   <h3 id="searchlabel">Quick search</h3>
    346. 

  346.     <div class="searchformwrapper">
    347. 

  347.     <form class="search" action="../../search.html" method="get">
    348. 

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

  349.       <input type="submit" value="Go" />
    350. 

  350.     </form>
    351. 

  351.     </div>
    352. 

  352. </search>
    353. 

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

  354.         </div>
    355. 

  355.       </div>
    356. 

  356.       <div class="clearer"></div>
    357. 

  357.     </div>
    358. 

  358.     <div class="footer" role="contentinfo">
    359. 

  359.     &#169; Copyright SearXNG team.
    360. 

  360.     </div>
    361. 

  361.   </body>
    362. 

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