diff options
author | 2022-02-28 00:01:03 +0000 | |
---|---|---|
committer | 2022-02-28 00:01:03 +0000 | |
commit | cf15bdf78a15c09aab02b47c048cc0bbb40200da (patch) | |
tree | 1fe4796bb447c7a766d0f82a6cdb6d7f1cab4c32 /output/botcore.utils.caching.html | |
parent | Deploying to docs from @ python-discord/bot-core@5593a0c95e2b4fd9515c8875ea6e... (diff) |
Deploying to docs from @ python-discord/bot-core@114db8556dd236fd5ba58061357e7ae1e5e732b2 🚀
Diffstat (limited to 'output/botcore.utils.caching.html')
-rw-r--r-- | output/botcore.utils.caching.html | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/output/botcore.utils.caching.html b/output/botcore.utils.caching.html index 5354328e..8e24036f 100644 --- a/output/botcore.utils.caching.html +++ b/output/botcore.utils.caching.html @@ -6,7 +6,7 @@ <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-4.4.0, furo 2022.02.23"/> - <title>caching - Bot Core v2.0.0</title> + <title>caching - Bot Core v2.1.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=3c656993158f05539f962c5cea52a5e6c184bb8c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=25ceb02ed1c46dc30f2321ff83e92799f69dfdb9" /> @@ -122,7 +122,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v2.0.0</div></a> + <a href="../index.html"><div class="brand">Bot Core v2.1.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -148,7 +148,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v2.0.0</span> + <span class="sidebar-brand-text">Bot Core v2.1.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -171,6 +171,7 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html">scheduling</a></li> </ul> </li> +<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html">site_api</a></li> </ul> </li> </ul> @@ -214,14 +215,14 @@ <p>Utilities related to custom caches.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</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/5593a0c95e2b4fd9515c8875ea6e51c0ab88eb00/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</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/114db8556dd236fd5ba58061357e7ae1e5e732b2/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>LRU cache implementation for coroutines.</p> <p>Once the cache exceeds the maximum size, keys are deleted in FIFO order.</p> <p>An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__call__"> -<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/5593a0c95e2b4fd9515c8875ea6e51c0ab88eb00/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> +<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/114db8556dd236fd5ba58061357e7ae1e5e732b2/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</dt> @@ -237,7 +238,7 @@ </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__init__"> -<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/5593a0c95e2b4fd9515c8875ea6e51c0ab88eb00/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> +<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/114db8556dd236fd5ba58061357e7ae1e5e732b2/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</dt> @@ -247,7 +248,7 @@ </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.clear"> -<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/5593a0c95e2b4fd9515c8875ea6e51c0ab88eb00/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> +<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/114db8556dd236fd5ba58061357e7ae1e5e732b2/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</dt> |