diff options
Diffstat (limited to 'v7.4.0/output/botcore.utils.caching.html')
| -rw-r--r-- | v7.4.0/output/botcore.utils.caching.html | 49 |
1 files changed, 39 insertions, 10 deletions
diff --git a/v7.4.0/output/botcore.utils.caching.html b/v7.4.0/output/botcore.utils.caching.html index 8b4091e3..d88bb1a7 100644 --- a/v7.4.0/output/botcore.utils.caching.html +++ b/v7.4.0/output/botcore.utils.caching.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="channel" href="botcore.utils.channel.html" /><link rel="prev" title="Utils" href="botcore.utils.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>caching - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> - <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc"> + <label class="toc-overlay-icon toc-header-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> @@ -206,6 +206,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.caching.html">v8.2.1</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.caching.html">v8.2.0</a> </li> @@ -325,7 +329,7 @@ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> - <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc"> + <label class="toc-overlay-icon toc-content-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> @@ -346,13 +350,13 @@ <span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__call__" title="Permalink to this definition">#</a></dt> <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>arg_offset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The offset for the position of the key argument.</p> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a></p> </dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dt class="field-odd">Returns</dt> <dd class="field-odd"><p>A decorator to wrap the target function.</p> </dd> </dl> @@ -363,7 +367,7 @@ <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialise a new <a class="reference internal" href="#botcore.utils.caching.AsyncCache" title="botcore.utils.caching.AsyncCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncCache</span></code></a> instance.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – How many items to store in the cache.</p> </dd> </dl> @@ -374,7 +378,7 @@ <span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.clear" title="Permalink to this definition">#</a></dt> <dd><p>Clear cache instance.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -429,8 +433,32 @@ </footer> </div> - <aside class="toc-drawer no-toc"> + <aside class="toc-drawer"> + + <div class="toc-sticky toc-scroll"> + <div class="toc-title-container"> + <span class="toc-title"> + On this page + </span> + </div> + <div class="toc-tree-container"> + <div class="toc-tree"> + <ul> +<li><a class="reference internal" href="#">caching</a><ul> +<li><a class="reference internal" href="#botcore.utils.caching.AsyncCache"><code class="docutils literal notranslate"><span class="pre">AsyncCache</span></code></a><ul> +<li><a class="reference internal" href="#botcore.utils.caching.AsyncCache.__call__"><code class="docutils literal notranslate"><span class="pre">AsyncCache.__call__()</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.caching.AsyncCache.__init__"><code class="docutils literal notranslate"><span class="pre">AsyncCache.__init__()</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.caching.AsyncCache.clear"><code class="docutils literal notranslate"><span class="pre">AsyncCache.clear()</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> + + </div> + </div> + </div> </aside> @@ -440,6 +468,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> |