diff options
| author |  ChrisLovering <[email protected]> | 2024-03-04 14:53:52 +0000 |
|---|---|---|
| committer | ChrisLovering <[email protected]> | 2024-03-04 14:53:52 +0000 |
| commit | 3eb5ff4e3f0a841d28d8c742eba2e562f9fc2231 (patch) | |
| tree | cc57ad52e9e9efb2ab82c0bd8596522ace108556 /v8.0.0-beta.1/output/botcore.utils.scheduling.html | |
| parent | Deploying to docs from @ python-discord/bot-core@69eeda8a1914b671af68871dcf55... (diff) | |
Deploying to docs from @ python-discord/bot-core@c72b515aec03b1d9df49a3d58bfa90a3d864160e 🚀
Diffstat (limited to 'v8.0.0-beta.1/output/botcore.utils.scheduling.html')
| -rw-r--r-- | v8.0.0-beta.1/output/botcore.utils.scheduling.html | 689 |
1 files changed, 0 insertions, 689 deletions
diff --git a/v8.0.0-beta.1/output/botcore.utils.scheduling.html b/v8.0.0-beta.1/output/botcore.utils.scheduling.html deleted file mode 100644 index 2c82634a..00000000 --- a/v8.0.0-beta.1/output/botcore.utils.scheduling.html +++ /dev/null @@ -1,689 +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="async_stats" href="botcore.async_stats.html" /><link rel="prev" title="regex" href="botcore.utils.regex.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>scheduling - Pydis Core v8.0.0-beta.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 v8.0.0-beta.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 v8.0.0-beta.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"><a class="reference internal" href="botcore.utils.caching.html">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.commands.html">commands</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html">interactions</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 current current-page"><a class="current reference internal" href="#">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="../development.html">Local Development & Testing</a></li> -<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.scheduling.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.scheduling.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.scheduling.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.scheduling.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.scheduling.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.scheduling.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.scheduling.html">v8.0.0-beta.2</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.scheduling.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.scheduling.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.utils.scheduling.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.utils.scheduling.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.scheduling.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.scheduling.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.utils.scheduling.html">v7.3.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.2/output/botcore.utils.scheduling.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.utils.scheduling.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.scheduling.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.utils.scheduling.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.utils.scheduling.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.utils.scheduling.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.scheduling"> -<span id="scheduling"></span><h1>scheduling<a class="headerlink" href="#module-botcore.utils.scheduling" title="Link to this heading">#</a></h1> -<p>Generic python scheduler.</p> -<dl class="py class"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L14-L210"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" 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>Schedule the execution of coroutines and keep track of them.</p> -<p>When instantiating a <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>, a name must be provided. This name is used to distinguish the -instance’s log messages from other instances. Using the name of the class or module containing -the instance is suggested.</p> -<p>Coroutines can be scheduled immediately with <a class="reference internal" href="#botcore.utils.scheduling.Scheduler.schedule" title="botcore.utils.scheduling.Scheduler.schedule"><code class="xref py py-obj docutils literal notranslate"><span class="pre">schedule</span></code></a> or in the future with <a class="reference internal" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="botcore.utils.scheduling.Scheduler.schedule_at"><code class="xref py py-obj docutils literal notranslate"><span class="pre">schedule_at</span></code></a> -or <a class="reference internal" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="botcore.utils.scheduling.Scheduler.schedule_later"><code class="xref py py-obj docutils literal notranslate"><span class="pre">schedule_later</span></code></a>. A unique ID is required to be given in order to keep track of the -resulting Tasks. Any scheduled task can be cancelled prematurely using <a class="reference internal" href="#botcore.utils.scheduling.Scheduler.cancel" title="botcore.utils.scheduling.Scheduler.cancel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cancel</span></code></a> by providing -the same ID used to schedule it.</p> -<p>The <code class="docutils literal notranslate"><span class="pre">in</span></code> operator is supported for checking if a task with a given ID is currently scheduled.</p> -<p>Any exception raised in a scheduled task is logged when the task is done.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__contains__"> -<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L44-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__contains__" title="Link to this definition">#</a></dt> -<dd><p>Return <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if a task with the given <code class="docutils literal notranslate"><span class="pre">task_id</span></code> is currently scheduled.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – The task to look for.</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/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> -</dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if the task was found.</p> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__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">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L32-L43"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__init__" title="Link to this definition">#</a></dt> -<dd><p>Initialize a new <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</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>name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>. Used in logging, and namespacing.</p> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel"> -<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L126-L143"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel" title="Link to this definition">#</a></dt> -<dd><p>Unschedule the task identified by <code class="docutils literal notranslate"><span class="pre">task_id</span></code>. Log a warning if the task doesn’t exist.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – The task’s unique ID.</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/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> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel_all"> -<span class="sig-name descname"><span class="pre">cancel_all</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/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L144-L150"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel_all" title="Link to this definition">#</a></dt> -<dd><p>Unschedule all known tasks.</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> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule"> -<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L56-L82"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Link to this definition">#</a></dt> -<dd><p>Schedule the execution of a <code class="docutils literal notranslate"><span class="pre">coroutine</span></code>.</p> -<p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This -prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> -</ul> -</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/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> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_at"> -<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L83-L106"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Link to this definition">#</a></dt> -<dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed at the given <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p> -<p>If <code class="docutils literal notranslate"><span class="pre">time</span></code> is timezone aware, then use that timezone to calculate now() when subtracting. -If <code class="docutils literal notranslate"><span class="pre">time</span></code> is naïve, then use UTC.</p> -<p>If <code class="docutils literal notranslate"><span class="pre">time</span></code> is in the past, schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> immediately.</p> -<p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This -prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>time</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a></span>) – The time to start the task.</p></li> -<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> -</ul> -</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/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> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_later"> -<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L107-L125"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Link to this definition">#</a></dt> -<dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed after <code class="docutils literal notranslate"><span class="pre">delay</span></code> seconds.</p> -<p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This -prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>delay</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<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>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>]</span>) – How long to wait before starting the task.</p></li> -<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> -</ul> -</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/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> - -<dl class="py function"> -<dt class="sig sig-object py" id="botcore.utils.scheduling.create_task"> -<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a474ff8cf37c14f76262308a9258265ae2bf4197/botcore/utils/scheduling.py#L215-L243"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Link to this definition">#</a></dt> -<dd><p>Wrapper for creating an <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.Task</span></code></a> which logs exceptions raised in the task.</p> -<p>If the <code class="docutils literal notranslate"><span class="pre">event_loop</span></code> kwarg is provided, the task is created from that event loop, -otherwise the running loop is used.</p> -<dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><ul class="simple"> -<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">TASK_RETURN</span></code>)]</span>) – The function to call.</p></li> -<li><p><strong>suppressed_exceptions</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a>]]</span>) – Exceptions to be handled by the task.</p></li> -<li><p><strong>event_loop</strong> (<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.AbstractEventLoop</span></code></a>) – The loop to create the task from.</p></li> -<li><p><strong>kwargs</strong> – Passed to <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.create_task" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">asyncio.create_task()</span></code></a>.</p></li> -</ul> -</dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>The wrapped task.</p> -</dd> -<dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.12)">asyncio.Task</a></p> -</dd> -</dl> -</dd></dl> - -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="botcore.async_stats.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">async_stats</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.utils.regex.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">regex</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="#">scheduling</a><ul> -<li><a class="reference internal" href="#botcore.utils.scheduling.Scheduler"><code class="docutils literal notranslate"><span class="pre">Scheduler</span></code></a><ul> -<li><a class="reference internal" href="#botcore.utils.scheduling.Scheduler.__contains__"><code class="docutils literal notranslate"><span class="pre">Scheduler.__contains__()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.scheduling.Scheduler.__init__"><code class="docutils literal notranslate"><span class="pre">Scheduler.__init__()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.scheduling.Scheduler.cancel"><code class="docutils literal notranslate"><span class="pre">Scheduler.cancel()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.scheduling.Scheduler.cancel_all"><code class="docutils literal notranslate"><span class="pre">Scheduler.cancel_all()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.scheduling.Scheduler.schedule"><code class="docutils literal notranslate"><span class="pre">Scheduler.schedule()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.scheduling.Scheduler.schedule_at"><code class="docutils literal notranslate"><span class="pre">Scheduler.schedule_at()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.scheduling.Scheduler.schedule_later"><code class="docutils literal notranslate"><span class="pre">Scheduler.schedule_later()</span></code></a></li> -</ul> -</li> -<li><a class="reference internal" href="#botcore.utils.scheduling.create_task"><code class="docutils literal notranslate"><span class="pre">create_task()</span></code></a></li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=c759c23d"></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 |