diff options
Diffstat (limited to 'v7.1.1/output/botcore.utils.caching.html')
| -rw-r--r-- | v7.1.1/output/botcore.utils.caching.html | 574 | 
1 files changed, 0 insertions, 574 deletions
| diff --git a/v7.1.1/output/botcore.utils.caching.html b/v7.1.1/output/botcore.utils.caching.html deleted file mode 100644 index 5a914245..00000000 --- a/v7.1.1/output/botcore.utils.caching.html +++ /dev/null @@ -1,574 +0,0 @@ -<!doctype html> -<html class="no-js" lang="en" data-content_root="../"> -  <head><meta charset="utf-8"/> -    <meta name="viewport" content="width=device-width,initial-scale=1"/> -    <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> -<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"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> -        <title>caching - Pydis Core v7.1.1</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> -    <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" /> -    <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> -     -     - - -<style> -  body { -    --color-code-background: #f8f8f8; -  --color-code-foreground: black; -  --color-api-name: var(--color-link); -   -  } -  @media not print { -    body[data-theme="dark"] { -      --color-code-background: #202020; -  --color-code-foreground: #d0d0d0; -   -    } -    @media (prefers-color-scheme: dark) { -      body:not([data-theme="light"]) { -        --color-code-background: #202020; -  --color-code-foreground: #d0d0d0; -   -      } -    } -  } -</style></head> -  <body> -     -    <script> -      document.body.dataset.theme = localStorage.getItem("theme") || "auto"; -    </script> -     - -<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> -  <symbol id="svg-toc" viewBox="0 0 24 24"> -    <title>Contents</title> -    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> -      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> -    </svg> -  </symbol> -  <symbol id="svg-menu" viewBox="0 0 24 24"> -    <title>Menu</title> -    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" -      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> -      <line x1="3" y1="12" x2="21" y2="12"></line> -      <line x1="3" y1="6" x2="21" y2="6"></line> -      <line x1="3" y1="18" x2="21" y2="18"></line> -    </svg> -  </symbol> -  <symbol id="svg-arrow-right" viewBox="0 0 24 24"> -    <title>Expand</title> -    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" -      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> -      <polyline points="9 18 15 12 9 6"></polyline> -    </svg> -  </symbol> -  <symbol id="svg-sun" viewBox="0 0 24 24"> -    <title>Light mode</title> -    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" -      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> -      <circle cx="12" cy="12" r="5"></circle> -      <line x1="12" y1="1" x2="12" y2="3"></line> -      <line x1="12" y1="21" x2="12" y2="23"></line> -      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> -      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> -      <line x1="1" y1="12" x2="3" y2="12"></line> -      <line x1="21" y1="12" x2="23" y2="12"></line> -      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> -      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> -    </svg> -  </symbol> -  <symbol id="svg-moon" viewBox="0 0 24 24"> -    <title>Dark mode</title> -    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" -      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> -      <path stroke="none" d="M0 0h24v24H0z" fill="none" /> -      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> -    </svg> -  </symbol> -  <symbol id="svg-sun-half" viewBox="0 0 24 24"> -    <title>Auto light/dark mode</title> -    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" -      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> -      <path stroke="none" d="M0 0h24v24H0z" fill="none"/> -      <circle cx="12" cy="12" r="9" /> -      <path d="M13 12h5" /> -      <path d="M13 15h4" /> -      <path d="M13 18h1" /> -      <path d="M13 9h4" /> -      <path d="M13 6h1" /> -    </svg> -  </symbol> -</svg> - -<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> -<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> -<label class="overlay sidebar-overlay" for="__navigation"> -  <div class="visually-hidden">Hide navigation sidebar</div> -</label> -<label class="overlay toc-overlay" for="__toc"> -  <div class="visually-hidden">Hide table of contents sidebar</div> -</label> - - - -<div class="page"> -  <header class="mobile-header"> -    <div class="header-left"> -      <label class="nav-overlay-icon" for="__navigation"> -        <div class="visually-hidden">Toggle site navigation sidebar</div> -        <i class="icon"><svg><use href="#svg-menu"></use></svg></i> -      </label> -    </div> -    <div class="header-center"> -      <a href="../index.html"><div class="brand">Pydis Core v7.1.1</div></a> -    </div> -    <div class="header-right"> -      <div class="theme-toggle-container theme-toggle-header"> -        <button class="theme-toggle"> -          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> -          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> -          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> -          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> -        </button> -      </div> -      <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> -    </div> -  </header> -  <aside class="sidebar-drawer"> -    <div class="sidebar-container"> -       -      <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html"> -   -  <div class="sidebar-logo-container"> -    <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">Pydis Core v7.1.1</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"> -  <input type="hidden" name="check_keywords" value="yes"> -  <input type="hidden" name="area" value="default"> -</form> -<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> -    <p class="caption" role="heading"><span class="caption-text">Modules:</span></p> -<ul class="current"> -<li class="toctree-l1 current has-children"><a class="reference internal" href="botcore.html">Botcore</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Botcore</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="botcore.exts.html">Exts</a></li> -<li class="toctree-l2 current has-children"><a class="reference internal" href="botcore.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> -<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">caching</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.regex.html">regex</a></li> -<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.async_stats.html">async_stats</a></li> -<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html">site_api</a></li> -</ul> -</li> -</ul> -<p class="caption" role="heading"><span class="caption-text">Other:</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> -</ul> - - -     -     -    <ul> -        <li class="toctree-l1 has-children "> -             -            <a class="reference internal" href="../versions.html">Versions</a> -            <input  class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox"> -            <label for="toctree-checkbox-versions"> -                <div class="visually-hidden">Toggle child pages in navigation</div> -                <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i> -            </label> -             - -            <ul> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../main/index.html">main</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.9.2/index.html">v9.9.2</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.9.1/index.html">v9.9.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.9.0/index.html">v9.9.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.8.0/index.html">v9.8.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.7.0/index.html">v9.7.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.6.0/index.html">v9.6.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.5.1/index.html">v9.5.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.5.0/index.html">v9.5.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.4.1/index.html">v9.4.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.4.0/index.html">v9.4.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.3.0/index.html">v9.3.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.2.0/index.html">v9.2.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.10.0-alpha.2/index.html">v9.10.0-alpha.2</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.10.0-alpha.1/index.html">v9.10.0-alpha.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.1.1/index.html">v9.1.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v9.0.0/index.html">v9.0.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v8.3.0-beta/output/botcore.utils.caching.html">v8.3.0-beta</a> -                    </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> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.caching.html">v8.1.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.utils.caching.html">v8.0.0-beta.4</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v8.0.0-beta.3/output/botcore.utils.caching.html">v8.0.0-beta.3</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v8.0.0-beta.2/output/botcore.utils.caching.html">v8.0.0-beta.2</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v8.0.0-beta.1/output/botcore.utils.caching.html">v8.0.0-beta.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v8.0.0/output/botcore.utils.caching.html">v8.0.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.5.0/output/botcore.utils.caching.html">v7.5.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.utils.caching.html">v7.4.0-beta1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.caching.html">v7.4.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.caching.html">v7.3.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.3.0/output/botcore.utils.caching.html">v7.3.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.2.2/output/botcore.utils.caching.html">v7.2.2</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.2.1/output/botcore.utils.caching.html">v7.2.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.caching.html">v7.2.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.1.3/output/botcore.utils.caching.html">v7.1.3</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v7.1.2/output/botcore.utils.caching.html">v7.1.2</a> -                    </li> -                 -                    <li class="toctree-l2 current-page"> -                        <a class="version_link reference internal" href="botcore.utils.caching.html">v7.1.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.7.0/index.html">v10.7.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.6.0/index.html">v10.6.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.5.1/index.html">v10.5.1</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.5.0/index.html">v10.5.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.4.0/index.html">v10.4.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.3.0/index.html">v10.3.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.2.0/index.html">v10.2.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.1.0/index.html">v10.1.0</a> -                    </li> -                 -                    <li class="toctree-l2 "> -                        <a class="version_link reference internal" href="../../v10.0.0/index.html">v10.0.0</a> -                    </li> -                 - -                <script> -                    // Make sure we keep any hyperlinked resources when switching version -                    function updateHash() { -                        for (let tag of document.getElementsByClassName("version_link")) { -                            // Extract the original URL -                            let destination = tag.getAttribute("href"); -                            if (destination.indexOf("#") !== -1) { -                                destination = destination.slice(0, destination.indexOf("#")); -                            } - -                            // Update the url with the current hash -                            tag.setAttribute("href", destination + document.location.hash); -                        } -                    } - -                    updateHash(); -                    addEventListener("hashchange", _ => { updateHash() }); -                </script> -            </ul> -        </li> -    </ul> -     -</div> -</div> - -      </div> -       -    </div> -  </aside> -  <div class="main"> -    <div class="content"> -      <div class="article-container"> -        <a href="#" class="back-to-top muted-link"> -          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> -            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> -          </svg> -          <span>Back to top</span> -        </a> -        <div class="content-icon-container"> -           -<div class="theme-toggle-container theme-toggle-content"> -            <button class="theme-toggle"> -              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> -              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> -              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> -              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> -            </button> -          </div> -          <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> -        </div> -        <article role="main"> -          <section id="module-botcore.utils.caching"> -<span id="caching"></span><h1>caching<a class="headerlink" href="#module-botcore.utils.caching" title="Link to this heading">#</a></h1> -<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/6659680429eec1dd0d45a6332a329a8b5e5a0d0b/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="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="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/6659680429eec1dd0d45a6332a329a8b5e5a0d0b/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="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> -<dd class="field-odd"><p><strong>arg_offset</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The offset for the position of the key argument.</p> -</dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a></span></p> -</dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>A decorator to wrap the target function.</p> -</dd> -</dl> -</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/6659680429eec1dd0d45a6332a329a8b5e5a0d0b/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="Link 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> -<dd class="field-odd"><p><strong>max_size</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – How many items to store in the cache.</p> -</dd> -</dl> -</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/6659680429eec1dd0d45a6332a329a8b5e5a0d0b/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="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> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> -</dd> -</dl> -</dd></dl> - -</dd></dl> - -</section> - -        </article> -      </div> -      <footer> -         -        <div class="related-pages"> -          <a class="next-page" href="botcore.utils.channel.html"> -              <div class="page-info"> -                <div class="context"> -                  <span>Next</span> -                </div> -                <div class="title">channel</div> -              </div> -              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> -            </a> -          <a class="prev-page" href="botcore.utils.html"> -              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> -              <div class="page-info"> -                <div class="context"> -                  <span>Previous</span> -                </div> -                 -                <div class="title">Utils</div> -                 -              </div> -            </a> -        </div> -        <div class="bottom-of-page"> -          <div class="left-details"> -            <div class="copyright"> -                Copyright © 2021, Python Discord -            </div> -            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s -             -            <a href="https://github.com/pradyunsg/furo">Furo</a> -             -          </div> -          <div class="right-details"> -             -          </div> -        </div> -         -      </footer> -    </div> -    <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> -  </div> -</div><script src="../_static/documentation_options.js?v=3a48702f"></script> -    <script src="../_static/doctools.js?v=888ff710"></script> -    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> -    <script src="../_static/scripts/furo.js?v=32e29ea5"></script> -    <script src="../_static/changelog.js?v=11ff7913"></script> -    </body> -</html>
\ No newline at end of file | 
