diff options
Diffstat (limited to 'main/output/pydis_core.utils.caching.html')
-rw-r--r-- | main/output/pydis_core.utils.caching.html | 88 |
1 files changed, 4 insertions, 84 deletions
diff --git a/main/output/pydis_core.utils.caching.html b/main/output/pydis_core.utils.caching.html index 7ff11ca8..96d213dc 100644 --- a/main/output/pydis_core.utils.caching.html +++ b/main/output/pydis_core.utils.caching.html @@ -280,86 +280,6 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.3.0-beta/index.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/index.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/index.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/index.html">v8.1.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.3/index.html">v8.0.0-beta.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.2/index.html">v8.0.0-beta.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.1/index.html">v8.0.0-beta.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0/index.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/index.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/index.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/index.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/index.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/index.html">v7.3.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.2/index.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/index.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/index.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/index.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/index.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/index.html">v7.1.1</a> - </li> - - <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.caching.html">v10.7.0</a> </li> @@ -455,14 +375,14 @@ <p>Utilities related to custom caches.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache" title="Link 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/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache" title="Link 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.12)"><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="pydis_core.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/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__call__" title="Link 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/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__call__" title="Link 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> @@ -479,7 +399,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__init__" title="Link 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/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__init__" title="Link to this definition">#</a></dt> <dd><p>Initialise a new <a class="reference internal" href="#pydis_core.utils.caching.AsyncCache" title="pydis_core.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> @@ -490,7 +410,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.clear" title="Link 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/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.clear" title="Link 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> |