diff options
Diffstat (limited to 'v7.2.2')
47 files changed, 0 insertions, 13383 deletions
diff --git a/v7.2.2/.buildinfo b/v7.2.2/.buildinfo deleted file mode 100644 index 25c4c50e..00000000 --- a/v7.2.2/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 615bbdcaf10265fdec7869d9bc2ee516 -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.2/.nojekyll b/v7.2.2/.nojekyll deleted file mode 100644 index e69de29b..00000000 --- a/v7.2.2/.nojekyll +++ /dev/null diff --git a/v7.2.2/_static/basic.css b/v7.2.2/_static/basic.css deleted file mode 100644 index 30fee9d0..00000000 --- a/v7.2.2/_static/basic.css +++ /dev/null @@ -1,925 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li p.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 360px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -a:visited { - color: #551A8B; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, figure.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, figure.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, figure.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, figure.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar, -aside.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px; - background-color: #ffe; - width: 40%; - float: right; - clear: right; - overflow-x: auto; -} - -p.sidebar-title { - font-weight: bold; -} - -nav.contents, -aside.topic, -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -nav.contents, -aside.topic, -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- content of sidebars/topics/admonitions -------------------------------- */ - -div.sidebar > :last-child, -aside.sidebar > :last-child, -nav.contents > :last-child, -aside.topic > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -aside.sidebar::after, -nav.contents::after, -aside.topic::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - margin-top: 10px; - margin-bottom: 10px; - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > :first-child, -td > :first-child { - margin-top: 0px; -} - -th > :last-child, -td > :last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure, figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption, figcaption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number, -figcaption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text, -figcaption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist { - margin: 1em 0; -} - -table.hlist td { - vertical-align: top; -} - -/* -- object description styles --------------------------------------------- */ - -.sig { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; -} - -.sig-name, code.descname { - background-color: transparent; - font-weight: bold; -} - -.sig-name { - font-size: 1.1em; -} - -code.descname { - font-size: 1.2em; -} - -.sig-prename, code.descclassname { - background-color: transparent; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.sig-param.n { - font-style: italic; -} - -/* C++ specific styling */ - -.sig-inline.c-texpr, -.sig-inline.cpp-texpr { - font-family: unset; -} - -.sig.c .k, .sig.c .kt, -.sig.cpp .k, .sig.cpp .kt { - color: #0033B3; -} - -.sig.c .m, -.sig.cpp .m { - color: #1750EB; -} - -.sig.c .s, .sig.c .sc, -.sig.cpp .s, .sig.cpp .sc { - color: #067D17; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -aside.footnote > span, -div.citation > span { - float: left; -} -aside.footnote > span:last-of-type, -div.citation > span:last-of-type { - padding-right: 0.5em; -} -aside.footnote > p { - margin-left: 2em; -} -div.citation > p { - margin-left: 4em; -} -aside.footnote > p:last-of-type, -div.citation > p:last-of-type { - margin-bottom: 0em; -} -aside.footnote > p:last-of-type:after, -div.citation > p:last-of-type:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > :first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -.sig dd { - margin-top: 0px; - margin-bottom: 0px; -} - -.sig dl { - margin-top: 0px; - margin-bottom: 0px; -} - -dl > dd:last-child, -dl > dd:last-child > :last-child { - margin-bottom: 0; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0 0.5em; - content: ":"; - display: inline-block; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -.translated { - background-color: rgba(207, 255, 207, 0.2) -} - -.untranslated { - background-color: rgba(255, 207, 207, 0.2) -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; - white-space: nowrap; -} - -div[class*="highlight-"] { - margin: 1em 0; -} - -td.linenos pre { - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - display: block; -} - -table.highlighttable tbody { - display: block; -} - -table.highlighttable tr { - display: flex; -} - -table.highlighttable td { - margin: 0; - padding: 0; -} - -table.highlighttable td.linenos { - padding-right: 0.5em; -} - -table.highlighttable td.code { - flex: 1; - overflow: hidden; -} - -.highlight .hll { - display: block; -} - -div.highlight pre, -table.highlighttable pre { - margin: 0; -} - -div.code-block-caption + div { - margin-top: 0; -} - -div.code-block-caption { - margin-top: 1em; - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -table.highlighttable td.linenos, -span.linenos, -div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; - -webkit-user-select: text; /* Safari fallback only */ - -webkit-user-select: none; /* Chrome/Safari */ - -moz-user-select: none; /* Firefox */ - -ms-user-select: none; /* IE10+ */ -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - margin: 1em 0; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: absolute; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -}
\ No newline at end of file diff --git a/v7.2.2/_static/changelog.css b/v7.2.2/_static/changelog.css deleted file mode 100644 index 343792a1..00000000 --- a/v7.2.2/_static/changelog.css +++ /dev/null @@ -1,11 +0,0 @@ -[data-theme='dark'] #changelog .dark, -[data-theme='light'] #changelog .light, -[data-theme='auto'] #changelog .light { - display: inline; -} - -[data-theme='dark'] #changelog .light, -[data-theme='light'] #changelog .dark, -[data-theme='auto'] #changelog .dark { - display: none; -} diff --git a/v7.2.2/_static/changelog.js b/v7.2.2/_static/changelog.js deleted file mode 100644 index 94834eaa..00000000 --- a/v7.2.2/_static/changelog.js +++ /dev/null @@ -1,41 +0,0 @@ -/** Update the changelog colors in dark mode */ -function changelog_color_main() { - const changelog = document.getElementById("changelog"); - - function updateEntryColor(span) { - const lightColorSpan = span; - const darkColorSpan = lightColorSpan.cloneNode(true); - - lightColorSpan.parentElement.insertBefore(darkColorSpan, lightColorSpan); - - lightColorSpan.classList.add("light"); - darkColorSpan.classList.add("dark"); - - let color; - switch (darkColorSpan.textContent) { - case "Feature": - color = "#5BF38E"; - break; - case "Support": - color = "#55A5E7"; - break; - case "Bug": - color = "#E14F4F"; - break; - default: - color = lightColorSpan.style.color; - } - - darkColorSpan.style["color"] = color; - } - - const TYPES = ["Feature", "Bug", "Support", "Breaking"]; - - if (changelog !== null) { - Array.from(changelog.getElementsByTagName("span")) - .filter(value => TYPES.includes(value.textContent)) - .forEach(updateEntryColor) - } -} - -changelog_color_main(); diff --git a/v7.2.2/_static/debug.css b/v7.2.2/_static/debug.css deleted file mode 100644 index 74d4aec3..00000000 --- a/v7.2.2/_static/debug.css +++ /dev/null @@ -1,69 +0,0 @@ -/* - This CSS file should be overridden by the theme authors. It's - meant for debugging and developing the skeleton that this theme provides. -*/ -body { - font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, - "Apple Color Emoji", "Segoe UI Emoji"; - background: lavender; -} -.sb-announcement { - background: rgb(131, 131, 131); -} -.sb-announcement__inner { - background: black; - color: white; -} -.sb-header { - background: lightskyblue; -} -.sb-header__inner { - background: royalblue; - color: white; -} -.sb-header-secondary { - background: lightcyan; -} -.sb-header-secondary__inner { - background: cornflowerblue; - color: white; -} -.sb-sidebar-primary { - background: lightgreen; -} -.sb-main { - background: blanchedalmond; -} -.sb-main__inner { - background: antiquewhite; -} -.sb-header-article { - background: lightsteelblue; -} -.sb-article-container { - background: snow; -} -.sb-article-main { - background: white; -} -.sb-footer-article { - background: lightpink; -} -.sb-sidebar-secondary { - background: lightgoldenrodyellow; -} -.sb-footer-content { - background: plum; -} -.sb-footer-content__inner { - background: palevioletred; -} -.sb-footer { - background: pink; -} -.sb-footer__inner { - background: salmon; -} -.sb-article { - background: white; -} diff --git a/v7.2.2/_static/doctools.js b/v7.2.2/_static/doctools.js deleted file mode 100644 index d06a71d7..00000000 --- a/v7.2.2/_static/doctools.js +++ /dev/null @@ -1,156 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ - "TEXTAREA", - "INPUT", - "SELECT", - "BUTTON", -]); - -const _ready = (callback) => { - if (document.readyState !== "loading") { - callback(); - } else { - document.addEventListener("DOMContentLoaded", callback); - } -}; - -/** - * Small JavaScript module for the documentation. - */ -const Documentation = { - init: () => { - Documentation.initDomainIndexTable(); - Documentation.initOnKeyListeners(); - }, - - /** - * i18n support - */ - TRANSLATIONS: {}, - PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), - LOCALE: "unknown", - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext: (string) => { - const translated = Documentation.TRANSLATIONS[string]; - switch (typeof translated) { - case "undefined": - return string; // no translation - case "string": - return translated; // translation exists - default: - return translated[0]; // (singular, plural) translation tuple exists - } - }, - - ngettext: (singular, plural, n) => { - const translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated !== "undefined") - return translated[Documentation.PLURAL_EXPR(n)]; - return n === 1 ? singular : plural; - }, - - addTranslations: (catalog) => { - Object.assign(Documentation.TRANSLATIONS, catalog.messages); - Documentation.PLURAL_EXPR = new Function( - "n", - `return (${catalog.plural_expr})` - ); - Documentation.LOCALE = catalog.locale; - }, - - /** - * helper function to focus on search bar - */ - focusSearchBar: () => { - document.querySelectorAll("input[name=q]")[0]?.focus(); - }, - - /** - * Initialise the domain index toggle buttons - */ - initDomainIndexTable: () => { - const toggler = (el) => { - const idNumber = el.id.substr(7); - const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); - if (el.src.substr(-9) === "minus.png") { - el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; - toggledRows.forEach((el) => (el.style.display = "none")); - } else { - el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; - toggledRows.forEach((el) => (el.style.display = "")); - } - }; - - const togglerElements = document.querySelectorAll("img.toggler"); - togglerElements.forEach((el) => - el.addEventListener("click", (event) => toggler(event.currentTarget)) - ); - togglerElements.forEach((el) => (el.style.display = "")); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); - }, - - initOnKeyListeners: () => { - // only install a listener if it is really needed - if ( - !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && - !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS - ) - return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.altKey || event.ctrlKey || event.metaKey) return; - - if (!event.shiftKey) { - switch (event.key) { - case "ArrowLeft": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const prevLink = document.querySelector('link[rel="prev"]'); - if (prevLink && prevLink.href) { - window.location.href = prevLink.href; - event.preventDefault(); - } - break; - case "ArrowRight": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const nextLink = document.querySelector('link[rel="next"]'); - if (nextLink && nextLink.href) { - window.location.href = nextLink.href; - event.preventDefault(); - } - break; - } - } - - // some keyboard layouts may need Shift to get / - switch (event.key) { - case "/": - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; - Documentation.focusSearchBar(); - event.preventDefault(); - } - }); - }, -}; - -// quick alias for translations -const _ = Documentation.gettext; - -_ready(Documentation.init); diff --git a/v7.2.2/_static/documentation_options.js b/v7.2.2/_static/documentation_options.js deleted file mode 100644 index 755cfb8b..00000000 --- a/v7.2.2/_static/documentation_options.js +++ /dev/null @@ -1,13 +0,0 @@ -const DOCUMENTATION_OPTIONS = { - VERSION: '7.2.2', - LANGUAGE: 'en', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false, - SHOW_SEARCH_SUMMARY: true, - ENABLE_SEARCH_SHORTCUTS: true, -};
\ No newline at end of file diff --git a/v7.2.2/_static/file.png b/v7.2.2/_static/file.png Binary files differdeleted file mode 100644 index a858a410..00000000 --- a/v7.2.2/_static/file.png +++ /dev/null diff --git a/v7.2.2/_static/index.css b/v7.2.2/_static/index.css deleted file mode 100644 index 54f3f771..00000000 --- a/v7.2.2/_static/index.css +++ /dev/null @@ -1,3 +0,0 @@ -h1 { - font-weight: 300; -} diff --git a/v7.2.2/_static/language_data.js b/v7.2.2/_static/language_data.js deleted file mode 100644 index 250f5665..00000000 --- a/v7.2.2/_static/language_data.js +++ /dev/null @@ -1,199 +0,0 @@ -/* - * language_data.js - * ~~~~~~~~~~~~~~~~ - * - * This script contains the language-specific data used by searchtools.js, - * namely the list of stopwords, stemmer, scorer and splitter. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; - - -/* Non-minified version is copied as a separate JS file, is available */ - -/** - * Porter Stemmer - */ -var Stemmer = function() { - - var step2list = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log' - }; - - var step3list = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '' - }; - - var c = "[^aeiou]"; // consonant - var v = "[aeiouy]"; // vowel - var C = c + "[^aeiouy]*"; // consonant sequence - var V = v + "[aeiou]*"; // vowel sequence - - var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - diff --git a/v7.2.2/_static/logo.css b/v7.2.2/_static/logo.css deleted file mode 100644 index a9c28e5c..00000000 --- a/v7.2.2/_static/logo.css +++ /dev/null @@ -1,3 +0,0 @@ -.sidebar-logo { - border-radius: 50%; -} diff --git a/v7.2.2/_static/minus.png b/v7.2.2/_static/minus.png Binary files differdeleted file mode 100644 index d96755fd..00000000 --- a/v7.2.2/_static/minus.png +++ /dev/null diff --git a/v7.2.2/_static/plus.png b/v7.2.2/_static/plus.png Binary files differdeleted file mode 100644 index 7107cec9..00000000 --- a/v7.2.2/_static/plus.png +++ /dev/null diff --git a/v7.2.2/_static/pygments.css b/v7.2.2/_static/pygments.css deleted file mode 100644 index c2e07c71..00000000 --- a/v7.2.2/_static/pygments.css +++ /dev/null @@ -1,258 +0,0 @@ -.highlight pre { line-height: 125%; } -.highlight td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -.highlight span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -.highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight .hll { background-color: #ffffcc } -.highlight { background: #f8f8f8; } -.highlight .c { color: #8f5902; font-style: italic } /* Comment */ -.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ -.highlight .g { color: #000000 } /* Generic */ -.highlight .k { color: #204a87; font-weight: bold } /* Keyword */ -.highlight .l { color: #000000 } /* Literal */ -.highlight .n { color: #000000 } /* Name */ -.highlight .o { color: #ce5c00; font-weight: bold } /* Operator */ -.highlight .x { color: #000000 } /* Other */ -.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ -.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */ -.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #a40000 } /* Generic.Deleted */ -.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ -.highlight .ges { color: #000000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -.highlight .gr { color: #ef2929 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #000000; font-style: italic } /* Generic.Output */ -.highlight .gp { color: #8f5902 } /* Generic.Prompt */ -.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ -.highlight .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */ -.highlight .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #204a87; font-weight: bold } /* Keyword.Type */ -.highlight .ld { color: #000000 } /* Literal.Date */ -.highlight .m { color: #0000cf; font-weight: bold } /* Literal.Number */ -.highlight .s { color: #4e9a06 } /* Literal.String */ -.highlight .na { color: #c4a000 } /* Name.Attribute */ -.highlight .nb { color: #204a87 } /* Name.Builtin */ -.highlight .nc { color: #000000 } /* Name.Class */ -.highlight .no { color: #000000 } /* Name.Constant */ -.highlight .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */ -.highlight .ni { color: #ce5c00 } /* Name.Entity */ -.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #000000 } /* Name.Function */ -.highlight .nl { color: #f57900 } /* Name.Label */ -.highlight .nn { color: #000000 } /* Name.Namespace */ -.highlight .nx { color: #000000 } /* Name.Other */ -.highlight .py { color: #000000 } /* Name.Property */ -.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #000000 } /* Name.Variable */ -.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ -.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ -.highlight .w { color: #f8f8f8 } /* Text.Whitespace */ -.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ -.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ -.highlight .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */ -.highlight .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */ -.highlight .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */ -.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ -.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ -.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ -.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ -.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ -.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ -.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ -.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ -.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ -.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ -.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ -.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ -.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #000000 } /* Name.Function.Magic */ -.highlight .vc { color: #000000 } /* Name.Variable.Class */ -.highlight .vg { color: #000000 } /* Name.Variable.Global */ -.highlight .vi { color: #000000 } /* Name.Variable.Instance */ -.highlight .vm { color: #000000 } /* Name.Variable.Magic */ -.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */ -@media not print { -body[data-theme="dark"] .highlight pre { line-height: 125%; } -body[data-theme="dark"] .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body[data-theme="dark"] .highlight .hll { background-color: #404040 } -body[data-theme="dark"] .highlight { background: #202020; color: #d0d0d0 } -body[data-theme="dark"] .highlight .c { color: #ababab; font-style: italic } /* Comment */ -body[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -body[data-theme="dark"] .highlight .esc { color: #d0d0d0 } /* Escape */ -body[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */ -body[data-theme="dark"] .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ -body[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */ -body[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */ -body[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */ -body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */ -body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */ -body[data-theme="dark"] .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ -body[data-theme="dark"] .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ -body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ -body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ -body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ -body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ -body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ -body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ -body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ -body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ -body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ -body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ -body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ -body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ -body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ -body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ -body[data-theme="dark"] .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ -body[data-theme="dark"] .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ -body[data-theme="dark"] .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ -body[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */ -body[data-theme="dark"] .highlight .m { color: #51b2fd } /* Literal.Number */ -body[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */ -body[data-theme="dark"] .highlight .na { color: #bbbbbb } /* Name.Attribute */ -body[data-theme="dark"] .highlight .nb { color: #2fbccd } /* Name.Builtin */ -body[data-theme="dark"] .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ -body[data-theme="dark"] .highlight .no { color: #40ffff } /* Name.Constant */ -body[data-theme="dark"] .highlight .nd { color: #ffa500 } /* Name.Decorator */ -body[data-theme="dark"] .highlight .ni { color: #d0d0d0 } /* Name.Entity */ -body[data-theme="dark"] .highlight .ne { color: #bbbbbb } /* Name.Exception */ -body[data-theme="dark"] .highlight .nf { color: #71adff } /* Name.Function */ -body[data-theme="dark"] .highlight .nl { color: #d0d0d0 } /* Name.Label */ -body[data-theme="dark"] .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ -body[data-theme="dark"] .highlight .nx { color: #d0d0d0 } /* Name.Other */ -body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ -body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ -body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ -body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ -body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ -body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ -body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ -body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ -body[data-theme="dark"] .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ -body[data-theme="dark"] .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ -body[data-theme="dark"] .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ -body[data-theme="dark"] .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ -body[data-theme="dark"] .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ -body[data-theme="dark"] .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ -body[data-theme="dark"] .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ -body[data-theme="dark"] .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ -body[data-theme="dark"] .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ -body[data-theme="dark"] .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ -body[data-theme="dark"] .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ -body[data-theme="dark"] .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ -body[data-theme="dark"] .highlight .sx { color: #ffa500 } /* Literal.String.Other */ -body[data-theme="dark"] .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ -body[data-theme="dark"] .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ -body[data-theme="dark"] .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ -body[data-theme="dark"] .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ -body[data-theme="dark"] .highlight .fm { color: #71adff } /* Name.Function.Magic */ -body[data-theme="dark"] .highlight .vc { color: #40ffff } /* Name.Variable.Class */ -body[data-theme="dark"] .highlight .vg { color: #40ffff } /* Name.Variable.Global */ -body[data-theme="dark"] .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ -body[data-theme="dark"] .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ -body[data-theme="dark"] .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ -@media (prefers-color-scheme: dark) { -body:not([data-theme="light"]) .highlight pre { line-height: 125%; } -body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -body:not([data-theme="light"]) .highlight .hll { background-color: #404040 } -body:not([data-theme="light"]) .highlight { background: #202020; color: #d0d0d0 } -body:not([data-theme="light"]) .highlight .c { color: #ababab; font-style: italic } /* Comment */ -body:not([data-theme="light"]) .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -body:not([data-theme="light"]) .highlight .esc { color: #d0d0d0 } /* Escape */ -body:not([data-theme="light"]) .highlight .g { color: #d0d0d0 } /* Generic */ -body:not([data-theme="light"]) .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ -body:not([data-theme="light"]) .highlight .l { color: #d0d0d0 } /* Literal */ -body:not([data-theme="light"]) .highlight .n { color: #d0d0d0 } /* Name */ -body:not([data-theme="light"]) .highlight .o { color: #d0d0d0 } /* Operator */ -body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */ -body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */ -body:not([data-theme="light"]) .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ -body:not([data-theme="light"]) .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ -body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ -body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ -body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ -body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ -body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ -body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ -body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ -body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ -body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ -body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ -body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ -body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ -body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ -body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ -body:not([data-theme="light"]) .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ -body:not([data-theme="light"]) .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ -body:not([data-theme="light"]) .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ -body:not([data-theme="light"]) .highlight .ld { color: #d0d0d0 } /* Literal.Date */ -body:not([data-theme="light"]) .highlight .m { color: #51b2fd } /* Literal.Number */ -body:not([data-theme="light"]) .highlight .s { color: #ed9d13 } /* Literal.String */ -body:not([data-theme="light"]) .highlight .na { color: #bbbbbb } /* Name.Attribute */ -body:not([data-theme="light"]) .highlight .nb { color: #2fbccd } /* Name.Builtin */ -body:not([data-theme="light"]) .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ -body:not([data-theme="light"]) .highlight .no { color: #40ffff } /* Name.Constant */ -body:not([data-theme="light"]) .highlight .nd { color: #ffa500 } /* Name.Decorator */ -body:not([data-theme="light"]) .highlight .ni { color: #d0d0d0 } /* Name.Entity */ -body:not([data-theme="light"]) .highlight .ne { color: #bbbbbb } /* Name.Exception */ -body:not([data-theme="light"]) .highlight .nf { color: #71adff } /* Name.Function */ -body:not([data-theme="light"]) .highlight .nl { color: #d0d0d0 } /* Name.Label */ -body:not([data-theme="light"]) .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ -body:not([data-theme="light"]) .highlight .nx { color: #d0d0d0 } /* Name.Other */ -body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Property */ -body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ -body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ -body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ -body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ -body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ -body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ -body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ -body:not([data-theme="light"]) .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ -body:not([data-theme="light"]) .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ -body:not([data-theme="light"]) .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ -body:not([data-theme="light"]) .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ -body:not([data-theme="light"]) .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ -body:not([data-theme="light"]) .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ -body:not([data-theme="light"]) .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ -body:not([data-theme="light"]) .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ -body:not([data-theme="light"]) .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ -body:not([data-theme="light"]) .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ -body:not([data-theme="light"]) .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ -body:not([data-theme="light"]) .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ -body:not([data-theme="light"]) .highlight .sx { color: #ffa500 } /* Literal.String.Other */ -body:not([data-theme="light"]) .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ -body:not([data-theme="light"]) .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ -body:not([data-theme="light"]) .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ -body:not([data-theme="light"]) .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ -body:not([data-theme="light"]) .highlight .fm { color: #71adff } /* Name.Function.Magic */ -body:not([data-theme="light"]) .highlight .vc { color: #40ffff } /* Name.Variable.Class */ -body:not([data-theme="light"]) .highlight .vg { color: #40ffff } /* Name.Variable.Global */ -body:not([data-theme="light"]) .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ -body:not([data-theme="light"]) .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ -body:not([data-theme="light"]) .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ -} -}
\ No newline at end of file diff --git a/v7.2.2/_static/scripts/furo-extensions.js b/v7.2.2/_static/scripts/furo-extensions.js deleted file mode 100644 index e69de29b..00000000 --- a/v7.2.2/_static/scripts/furo-extensions.js +++ /dev/null diff --git a/v7.2.2/_static/scripts/furo.js b/v7.2.2/_static/scripts/furo.js deleted file mode 100644 index 32e7c05b..00000000 --- a/v7.2.2/_static/scripts/furo.js +++ /dev/null @@ -1,3 +0,0 @@ -/*! For license information please see furo.js.LICENSE.txt */ -(()=>{var t={212:function(t,e,n){var o,r;r=void 0!==n.g?n.g:"undefined"!=typeof window?window:this,o=function(){return function(t){"use strict";var e={navClass:"active",contentClass:"active",nested:!1,nestedClass:"active",offset:0,reflow:!1,events:!0},n=function(t,e,n){if(n.settings.events){var o=new CustomEvent(t,{bubbles:!0,cancelable:!0,detail:n});e.dispatchEvent(o)}},o=function(t){var e=0;if(t.offsetParent)for(;t;)e+=t.offsetTop,t=t.offsetParent;return e>=0?e:0},r=function(t){t&&t.sort((function(t,e){return o(t.content)<o(e.content)?-1:1}))},c=function(e,n,o){var r=e.getBoundingClientRect(),c=function(t){return"function"==typeof t.offset?parseFloat(t.offset()):parseFloat(t.offset)}(n);return o?parseInt(r.bottom,10)<(t.innerHeight||document.documentElement.clientHeight):parseInt(r.top,10)<=c},s=function(){return Math.ceil(t.innerHeight+t.pageYOffset)>=Math.max(document.body.scrollHeight,document.documentElement.scrollHeight,document.body.offsetHeight,document.documentElement.offsetHeight,document.body.clientHeight,document.documentElement.clientHeight)},l=function(t,e){var n=t[t.length-1];if(function(t,e){return!(!s()||!c(t.content,e,!0))}(n,e))return n;for(var o=t.length-1;o>=0;o--)if(c(t[o].content,e))return t[o]},a=function(t,e){if(e.nested&&t.parentNode){var n=t.parentNode.closest("li");n&&(n.classList.remove(e.nestedClass),a(n,e))}},i=function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.remove(e.navClass),t.content.classList.remove(e.contentClass),a(o,e),n("gumshoeDeactivate",o,{link:t.nav,content:t.content,settings:e}))}},u=function(t,e){if(e.nested){var n=t.parentNode.closest("li");n&&(n.classList.add(e.nestedClass),u(n,e))}};return function(o,c){var s,a,d,f,m,v={setup:function(){s=document.querySelectorAll(o),a=[],Array.prototype.forEach.call(s,(function(t){var e=document.getElementById(decodeURIComponent(t.hash.substr(1)));e&&a.push({nav:t,content:e})})),r(a)},detect:function(){var t=l(a,m);t?d&&t.content===d.content||(i(d,m),function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.add(e.navClass),t.content.classList.add(e.contentClass),u(o,e),n("gumshoeActivate",o,{link:t.nav,content:t.content,settings:e}))}}(t,m),d=t):d&&(i(d,m),d=null)}},h=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame(v.detect)},g=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame((function(){r(a),v.detect()}))};return v.destroy=function(){d&&i(d,m),t.removeEventListener("scroll",h,!1),m.reflow&&t.removeEventListener("resize",g,!1),a=null,s=null,d=null,f=null,m=null},m=function(){var t={};return Array.prototype.forEach.call(arguments,(function(e){for(var n in e){if(!e.hasOwnProperty(n))return;t[n]=e[n]}})),t}(e,c||{}),v.setup(),v.detect(),t.addEventListener("scroll",h,!1),m.reflow&&t.addEventListener("resize",g,!1),v}}(r)}.apply(e,[]),void 0===o||(t.exports=o)}},e={};function n(o){var r=e[o];if(void 0!==r)return r.exports;var c=e[o]={exports:{}};return t[o].call(c.exports,c,c.exports,n),c.exports}n.n=t=>{var e=t&&t.__esModule?()=>t.default:()=>t;return n.d(e,{a:e}),e},n.d=(t,e)=>{for(var o in e)n.o(e,o)&&!n.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}(),n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),(()=>{"use strict";var t=n(212),e=n.n(t),o=null,r=null,c=window.pageYOffset||document.documentElement.scrollTop;const s=64;function l(){const t=localStorage.getItem("theme")||"auto";var e;"light"!==(e=window.matchMedia("(prefers-color-scheme: dark)").matches?"auto"===t?"light":"light"==t?"dark":"auto":"auto"===t?"dark":"dark"==t?"light":"auto")&&"dark"!==e&&"auto"!==e&&(console.error(`Got invalid theme mode: ${e}. Resetting to auto.`),e="auto"),document.body.dataset.theme=e,localStorage.setItem("theme",e),console.log(`Changed to ${e} mode.`)}function a(){!function(){const t=document.getElementsByClassName("theme-toggle");Array.from(t).forEach((t=>{t.addEventListener("click",l)}))}(),function(){let t=0,e=!1;window.addEventListener("scroll",(function(n){t=window.scrollY,e||(window.requestAnimationFrame((function(){var n;n=t,0==Math.floor(r.getBoundingClientRect().top)?r.classList.add("scrolled"):r.classList.remove("scrolled"),function(t){t<s?document.documentElement.classList.remove("show-back-to-top"):t<c?document.documentElement.classList.add("show-back-to-top"):t>c&&document.documentElement.classList.remove("show-back-to-top"),c=t}(n),function(t){null!==o&&(0==t?o.scrollTo(0,0):Math.ceil(t)>=Math.floor(document.documentElement.scrollHeight-window.innerHeight)?o.scrollTo(0,o.scrollHeight):document.querySelector(".scroll-current"))}(n),e=!1})),e=!0)})),window.scroll()}(),null!==o&&new(e())(".toc-tree a",{reflow:!0,recursive:!0,navClass:"scroll-current",offset:()=>{let t=parseFloat(getComputedStyle(document.documentElement).fontSize);return r.getBoundingClientRect().height+.5*t+1}})}document.addEventListener("DOMContentLoaded",(function(){document.body.parentNode.classList.remove("no-js"),r=document.querySelector("header"),o=document.querySelector(".toc-scroll"),a()}))})()})(); -//# sourceMappingURL=furo.js.map
\ No newline at end of file diff --git a/v7.2.2/_static/scripts/furo.js.LICENSE.txt b/v7.2.2/_static/scripts/furo.js.LICENSE.txt deleted file mode 100644 index 1632189c..00000000 --- a/v7.2.2/_static/scripts/furo.js.LICENSE.txt +++ /dev/null @@ -1,7 +0,0 @@ -/*! - * gumshoejs v5.1.2 (patched by @pradyunsg) - * A simple, framework-agnostic scrollspy script. - * (c) 2019 Chris Ferdinandi - * MIT License - * http://github.com/cferdinandi/gumshoe - */ diff --git a/v7.2.2/_static/scripts/furo.js.map b/v7.2.2/_static/scripts/furo.js.map deleted file mode 100644 index 47053022..00000000 --- a/v7.2.2/_static/scripts/furo.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"scripts/furo.js","mappings":";iCAAA,MAQWA,SAWS,IAAX,EAAAC,EACH,EAAAA,EACkB,oBAAXC,OACLA,OACAC,KAbO,EAAF,WACP,OAaJ,SAAUD,GACR,aAMA,IAAIE,EAAW,CAEbC,SAAU,SACVC,aAAc,SAGdC,QAAQ,EACRC,YAAa,SAGbC,OAAQ,EACRC,QAAQ,EAGRC,QAAQ,GA6BNC,EAAY,SAAUC,EAAMC,EAAMC,GAEpC,GAAKA,EAAOC,SAASL,OAArB,CAGA,IAAIM,EAAQ,IAAIC,YAAYL,EAAM,CAChCM,SAAS,EACTC,YAAY,EACZL,OAAQA,IAIVD,EAAKO,cAAcJ,EAVgB,CAWrC,EAOIK,EAAe,SAAUR,GAC3B,IAAIS,EAAW,EACf,GAAIT,EAAKU,aACP,KAAOV,GACLS,GAAYT,EAAKW,UACjBX,EAAOA,EAAKU,aAGhB,OAAOD,GAAY,EAAIA,EAAW,CACpC,EAMIG,EAAe,SAAUC,GACvBA,GACFA,EAASC,MAAK,SAAUC,EAAOC,GAG7B,OAFcR,EAAaO,EAAME,SACnBT,EAAaQ,EAAMC,UACF,EACxB,CACT,GAEJ,EAwCIC,EAAW,SAAUlB,EAAME,EAAUiB,GACvC,IAAIC,EAASpB,EAAKqB,wBACd1B,EAnCU,SAAUO,GAExB,MAA+B,mBAApBA,EAASP,OACX2B,WAAWpB,EAASP,UAItB2B,WAAWpB,EAASP,OAC7B,CA2Be4B,CAAUrB,GACvB,OAAIiB,EAEAK,SAASJ,EAAOD,OAAQ,KACvB/B,EAAOqC,aAAeC,SAASC,gBAAgBC,cAG7CJ,SAASJ,EAAOS,IAAK,KAAOlC,CACrC,EAMImC,EAAa,WACf,OACEC,KAAKC,KAAK5C,EAAOqC,YAAcrC,EAAO6C,cAnCjCF,KAAKG,IACVR,SAASS,KAAKC,aACdV,SAASC,gBAAgBS,aACzBV,SAASS,KAAKE,aACdX,SAASC,gBAAgBU,aACzBX,SAASS,KAAKP,aACdF,SAASC,gBAAgBC,aAkC7B,EAmBIU,EAAY,SAAUzB,EAAUX,GAClC,IAAIqC,EAAO1B,EAASA,EAAS2B,OAAS,GACtC,GAbgB,SAAUC,EAAMvC,GAChC,SAAI4B,MAAgBZ,EAASuB,EAAKxB,QAASf,GAAU,GAEvD,CAUMwC,CAAYH,EAAMrC,GAAW,OAAOqC,EACxC,IAAK,IAAII,EAAI9B,EAAS2B,OAAS,EAAGG,GAAK,EAAGA,IACxC,GAAIzB,EAASL,EAAS8B,GAAG1B,QAASf,GAAW,OAAOW,EAAS8B,EAEjE,EAOIC,EAAmB,SAAUC,EAAK3C,GAEpC,GAAKA,EAAST,QAAWoD,EAAIC,WAA7B,CAGA,IAAIC,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASR,aAG7BkD,EAAiBG,EAAI7C,GAV0B,CAWjD,EAOIiD,EAAa,SAAUC,EAAOlD,GAEhC,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASX,UAC7B6D,EAAMnC,QAAQgC,UAAUC,OAAOhD,EAASV,cAGxCoD,EAAiBG,EAAI7C,GAGrBJ,EAAU,oBAAqBiD,EAAI,CACjCM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,EAOIoD,EAAiB,SAAUT,EAAK3C,GAElC,GAAKA,EAAST,OAAd,CAGA,IAAIsD,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASR,aAG1B4D,EAAeP,EAAI7C,GAVS,CAW9B,EA6LA,OA1JkB,SAAUsD,EAAUC,GAKpC,IACIC,EAAU7C,EAAU8C,EAASC,EAAS1D,EADtC2D,EAAa,CAUjBA,MAAmB,WAEjBH,EAAWhC,SAASoC,iBAAiBN,GAGrC3C,EAAW,GAGXkD,MAAMC,UAAUC,QAAQC,KAAKR,GAAU,SAAUjB,GAE/C,IAAIxB,EAAUS,SAASyC,eACrBC,mBAAmB3B,EAAK4B,KAAKC,OAAO,KAEjCrD,GAGLJ,EAAS0D,KAAK,CACZ1B,IAAKJ,EACLxB,QAASA,GAEb,IAGAL,EAAaC,EACf,EAKAgD,OAAoB,WAElB,IAAIW,EAASlC,EAAUzB,EAAUX,GAG5BsE,EASDb,GAAWa,EAAOvD,UAAY0C,EAAQ1C,UAG1CkC,EAAWQ,EAASzD,GAzFT,SAAUkD,EAAOlD,GAE9B,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASX,UAC1B6D,EAAMnC,QAAQgC,UAAUM,IAAIrD,EAASV,cAGrC8D,EAAeP,EAAI7C,GAGnBJ,EAAU,kBAAmBiD,EAAI,CAC/BM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,CAqEIuE,CAASD,EAAQtE,GAGjByD,EAAUa,GAfJb,IACFR,EAAWQ,EAASzD,GACpByD,EAAU,KAchB,GAMIe,EAAgB,SAAUvE,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,sBAAsBf,EAAWgB,OACpD,EAMIC,EAAgB,SAAU3E,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,uBAAsB,WACrChE,EAAaC,GACbgD,EAAWgB,QACb,GACF,EAkDA,OA7CAhB,EAAWkB,QAAU,WAEfpB,GACFR,EAAWQ,EAASzD,GAItBd,EAAO4F,oBAAoB,SAAUN,GAAe,GAChDxE,EAASN,QACXR,EAAO4F,oBAAoB,SAAUF,GAAe,GAItDjE,EAAW,KACX6C,EAAW,KACXC,EAAU,KACVC,EAAU,KACV1D,EAAW,IACb,EAOEA,EA3XS,WACX,IAAI+E,EAAS,CAAC,EAOd,OANAlB,MAAMC,UAAUC,QAAQC,KAAKgB,WAAW,SAAUC,GAChD,IAAK,IAAIC,KAAOD,EAAK,CACnB,IAAKA,EAAIE,eAAeD,GAAM,OAC9BH,EAAOG,GAAOD,EAAIC,EACpB,CACF,IACOH,CACT,CAkXeK,CAAOhG,EAAUmE,GAAW,CAAC,GAGxCI,EAAW0B,QAGX1B,EAAWgB,SAGXzF,EAAOoG,iBAAiB,SAAUd,GAAe,GAC7CxE,EAASN,QACXR,EAAOoG,iBAAiB,SAAUV,GAAe,GAS9CjB,CACT,CAOF,CArcW4B,CAAQvG,EAChB,UAFM,SAEN,uBCXDwG,EAA2B,CAAC,EAGhC,SAASC,EAAoBC,GAE5B,IAAIC,EAAeH,EAAyBE,GAC5C,QAAqBE,IAAjBD,EACH,OAAOA,EAAaE,QAGrB,IAAIC,EAASN,EAAyBE,GAAY,CAGjDG,QAAS,CAAC,GAOX,OAHAE,EAAoBL,GAAU1B,KAAK8B,EAAOD,QAASC,EAAQA,EAAOD,QAASJ,GAGpEK,EAAOD,OACf,CCrBAJ,EAAoBO,EAAKF,IACxB,IAAIG,EAASH,GAAUA,EAAOI,WAC7B,IAAOJ,EAAiB,QACxB,IAAM,EAEP,OADAL,EAAoBU,EAAEF,EAAQ,CAAEG,EAAGH,IAC5BA,CAAM,ECLdR,EAAoBU,EAAI,CAACN,EAASQ,KACjC,IAAI,IAAInB,KAAOmB,EACXZ,EAAoBa,EAAED,EAAYnB,KAASO,EAAoBa,EAAET,EAASX,IAC5EqB,OAAOC,eAAeX,EAASX,EAAK,CAAEuB,YAAY,EAAMC,IAAKL,EAAWnB,IAE1E,ECNDO,EAAoBxG,EAAI,WACvB,GAA0B,iBAAf0H,WAAyB,OAAOA,WAC3C,IACC,OAAOxH,MAAQ,IAAIyH,SAAS,cAAb,EAChB,CAAE,MAAOC,GACR,GAAsB,iBAAX3H,OAAqB,OAAOA,MACxC,CACA,CAPuB,GCAxBuG,EAAoBa,EAAI,CAACrB,EAAK6B,IAAUP,OAAOzC,UAAUqB,eAAenB,KAAKiB,EAAK6B,4CCK9EC,EAAY,KACZC,EAAS,KACTC,EAAgB/H,OAAO6C,aAAeP,SAASC,gBAAgByF,UACnE,MAAMC,EAAmB,GA2EzB,SAASC,IACP,MAAMC,EAAeC,aAAaC,QAAQ,UAAY,OAZxD,IAAkBC,EACH,WADGA,EAaItI,OAAOuI,WAAW,gCAAgCC,QAI/C,SAAjBL,EACO,QACgB,SAAhBA,EACA,OAEA,OAIU,SAAjBA,EACO,OACgB,QAAhBA,EACA,QAEA,SA9BoB,SAATG,GAA4B,SAATA,IACzCG,QAAQC,MAAM,2BAA2BJ,yBACzCA,EAAO,QAGThG,SAASS,KAAK4F,QAAQC,MAAQN,EAC9BF,aAAaS,QAAQ,QAASP,GAC9BG,QAAQK,IAAI,cAAcR,UA0B5B,CAkDA,SAASnC,KART,WAEE,MAAM4C,EAAUzG,SAAS0G,uBAAuB,gBAChDrE,MAAMsE,KAAKF,GAASlE,SAASqE,IAC3BA,EAAI9C,iBAAiB,QAAS8B,EAAe,GAEjD,CAGEiB,GA9CF,WAEE,IAAIC,EAA6B,EAC7BC,GAAU,EAEdrJ,OAAOoG,iBAAiB,UAAU,SAAUuB,GAC1CyB,EAA6BpJ,OAAOsJ,QAE/BD,IACHrJ,OAAOwF,uBAAsB,WAzDnC,IAAuB+D,IA0DDH,EA9GkC,GAAlDzG,KAAK6G,MAAM1B,EAAO7F,wBAAwBQ,KAC5CqF,EAAOjE,UAAUM,IAAI,YAErB2D,EAAOjE,UAAUC,OAAO,YAI5B,SAAmCyF,GAC7BA,EAAYtB,EACd3F,SAASC,gBAAgBsB,UAAUC,OAAO,oBAEtCyF,EAAYxB,EACdzF,SAASC,gBAAgBsB,UAAUM,IAAI,oBAC9BoF,EAAYxB,GACrBzF,SAASC,gBAAgBsB,UAAUC,OAAO,oBAG9CiE,EAAgBwB,CAClB,CAoCEE,CAA0BF,GAlC5B,SAA6BA,GACT,OAAd1B,IAKa,GAAb0B,EACF1B,EAAU6B,SAAS,EAAG,GAGtB/G,KAAKC,KAAK2G,IACV5G,KAAK6G,MAAMlH,SAASC,gBAAgBS,aAAehD,OAAOqC,aAE1DwF,EAAU6B,SAAS,EAAG7B,EAAU7E,cAGhBV,SAASqH,cAAc,mBAc3C,CAKEC,CAAoBL,GAwDdF,GAAU,CACZ,IAEAA,GAAU,EAEd,IACArJ,OAAO6J,QACT,CA6BEC,GA1BkB,OAAdjC,GAKJ,IAAI,IAAJ,CAAY,cAAe,CACzBrH,QAAQ,EACRuJ,WAAW,EACX5J,SAAU,iBACVI,OAAQ,KACN,IAAIyJ,EAAM9H,WAAW+H,iBAAiB3H,SAASC,iBAAiB2H,UAChE,OAAOpC,EAAO7F,wBAAwBkI,OAAS,GAAMH,EAAM,CAAC,GAiBlE,CAcA1H,SAAS8D,iBAAiB,oBAT1B,WACE9D,SAASS,KAAKW,WAAWG,UAAUC,OAAO,SAE1CgE,EAASxF,SAASqH,cAAc,UAChC9B,EAAYvF,SAASqH,cAAc,eAEnCxD,GACF","sources":["webpack:///./src/furo/assets/scripts/gumshoe-patched.js","webpack:///webpack/bootstrap","webpack:///webpack/runtime/compat get default export","webpack:///webpack/runtime/define property getters","webpack:///webpack/runtime/global","webpack:///webpack/runtime/hasOwnProperty shorthand","webpack:///./src/furo/assets/scripts/furo.js"],"sourcesContent":["/*!\n * gumshoejs v5.1.2 (patched by @pradyunsg)\n * A simple, framework-agnostic scrollspy script.\n * (c) 2019 Chris Ferdinandi\n * MIT License\n * http://github.com/cferdinandi/gumshoe\n */\n\n(function (root, factory) {\n if (typeof define === \"function\" && define.amd) {\n define([], function () {\n return factory(root);\n });\n } else if (typeof exports === \"object\") {\n module.exports = factory(root);\n } else {\n root.Gumshoe = factory(root);\n }\n})(\n typeof global !== \"undefined\"\n ? global\n : typeof window !== \"undefined\"\n ? window\n : this,\n function (window) {\n \"use strict\";\n\n //\n // Defaults\n //\n\n var defaults = {\n // Active classes\n navClass: \"active\",\n contentClass: \"active\",\n\n // Nested navigation\n nested: false,\n nestedClass: \"active\",\n\n // Offset & reflow\n offset: 0,\n reflow: false,\n\n // Event support\n events: true,\n };\n\n //\n // Methods\n //\n\n /**\n * Merge two or more objects together.\n * @param {Object} objects The objects to merge together\n * @returns {Object} Merged values of defaults and options\n */\n var extend = function () {\n var merged = {};\n Array.prototype.forEach.call(arguments, function (obj) {\n for (var key in obj) {\n if (!obj.hasOwnProperty(key)) return;\n merged[key] = obj[key];\n }\n });\n return merged;\n };\n\n /**\n * Emit a custom event\n * @param {String} type The event type\n * @param {Node} elem The element to attach the event to\n * @param {Object} detail Any details to pass along with the event\n */\n var emitEvent = function (type, elem, detail) {\n // Make sure events are enabled\n if (!detail.settings.events) return;\n\n // Create a new event\n var event = new CustomEvent(type, {\n bubbles: true,\n cancelable: true,\n detail: detail,\n });\n\n // Dispatch the event\n elem.dispatchEvent(event);\n };\n\n /**\n * Get an element's distance from the top of the Document.\n * @param {Node} elem The element\n * @return {Number} Distance from the top in pixels\n */\n var getOffsetTop = function (elem) {\n var location = 0;\n if (elem.offsetParent) {\n while (elem) {\n location += elem.offsetTop;\n elem = elem.offsetParent;\n }\n }\n return location >= 0 ? location : 0;\n };\n\n /**\n * Sort content from first to last in the DOM\n * @param {Array} contents The content areas\n */\n var sortContents = function (contents) {\n if (contents) {\n contents.sort(function (item1, item2) {\n var offset1 = getOffsetTop(item1.content);\n var offset2 = getOffsetTop(item2.content);\n if (offset1 < offset2) return -1;\n return 1;\n });\n }\n };\n\n /**\n * Get the offset to use for calculating position\n * @param {Object} settings The settings for this instantiation\n * @return {Float} The number of pixels to offset the calculations\n */\n var getOffset = function (settings) {\n // if the offset is a function run it\n if (typeof settings.offset === \"function\") {\n return parseFloat(settings.offset());\n }\n\n // Otherwise, return it as-is\n return parseFloat(settings.offset);\n };\n\n /**\n * Get the document element's height\n * @private\n * @returns {Number}\n */\n var getDocumentHeight = function () {\n return Math.max(\n document.body.scrollHeight,\n document.documentElement.scrollHeight,\n document.body.offsetHeight,\n document.documentElement.offsetHeight,\n document.body.clientHeight,\n document.documentElement.clientHeight,\n );\n };\n\n /**\n * Determine if an element is in view\n * @param {Node} elem The element\n * @param {Object} settings The settings for this instantiation\n * @param {Boolean} bottom If true, check if element is above bottom of viewport instead\n * @return {Boolean} Returns true if element is in the viewport\n */\n var isInView = function (elem, settings, bottom) {\n var bounds = elem.getBoundingClientRect();\n var offset = getOffset(settings);\n if (bottom) {\n return (\n parseInt(bounds.bottom, 10) <\n (window.innerHeight || document.documentElement.clientHeight)\n );\n }\n return parseInt(bounds.top, 10) <= offset;\n };\n\n /**\n * Check if at the bottom of the viewport\n * @return {Boolean} If true, page is at the bottom of the viewport\n */\n var isAtBottom = function () {\n if (\n Math.ceil(window.innerHeight + window.pageYOffset) >=\n getDocumentHeight()\n )\n return true;\n return false;\n };\n\n /**\n * Check if the last item should be used (even if not at the top of the page)\n * @param {Object} item The last item\n * @param {Object} settings The settings for this instantiation\n * @return {Boolean} If true, use the last item\n */\n var useLastItem = function (item, settings) {\n if (isAtBottom() && isInView(item.content, settings, true)) return true;\n return false;\n };\n\n /**\n * Get the active content\n * @param {Array} contents The content areas\n * @param {Object} settings The settings for this instantiation\n * @return {Object} The content area and matching navigation link\n */\n var getActive = function (contents, settings) {\n var last = contents[contents.length - 1];\n if (useLastItem(last, settings)) return last;\n for (var i = contents.length - 1; i >= 0; i--) {\n if (isInView(contents[i].content, settings)) return contents[i];\n }\n };\n\n /**\n * Deactivate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var deactivateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested || !nav.parentNode) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Remove the active class\n li.classList.remove(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n deactivateNested(li, settings);\n };\n\n /**\n * Deactivate a nav and content area\n * @param {Object} items The nav item and content to deactivate\n * @param {Object} settings The settings for this instantiation\n */\n var deactivate = function (items, settings) {\n // Make sure there are items to deactivate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Remove the active class from the nav and content\n li.classList.remove(settings.navClass);\n items.content.classList.remove(settings.contentClass);\n\n // Deactivate any parent navs in a nested navigation\n deactivateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeDeactivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Activate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var activateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Add the active class\n li.classList.add(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n activateNested(li, settings);\n };\n\n /**\n * Activate a nav and content area\n * @param {Object} items The nav item and content to activate\n * @param {Object} settings The settings for this instantiation\n */\n var activate = function (items, settings) {\n // Make sure there are items to activate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Add the active class to the nav and content\n li.classList.add(settings.navClass);\n items.content.classList.add(settings.contentClass);\n\n // Activate any parent navs in a nested navigation\n activateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeActivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Create the Constructor object\n * @param {String} selector The selector to use for navigation items\n * @param {Object} options User options and settings\n */\n var Constructor = function (selector, options) {\n //\n // Variables\n //\n\n var publicAPIs = {};\n var navItems, contents, current, timeout, settings;\n\n //\n // Methods\n //\n\n /**\n * Set variables from DOM elements\n */\n publicAPIs.setup = function () {\n // Get all nav items\n navItems = document.querySelectorAll(selector);\n\n // Create contents array\n contents = [];\n\n // Loop through each item, get it's matching content, and push to the array\n Array.prototype.forEach.call(navItems, function (item) {\n // Get the content for the nav item\n var content = document.getElementById(\n decodeURIComponent(item.hash.substr(1)),\n );\n if (!content) return;\n\n // Push to the contents array\n contents.push({\n nav: item,\n content: content,\n });\n });\n\n // Sort contents by the order they appear in the DOM\n sortContents(contents);\n };\n\n /**\n * Detect which content is currently active\n */\n publicAPIs.detect = function () {\n // Get the active content\n var active = getActive(contents, settings);\n\n // if there's no active content, deactivate and bail\n if (!active) {\n if (current) {\n deactivate(current, settings);\n current = null;\n }\n return;\n }\n\n // If the active content is the one currently active, do nothing\n if (current && active.content === current.content) return;\n\n // Deactivate the current content and activate the new content\n deactivate(current, settings);\n activate(active, settings);\n\n // Update the currently active content\n current = active;\n };\n\n /**\n * Detect the active content on scroll\n * Debounced for performance\n */\n var scrollHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(publicAPIs.detect);\n };\n\n /**\n * Update content sorting on resize\n * Debounced for performance\n */\n var resizeHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(function () {\n sortContents(contents);\n publicAPIs.detect();\n });\n };\n\n /**\n * Destroy the current instantiation\n */\n publicAPIs.destroy = function () {\n // Undo DOM changes\n if (current) {\n deactivate(current, settings);\n }\n\n // Remove event listeners\n window.removeEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.removeEventListener(\"resize\", resizeHandler, false);\n }\n\n // Reset variables\n contents = null;\n navItems = null;\n current = null;\n timeout = null;\n settings = null;\n };\n\n /**\n * Initialize the current instantiation\n */\n var init = function () {\n // Merge user options into defaults\n settings = extend(defaults, options || {});\n\n // Setup variables based on the current DOM\n publicAPIs.setup();\n\n // Find the currently active content\n publicAPIs.detect();\n\n // Setup event listeners\n window.addEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.addEventListener(\"resize\", resizeHandler, false);\n }\n };\n\n //\n // Initialize and return the public APIs\n //\n\n init();\n return publicAPIs;\n };\n\n //\n // Return the Constructor\n //\n\n return Constructor;\n },\n);\n","// The module cache\nvar __webpack_module_cache__ = {};\n\n// The require function\nfunction __webpack_require__(moduleId) {\n\t// Check if module is in cache\n\tvar cachedModule = __webpack_module_cache__[moduleId];\n\tif (cachedModule !== undefined) {\n\t\treturn cachedModule.exports;\n\t}\n\t// Create a new module (and put it into the cache)\n\tvar module = __webpack_module_cache__[moduleId] = {\n\t\t// no module.id needed\n\t\t// no module.loaded needed\n\t\texports: {}\n\t};\n\n\t// Execute the module function\n\t__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n\t// Return the exports of the module\n\treturn module.exports;\n}\n\n","// getDefaultExport function for compatibility with non-harmony modules\n__webpack_require__.n = (module) => {\n\tvar getter = module && module.__esModule ?\n\t\t() => (module['default']) :\n\t\t() => (module);\n\t__webpack_require__.d(getter, { a: getter });\n\treturn getter;\n};","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.g = (function() {\n\tif (typeof globalThis === 'object') return globalThis;\n\ttry {\n\t\treturn this || new Function('return this')();\n\t} catch (e) {\n\t\tif (typeof window === 'object') return window;\n\t}\n})();","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","import Gumshoe from \"./gumshoe-patched.js\";\n\n////////////////////////////////////////////////////////////////////////////////\n// Scroll Handling\n////////////////////////////////////////////////////////////////////////////////\nvar tocScroll = null;\nvar header = null;\nvar lastScrollTop = window.pageYOffset || document.documentElement.scrollTop;\nconst GO_TO_TOP_OFFSET = 64;\n\nfunction scrollHandlerForHeader() {\n if (Math.floor(header.getBoundingClientRect().top) == 0) {\n header.classList.add(\"scrolled\");\n } else {\n header.classList.remove(\"scrolled\");\n }\n}\n\nfunction scrollHandlerForBackToTop(positionY) {\n if (positionY < GO_TO_TOP_OFFSET) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n } else {\n if (positionY < lastScrollTop) {\n document.documentElement.classList.add(\"show-back-to-top\");\n } else if (positionY > lastScrollTop) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n }\n }\n lastScrollTop = positionY;\n}\n\nfunction scrollHandlerForTOC(positionY) {\n if (tocScroll === null) {\n return;\n }\n\n // top of page.\n if (positionY == 0) {\n tocScroll.scrollTo(0, 0);\n } else if (\n // bottom of page.\n Math.ceil(positionY) >=\n Math.floor(document.documentElement.scrollHeight - window.innerHeight)\n ) {\n tocScroll.scrollTo(0, tocScroll.scrollHeight);\n } else {\n // somewhere in the middle.\n const current = document.querySelector(\".scroll-current\");\n if (current == null) {\n return;\n }\n\n // https://github.com/pypa/pip/issues/9159 This breaks scroll behaviours.\n // // scroll the currently \"active\" heading in toc, into view.\n // const rect = current.getBoundingClientRect();\n // if (0 > rect.top) {\n // current.scrollIntoView(true); // the argument is \"alignTop\"\n // } else if (rect.bottom > window.innerHeight) {\n // current.scrollIntoView(false);\n // }\n }\n}\n\nfunction scrollHandler(positionY) {\n scrollHandlerForHeader();\n scrollHandlerForBackToTop(positionY);\n scrollHandlerForTOC(positionY);\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Theme Toggle\n////////////////////////////////////////////////////////////////////////////////\nfunction setTheme(mode) {\n if (mode !== \"light\" && mode !== \"dark\" && mode !== \"auto\") {\n console.error(`Got invalid theme mode: ${mode}. Resetting to auto.`);\n mode = \"auto\";\n }\n\n document.body.dataset.theme = mode;\n localStorage.setItem(\"theme\", mode);\n console.log(`Changed to ${mode} mode.`);\n}\n\nfunction cycleThemeOnce() {\n const currentTheme = localStorage.getItem(\"theme\") || \"auto\";\n const prefersDark = window.matchMedia(\"(prefers-color-scheme: dark)\").matches;\n\n if (prefersDark) {\n // Auto (dark) -> Light -> Dark\n if (currentTheme === \"auto\") {\n setTheme(\"light\");\n } else if (currentTheme == \"light\") {\n setTheme(\"dark\");\n } else {\n setTheme(\"auto\");\n }\n } else {\n // Auto (light) -> Dark -> Light\n if (currentTheme === \"auto\") {\n setTheme(\"dark\");\n } else if (currentTheme == \"dark\") {\n setTheme(\"light\");\n } else {\n setTheme(\"auto\");\n }\n }\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Setup\n////////////////////////////////////////////////////////////////////////////////\nfunction setupScrollHandler() {\n // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Document/scroll_event\n let last_known_scroll_position = 0;\n let ticking = false;\n\n window.addEventListener(\"scroll\", function (e) {\n last_known_scroll_position = window.scrollY;\n\n if (!ticking) {\n window.requestAnimationFrame(function () {\n scrollHandler(last_known_scroll_position);\n ticking = false;\n });\n\n ticking = true;\n }\n });\n window.scroll();\n}\n\nfunction setupScrollSpy() {\n if (tocScroll === null) {\n return;\n }\n\n // Scrollspy -- highlight table on contents, based on scroll\n new Gumshoe(\".toc-tree a\", {\n reflow: true,\n recursive: true,\n navClass: \"scroll-current\",\n offset: () => {\n let rem = parseFloat(getComputedStyle(document.documentElement).fontSize);\n return header.getBoundingClientRect().height + 0.5 * rem + 1;\n },\n });\n}\n\nfunction setupTheme() {\n // Attach event handlers for toggling themes\n const buttons = document.getElementsByClassName(\"theme-toggle\");\n Array.from(buttons).forEach((btn) => {\n btn.addEventListener(\"click\", cycleThemeOnce);\n });\n}\n\nfunction setup() {\n setupTheme();\n setupScrollHandler();\n setupScrollSpy();\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Main entrypoint\n////////////////////////////////////////////////////////////////////////////////\nfunction main() {\n document.body.parentNode.classList.remove(\"no-js\");\n\n header = document.querySelector(\"header\");\n tocScroll = document.querySelector(\".toc-scroll\");\n\n setup();\n}\n\ndocument.addEventListener(\"DOMContentLoaded\", main);\n"],"names":["root","g","window","this","defaults","navClass","contentClass","nested","nestedClass","offset","reflow","events","emitEvent","type","elem","detail","settings","event","CustomEvent","bubbles","cancelable","dispatchEvent","getOffsetTop","location","offsetParent","offsetTop","sortContents","contents","sort","item1","item2","content","isInView","bottom","bounds","getBoundingClientRect","parseFloat","getOffset","parseInt","innerHeight","document","documentElement","clientHeight","top","isAtBottom","Math","ceil","pageYOffset","max","body","scrollHeight","offsetHeight","getActive","last","length","item","useLastItem","i","deactivateNested","nav","parentNode","li","closest","classList","remove","deactivate","items","link","activateNested","add","selector","options","navItems","current","timeout","publicAPIs","querySelectorAll","Array","prototype","forEach","call","getElementById","decodeURIComponent","hash","substr","push","active","activate","scrollHandler","cancelAnimationFrame","requestAnimationFrame","detect","resizeHandler","destroy","removeEventListener","merged","arguments","obj","key","hasOwnProperty","extend","setup","addEventListener","factory","__webpack_module_cache__","__webpack_require__","moduleId","cachedModule","undefined","exports","module","__webpack_modules__","n","getter","__esModule","d","a","definition","o","Object","defineProperty","enumerable","get","globalThis","Function","e","prop","tocScroll","header","lastScrollTop","scrollTop","GO_TO_TOP_OFFSET","cycleThemeOnce","currentTheme","localStorage","getItem","mode","matchMedia","matches","console","error","dataset","theme","setItem","log","buttons","getElementsByClassName","from","btn","setupTheme","last_known_scroll_position","ticking","scrollY","positionY","floor","scrollHandlerForBackToTop","scrollTo","querySelector","scrollHandlerForTOC","scroll","setupScrollHandler","recursive","rem","getComputedStyle","fontSize","height"],"sourceRoot":""}
\ No newline at end of file diff --git a/v7.2.2/_static/searchtools.js b/v7.2.2/_static/searchtools.js deleted file mode 100644 index 7918c3fa..00000000 --- a/v7.2.2/_static/searchtools.js +++ /dev/null @@ -1,574 +0,0 @@ -/* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -/** - * Simple result scoring code. - */ -if (typeof Scorer === "undefined") { - var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [docname, title, anchor, descr, score, filename] - // and returns the new score. - /* - score: result => { - const [docname, title, anchor, descr, score, filename] = result - return score - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: { - 0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5, // used to be unimportantResults - }, - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - partialTitle: 7, - // query found in terms - term: 5, - partialTerm: 2, - }; -} - -const _removeChildren = (element) => { - while (element && element.lastChild) element.removeChild(element.lastChild); -}; - -/** - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping - */ -const _escapeRegExp = (string) => - string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string - -const _displayItem = (item, searchTerms, highlightTerms) => { - const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; - const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; - const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - const contentRoot = document.documentElement.dataset.content_root; - - const [docName, title, anchor, descr, score, _filename] = item; - - let listItem = document.createElement("li"); - let requestUrl; - let linkUrl; - if (docBuilder === "dirhtml") { - // dirhtml builder - let dirname = docName + "/"; - if (dirname.match(/\/index\/$/)) - dirname = dirname.substring(0, dirname.length - 6); - else if (dirname === "index/") dirname = ""; - requestUrl = contentRoot + dirname; - linkUrl = requestUrl; - } else { - // normal html builders - requestUrl = contentRoot + docName + docFileSuffix; - linkUrl = docName + docLinkSuffix; - } - let linkEl = listItem.appendChild(document.createElement("a")); - linkEl.href = linkUrl + anchor; - linkEl.dataset.score = score; - linkEl.innerHTML = title; - if (descr) { - listItem.appendChild(document.createElement("span")).innerHTML = - " (" + descr + ")"; - // highlight search terms in the description - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - } - else if (showSearchSummary) - fetch(requestUrl) - .then((responseData) => responseData.text()) - .then((data) => { - if (data) - listItem.appendChild( - Search.makeSearchSummary(data, searchTerms) - ); - // highlight search terms in the summary - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - }); - Search.output.appendChild(listItem); -}; -const _finishSearch = (resultCount) => { - Search.stopPulse(); - Search.title.innerText = _("Search Results"); - if (!resultCount) - Search.status.innerText = Documentation.gettext( - "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." - ); - else - Search.status.innerText = _( - `Search finished, found ${resultCount} page(s) matching the search query.` - ); -}; -const _displayNextItem = ( - results, - resultCount, - searchTerms, - highlightTerms, -) => { - // results left, load the summary and display it - // this is intended to be dynamic (don't sub resultsCount) - if (results.length) { - _displayItem(results.pop(), searchTerms, highlightTerms); - setTimeout( - () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), - 5 - ); - } - // search finished, update title and status message - else _finishSearch(resultCount); -}; - -/** - * Default splitQuery function. Can be overridden in ``sphinx.search`` with a - * custom function per language. - * - * The regular expression works by splitting the string on consecutive characters - * that are not Unicode letters, numbers, underscores, or emoji characters. - * This is the same as ``\W+`` in Python, preserving the surrogate pair area. - */ -if (typeof splitQuery === "undefined") { - var splitQuery = (query) => query - .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter(term => term) // remove remaining empty strings -} - -/** - * Search Module - */ -const Search = { - _index: null, - _queued_query: null, - _pulse_status: -1, - - htmlToText: (htmlString) => { - const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); - const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent !== undefined) return docContent.textContent; - console.warn( - "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." - ); - return ""; - }, - - init: () => { - const query = new URLSearchParams(window.location.search).get("q"); - document - .querySelectorAll('input[name="q"]') - .forEach((el) => (el.value = query)); - if (query) Search.performSearch(query); - }, - - loadIndex: (url) => - (document.body.appendChild(document.createElement("script")).src = url), - - setIndex: (index) => { - Search._index = index; - if (Search._queued_query !== null) { - const query = Search._queued_query; - Search._queued_query = null; - Search.query(query); - } - }, - - hasIndex: () => Search._index !== null, - - deferQuery: (query) => (Search._queued_query = query), - - stopPulse: () => (Search._pulse_status = -1), - - startPulse: () => { - if (Search._pulse_status >= 0) return; - - const pulse = () => { - Search._pulse_status = (Search._pulse_status + 1) % 4; - Search.dots.innerText = ".".repeat(Search._pulse_status); - if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch: (query) => { - // create the required interface elements - const searchText = document.createElement("h2"); - searchText.textContent = _("Searching"); - const searchSummary = document.createElement("p"); - searchSummary.classList.add("search-summary"); - searchSummary.innerText = ""; - const searchList = document.createElement("ul"); - searchList.classList.add("search"); - - const out = document.getElementById("search-results"); - Search.title = out.appendChild(searchText); - Search.dots = Search.title.appendChild(document.createElement("span")); - Search.status = out.appendChild(searchSummary); - Search.output = out.appendChild(searchList); - - const searchProgress = document.getElementById("search-progress"); - // Some themes don't use the search progress node - if (searchProgress) { - searchProgress.innerText = _("Preparing search..."); - } - Search.startPulse(); - - // index already loaded, the browser was quick! - if (Search.hasIndex()) Search.query(query); - else Search.deferQuery(query); - }, - - /** - * execute search (requires search index to be loaded) - */ - query: (query) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - - // stem the search terms and add them to the correct list - const stemmer = new Stemmer(); - const searchTerms = new Set(); - const excludedTerms = new Set(); - const highlightTerms = new Set(); - const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); - splitQuery(query.trim()).forEach((queryTerm) => { - const queryTermLower = queryTerm.toLowerCase(); - - // maybe skip this "word" - // stopwords array is from language_data.js - if ( - stopwords.indexOf(queryTermLower) !== -1 || - queryTerm.match(/^\d+$/) - ) - return; - - // stem the word - let word = stemmer.stemWord(queryTermLower); - // select the correct list - if (word[0] === "-") excludedTerms.add(word.substr(1)); - else { - searchTerms.add(word); - highlightTerms.add(queryTermLower); - } - }); - - if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js - localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) - } - - // console.debug("SEARCH: searching for:"); - // console.info("required: ", [...searchTerms]); - // console.info("excluded: ", [...excludedTerms]); - - // array of [docname, title, anchor, descr, score, filename] - let results = []; - _removeChildren(document.getElementById("search-progress")); - - const queryLower = query.toLowerCase(); - for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { - for (const [file, id] of foundTitles) { - let score = Math.round(100 * queryLower.length / title.length) - results.push([ - docNames[file], - titles[file] !== title ? `${titles[file]} > ${title}` : title, - id !== null ? "#" + id : "", - null, - score, - filenames[file], - ]); - } - } - } - - // search for explicit entries in index directives - for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id] of foundEntries) { - let score = Math.round(100 * queryLower.length / entry.length) - results.push([ - docNames[file], - titles[file], - id ? "#" + id : "", - null, - score, - filenames[file], - ]); - } - } - } - - // lookup as object - objectTerms.forEach((term) => - results.push(...Search.performObjectSearch(term, objectTerms)) - ); - - // lookup as search terms in fulltext - results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); - - // let the scorer override scores with a custom scoring function - if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); - - // now sort the results by score (in opposite order of appearance, since the - // display function below uses pop() to retrieve items) and then - // alphabetically - results.sort((a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; - }); - - // remove duplicate search results - // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept - let seen = new Set(); - results = results.reverse().reduce((acc, result) => { - let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); - if (!seen.has(resultStr)) { - acc.push(result); - seen.add(resultStr); - } - return acc; - }, []); - - results = results.reverse(); - - // for debugging - //Search.lastresults = results.slice(); // a copy - // console.info("search results:", Search.lastresults); - - // print the results - _displayNextItem(results, results.length, searchTerms, highlightTerms); - }, - - /** - * search for object names - */ - performObjectSearch: (object, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const objects = Search._index.objects; - const objNames = Search._index.objnames; - const titles = Search._index.titles; - - const results = []; - - const objectSearchCallback = (prefix, match) => { - const name = match[4] - const fullname = (prefix ? prefix + "." : "") + name; - const fullnameLower = fullname.toLowerCase(); - if (fullnameLower.indexOf(object) < 0) return; - - let score = 0; - const parts = fullnameLower.split("."); - - // check for different match types: exact matches of full name or - // "last name" (i.e. last dotted part) - if (fullnameLower === object || parts.slice(-1)[0] === object) - score += Scorer.objNameMatch; - else if (parts.slice(-1)[0].indexOf(object) > -1) - score += Scorer.objPartialMatch; // matches in last name - - const objName = objNames[match[1]][2]; - const title = titles[match[0]]; - - // If more than one term searched for, we require other words to be - // found in the name/title/description - const otherTerms = new Set(objectTerms); - otherTerms.delete(object); - if (otherTerms.size > 0) { - const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); - if ( - [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) - ) - return; - } - - let anchor = match[3]; - if (anchor === "") anchor = fullname; - else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; - - const descr = objName + _(", in ") + title; - - // add custom score for some objects according to scorer - if (Scorer.objPrio.hasOwnProperty(match[2])) - score += Scorer.objPrio[match[2]]; - else score += Scorer.objPrioDefault; - - results.push([ - docNames[match[0]], - fullname, - "#" + anchor, - descr, - score, - filenames[match[0]], - ]); - }; - Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => - objectSearchCallback(prefix, array) - ) - ); - return results; - }, - - /** - * search for full-text terms in the index - */ - performTermsSearch: (searchTerms, excludedTerms) => { - // prepare search - const terms = Search._index.terms; - const titleTerms = Search._index.titleterms; - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - - const scoreMap = new Map(); - const fileMap = new Map(); - - // perform the search on the required terms - searchTerms.forEach((word) => { - const files = []; - const arr = [ - { files: terms[word], score: Scorer.term }, - { files: titleTerms[word], score: Scorer.title }, - ]; - // add support for partial matches - if (word.length > 2) { - const escapedWord = _escapeRegExp(word); - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord) && !terms[word]) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord) && !titleTerms[word]) - arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); - }); - } - - // no match but word was a required one - if (arr.every((record) => record.files === undefined)) return; - - // found search word in contents - arr.forEach((record) => { - if (record.files === undefined) return; - - let recordFiles = record.files; - if (recordFiles.length === undefined) recordFiles = [recordFiles]; - files.push(...recordFiles); - - // set score for the word in each file - recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, {}); - scoreMap.get(file)[word] = record.score; - }); - }); - - // create the mapping - files.forEach((file) => { - if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) - fileMap.get(file).push(word); - else fileMap.set(file, [word]); - }); - }); - - // now check if the files don't contain excluded terms - const results = []; - for (const [file, wordList] of fileMap) { - // check if all requirements are matched - - // as search terms with length < 3 are discarded - const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2 - ).length; - if ( - wordList.length !== searchTerms.size && - wordList.length !== filteredTermCount - ) - continue; - - // ensure that none of the excluded terms is in the search result - if ( - [...excludedTerms].some( - (term) => - terms[term] === file || - titleTerms[term] === file || - (terms[term] || []).includes(file) || - (titleTerms[term] || []).includes(file) - ) - ) - break; - - // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); - // add result to the result list - results.push([ - docNames[file], - titles[file], - "", - null, - score, - filenames[file], - ]); - } - return results; - }, - - /** - * helper function to return a node containing the - * search summary for a given text. keywords is a list - * of stemmed words. - */ - makeSearchSummary: (htmlText, keywords) => { - const text = Search.htmlToText(htmlText); - if (text === "") return null; - - const textLower = text.toLowerCase(); - const actualStartPosition = [...keywords] - .map((k) => textLower.indexOf(k.toLowerCase())) - .filter((i) => i > -1) - .slice(-1)[0]; - const startWithContext = Math.max(actualStartPosition - 120, 0); - - const top = startWithContext === 0 ? "" : "..."; - const tail = startWithContext + 240 < text.length ? "..." : ""; - - let summary = document.createElement("p"); - summary.classList.add("context"); - summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - - return summary; - }, -}; - -_ready(Search.init); diff --git a/v7.2.2/_static/skeleton.css b/v7.2.2/_static/skeleton.css deleted file mode 100644 index 467c878c..00000000 --- a/v7.2.2/_static/skeleton.css +++ /dev/null @@ -1,296 +0,0 @@ -/* Some sane resets. */ -html { - height: 100%; -} - -body { - margin: 0; - min-height: 100%; -} - -/* All the flexbox magic! */ -body, -.sb-announcement, -.sb-content, -.sb-main, -.sb-container, -.sb-container__inner, -.sb-article-container, -.sb-footer-content, -.sb-header, -.sb-header-secondary, -.sb-footer { - display: flex; -} - -/* These order things vertically */ -body, -.sb-main, -.sb-article-container { - flex-direction: column; -} - -/* Put elements in the center */ -.sb-header, -.sb-header-secondary, -.sb-container, -.sb-content, -.sb-footer, -.sb-footer-content { - justify-content: center; -} -/* Put elements at the ends */ -.sb-article-container { - justify-content: space-between; -} - -/* These elements grow. */ -.sb-main, -.sb-content, -.sb-container, -article { - flex-grow: 1; -} - -/* Because padding making this wider is not fun */ -article { - box-sizing: border-box; -} - -/* The announcements element should never be wider than the page. */ -.sb-announcement { - max-width: 100%; -} - -.sb-sidebar-primary, -.sb-sidebar-secondary { - flex-shrink: 0; - width: 17rem; -} - -.sb-announcement__inner { - justify-content: center; - - box-sizing: border-box; - height: 3rem; - - overflow-x: auto; - white-space: nowrap; -} - -/* Sidebars, with checkbox-based toggle */ -.sb-sidebar-primary, -.sb-sidebar-secondary { - position: fixed; - height: 100%; - top: 0; -} - -.sb-sidebar-primary { - left: -17rem; - transition: left 250ms ease-in-out; -} -.sb-sidebar-secondary { - right: -17rem; - transition: right 250ms ease-in-out; -} - -.sb-sidebar-toggle { - display: none; -} -.sb-sidebar-overlay { - position: fixed; - top: 0; - width: 0; - height: 0; - - transition: width 0ms ease 250ms, height 0ms ease 250ms, opacity 250ms ease; - - opacity: 0; - background-color: rgba(0, 0, 0, 0.54); -} - -#sb-sidebar-toggle--primary:checked - ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--primary"], -#sb-sidebar-toggle--secondary:checked - ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--secondary"] { - width: 100%; - height: 100%; - opacity: 1; - transition: width 0ms ease, height 0ms ease, opacity 250ms ease; -} - -#sb-sidebar-toggle--primary:checked ~ .sb-container .sb-sidebar-primary { - left: 0; -} -#sb-sidebar-toggle--secondary:checked ~ .sb-container .sb-sidebar-secondary { - right: 0; -} - -/* Full-width mode */ -.drop-secondary-sidebar-for-full-width-content - .hide-when-secondary-sidebar-shown { - display: none !important; -} -.drop-secondary-sidebar-for-full-width-content .sb-sidebar-secondary { - display: none !important; -} - -/* Mobile views */ -.sb-page-width { - width: 100%; -} - -.sb-article-container, -.sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content .sb-article, -.drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 100vw; -} - -.sb-article, -.match-content-width { - padding: 0 1rem; - box-sizing: border-box; -} - -@media (min-width: 32rem) { - .sb-article, - .match-content-width { - padding: 0 2rem; - } -} - -/* Tablet views */ -@media (min-width: 42rem) { - .sb-article-container { - width: auto; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 42rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} -@media (min-width: 46rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 46rem; - } - .sb-article, - .match-content-width { - width: 46rem; - } -} -@media (min-width: 50rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 50rem; - } - .sb-article, - .match-content-width { - width: 50rem; - } -} - -/* Tablet views */ -@media (min-width: 59rem) { - .sb-sidebar-secondary { - position: static; - } - .hide-when-secondary-sidebar-shown { - display: none !important; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 59rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} -@media (min-width: 63rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 63rem; - } - .sb-article, - .match-content-width { - width: 46rem; - } -} -@media (min-width: 67rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } - .sb-article, - .match-content-width { - width: 50rem; - } -} - -/* Desktop views */ -@media (min-width: 76rem) { - .sb-sidebar-primary { - position: static; - } - .hide-when-primary-sidebar-shown { - display: none !important; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 59rem; - } - .sb-article, - .match-content-width { - width: 42rem; - } -} - -/* Full desktop views */ -@media (min-width: 80rem) { - .sb-article, - .match-content-width { - width: 46rem; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 63rem; - } -} - -@media (min-width: 84rem) { - .sb-article, - .match-content-width { - width: 50rem; - } - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } -} - -@media (min-width: 88rem) { - .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content .sb-article, - .drop-secondary-sidebar-for-full-width-content .match-content-width { - width: 67rem; - } - .sb-page-width { - width: 88rem; - } -} diff --git a/v7.2.2/_static/sphinx_highlight.js b/v7.2.2/_static/sphinx_highlight.js deleted file mode 100644 index 8a96c69a..00000000 --- a/v7.2.2/_static/sphinx_highlight.js +++ /dev/null @@ -1,154 +0,0 @@ -/* Highlighting utilities for Sphinx HTML documentation. */ -"use strict"; - -const SPHINX_HIGHLIGHT_ENABLED = true - -/** - * highlight a given string on a node by wrapping it in - * span elements with the given class name. - */ -const _highlight = (node, addItems, text, className) => { - if (node.nodeType === Node.TEXT_NODE) { - const val = node.nodeValue; - const parent = node.parentNode; - const pos = val.toLowerCase().indexOf(text); - if ( - pos >= 0 && - !parent.classList.contains(className) && - !parent.classList.contains("nohighlight") - ) { - let span; - - const closestNode = parent.closest("body, svg, foreignObject"); - const isInSVG = closestNode && closestNode.matches("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.classList.add(className); - } - - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - const rest = document.createTextNode(val.substr(pos + text.length)); - parent.insertBefore( - span, - parent.insertBefore( - rest, - node.nextSibling - ) - ); - node.nodeValue = val.substr(0, pos); - /* There may be more occurrences of search term in this node. So call this - * function recursively on the remaining fragment. - */ - _highlight(rest, addItems, text, className); - - if (isInSVG) { - const rect = document.createElementNS( - "http://www.w3.org/2000/svg", - "rect" - ); - const bbox = parent.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute("class", className); - addItems.push({ parent: parent, target: rect }); - } - } - } else if (node.matches && !node.matches("button, select, textarea")) { - node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); - } -}; -const _highlightText = (thisNode, text, className) => { - let addItems = []; - _highlight(thisNode, addItems, text, className); - addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target) - ); -}; - -/** - * Small JavaScript module for the documentation. - */ -const SphinxHighlight = { - - /** - * highlight the search words provided in localstorage in the text - */ - highlightSearchWords: () => { - if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight - - // get and clear terms from localstorage - const url = new URL(window.location); - const highlight = - localStorage.getItem("sphinx_highlight_terms") - || url.searchParams.get("highlight") - || ""; - localStorage.removeItem("sphinx_highlight_terms") - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - - // get individual terms from highlight string - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); - if (terms.length === 0) return; // nothing to do - - // There should never be more than one element matching "div.body" - const divBody = document.querySelectorAll("div.body"); - const body = divBody.length ? divBody[0] : document.querySelector("body"); - window.setTimeout(() => { - terms.forEach((term) => _highlightText(body, term, "highlighted")); - }, 10); - - const searchBox = document.getElementById("searchbox"); - if (searchBox === null) return; - searchBox.appendChild( - document - .createRange() - .createContextualFragment( - '<p class="highlight-link">' + - '<a href="javascript:SphinxHighlight.hideSearchWords()">' + - _("Hide Search Matches") + - "</a></p>" - ) - ); - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords: () => { - document - .querySelectorAll("#searchbox .highlight-link") - .forEach((el) => el.remove()); - document - .querySelectorAll("span.highlighted") - .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") - }, - - initEscapeListener: () => { - // only install a listener if it is really needed - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; - if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { - SphinxHighlight.hideSearchWords(); - event.preventDefault(); - } - }); - }, -}; - -_ready(() => { - /* Do not call highlightSearchWords() when we are on the search page. - * It will highlight words from the *previous* search query. - */ - if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); - SphinxHighlight.initEscapeListener(); -}); diff --git a/v7.2.2/_static/statsd_additional_objects.inv b/v7.2.2/_static/statsd_additional_objects.inv Binary files differdeleted file mode 100644 index f84ab9f1..00000000 --- a/v7.2.2/_static/statsd_additional_objects.inv +++ /dev/null diff --git a/v7.2.2/_static/styles/furo-extensions.css b/v7.2.2/_static/styles/furo-extensions.css deleted file mode 100644 index bc447f22..00000000 --- a/v7.2.2/_static/styles/furo-extensions.css +++ /dev/null @@ -1,2 +0,0 @@ -#furo-sidebar-ad-placement{padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)}#furo-sidebar-ad-placement .ethical-sidebar{background:var(--color-background-secondary);border:none;box-shadow:none}#furo-sidebar-ad-placement .ethical-sidebar:hover{background:var(--color-background-hover)}#furo-sidebar-ad-placement .ethical-sidebar a{color:var(--color-foreground-primary)}#furo-sidebar-ad-placement .ethical-callout a{color:var(--color-foreground-secondary)!important}#furo-readthedocs-versions{background:transparent;display:block;position:static;width:100%}#furo-readthedocs-versions .rst-versions{background:#1a1c1e}#furo-readthedocs-versions .rst-current-version{background:var(--color-sidebar-item-background);cursor:unset}#furo-readthedocs-versions .rst-current-version:hover{background:var(--color-sidebar-item-background)}#furo-readthedocs-versions .rst-current-version .fa-book{color:var(--color-foreground-primary)}#furo-readthedocs-versions>.rst-other-versions{padding:0}#furo-readthedocs-versions>.rst-other-versions small{opacity:1}#furo-readthedocs-versions .injected .rst-versions{position:unset}#furo-readthedocs-versions:focus-within,#furo-readthedocs-versions:hover{box-shadow:0 0 0 1px var(--color-sidebar-background-border)}#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:hover .rst-current-version{background:#1a1c1e;font-size:inherit;height:auto;line-height:inherit;padding:12px;text-align:right}#furo-readthedocs-versions:focus-within .rst-current-version .fa-book,#furo-readthedocs-versions:hover .rst-current-version .fa-book{color:#fff;float:left}#furo-readthedocs-versions:focus-within .fa-caret-down,#furo-readthedocs-versions:hover .fa-caret-down{display:none}#furo-readthedocs-versions:focus-within .injected,#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:focus-within .rst-other-versions,#furo-readthedocs-versions:hover .injected,#furo-readthedocs-versions:hover .rst-current-version,#furo-readthedocs-versions:hover .rst-other-versions{display:block}#furo-readthedocs-versions:focus-within>.rst-current-version,#furo-readthedocs-versions:hover>.rst-current-version{display:none}.highlight:hover button.copybtn{color:var(--color-code-foreground)}.highlight button.copybtn{align-items:center;background-color:var(--color-code-background);border:none;color:var(--color-background-item);cursor:pointer;height:1.25em;opacity:1;right:.5rem;top:.625rem;transition:color .3s,opacity .3s;width:1.25em}.highlight button.copybtn:hover{background-color:var(--color-code-background);color:var(--color-brand-content)}.highlight button.copybtn:after{background-color:transparent;color:var(--color-code-foreground);display:none}.highlight button.copybtn.success{color:#22863a;transition:color 0ms}.highlight button.copybtn.success:after{display:block}.highlight button.copybtn svg{padding:0}body{--sd-color-primary:var(--color-brand-primary);--sd-color-primary-highlight:var(--color-brand-content);--sd-color-primary-text:var(--color-background-primary);--sd-color-shadow:rgba(0,0,0,.05);--sd-color-card-border:var(--color-card-border);--sd-color-card-border-hover:var(--color-brand-content);--sd-color-card-background:var(--color-card-background);--sd-color-card-text:var(--color-foreground-primary);--sd-color-card-header:var(--color-card-marginals-background);--sd-color-card-footer:var(--color-card-marginals-background);--sd-color-tabs-label-active:var(--color-brand-content);--sd-color-tabs-label-hover:var(--color-foreground-muted);--sd-color-tabs-label-inactive:var(--color-foreground-muted);--sd-color-tabs-underline-active:var(--color-brand-content);--sd-color-tabs-underline-hover:var(--color-foreground-border);--sd-color-tabs-underline-inactive:var(--color-background-border);--sd-color-tabs-overline:var(--color-background-border);--sd-color-tabs-underline:var(--color-background-border)}.sd-tab-content{box-shadow:0 -2px var(--sd-color-tabs-overline),0 1px var(--sd-color-tabs-underline)}.sd-card{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)}.sd-shadow-sm{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-md{box-shadow:0 .3rem .75rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-lg{box-shadow:0 .6rem 1.5rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-card-hover:hover{transform:none}.sd-cards-carousel{gap:.25rem;padding:.25rem}body{--tabs--label-text:var(--color-foreground-muted);--tabs--label-text--hover:var(--color-foreground-muted);--tabs--label-text--active:var(--color-brand-content);--tabs--label-text--active--hover:var(--color-brand-content);--tabs--label-background:transparent;--tabs--label-background--hover:transparent;--tabs--label-background--active:transparent;--tabs--label-background--active--hover:transparent;--tabs--padding-x:0.25em;--tabs--margin-x:1em;--tabs--border:var(--color-background-border);--tabs--label-border:transparent;--tabs--label-border--hover:var(--color-foreground-muted);--tabs--label-border--active:var(--color-brand-content);--tabs--label-border--active--hover:var(--color-brand-content)}[role=main] .container{max-width:none;padding-left:0;padding-right:0}.shadow.docutils{border:none;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)!important}.sphinx-bs .card{background-color:var(--color-background-secondary);color:var(--color-foreground)} -/*# sourceMappingURL=furo-extensions.css.map*/
\ No newline at end of file diff --git a/v7.2.2/_static/styles/furo-extensions.css.map b/v7.2.2/_static/styles/furo-extensions.css.map deleted file mode 100644 index 9ba5637f..00000000 --- a/v7.2.2/_static/styles/furo-extensions.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"styles/furo-extensions.css","mappings":"AAGA,2BACE,oFACA,4CAKE,6CAHA,YACA,eAEA,CACA,kDACE,yCAEF,8CACE,sCAEJ,8CACE,kDAEJ,2BAGE,uBACA,cAHA,gBACA,UAEA,CAGA,yCACE,mBAEF,gDAEE,gDADA,YACA,CACA,sDACE,gDACF,yDACE,sCAEJ,+CACE,UACA,qDACE,UAGF,mDACE,eAEJ,yEAEE,4DAEA,mHASE,mBAPA,kBAEA,YADA,oBAGA,aADA,gBAIA,CAEA,qIAEE,WADA,UACA,CAEJ,uGACE,aAEF,iUAGE,cAEF,mHACE,aC1EJ,gCACE,mCAEF,0BAKE,mBAUA,8CACA,YAFA,mCAKA,eAZA,cALA,UASA,YADA,YAYA,iCAdA,YAcA,CAEA,gCAEE,8CADA,gCACA,CAEF,gCAGE,6BADA,mCADA,YAEA,CAEF,kCAEE,cADA,oBACA,CACA,wCACE,cAEJ,8BACE,UC5CN,KAEE,6CAA8C,CAC9C,uDAAwD,CACxD,uDAAwD,CAGxD,iCAAsC,CAGtC,+CAAgD,CAChD,uDAAwD,CACxD,uDAAwD,CACxD,oDAAqD,CACrD,6DAA8D,CAC9D,6DAA8D,CAG9D,uDAAwD,CACxD,yDAA0D,CAC1D,4DAA6D,CAC7D,2DAA4D,CAC5D,8DAA+D,CAC/D,iEAAkE,CAClE,uDAAwD,CACxD,wDAAyD,CAG3D,gBACE,qFAGF,SACE,6EAEF,cACE,uFAEF,cACE,uFAEF,cACE,uFAGF,qBACE,eAEF,mBACE,WACA,eChDF,KACE,gDAAiD,CACjD,uDAAwD,CACxD,qDAAsD,CACtD,4DAA6D,CAC7D,oCAAqC,CACrC,2CAA4C,CAC5C,4CAA6C,CAC7C,mDAAoD,CACpD,wBAAyB,CACzB,oBAAqB,CACrB,6CAA8C,CAC9C,gCAAiC,CACjC,yDAA0D,CAC1D,uDAAwD,CACxD,8DAA+D,CCbjE,uBACE,eACA,eACA,gBAGF,iBACE,YACA,+EAGF,iBACE,mDACA","sources":["webpack:///./src/furo/assets/styles/extensions/_readthedocs.sass","webpack:///./src/furo/assets/styles/extensions/_copybutton.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-design.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-inline-tabs.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-panels.sass"],"sourcesContent":["// This file contains the styles used for tweaking how ReadTheDoc's embedded\n// contents would show up inside the theme.\n\n#furo-sidebar-ad-placement\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n .ethical-sidebar\n // Remove the border and box-shadow.\n border: none\n box-shadow: none\n // Manage the background colors.\n background: var(--color-background-secondary)\n &:hover\n background: var(--color-background-hover)\n // Ensure the text is legible.\n a\n color: var(--color-foreground-primary)\n\n .ethical-callout a\n color: var(--color-foreground-secondary) !important\n\n#furo-readthedocs-versions\n position: static\n width: 100%\n background: transparent\n display: block\n\n // Make the background color fit with the theme's aesthetic.\n .rst-versions\n background: rgb(26, 28, 30)\n\n .rst-current-version\n cursor: unset\n background: var(--color-sidebar-item-background)\n &:hover\n background: var(--color-sidebar-item-background)\n .fa-book\n color: var(--color-foreground-primary)\n\n > .rst-other-versions\n padding: 0\n small\n opacity: 1\n\n .injected\n .rst-versions\n position: unset\n\n &:hover,\n &:focus-within\n box-shadow: 0 0 0 1px var(--color-sidebar-background-border)\n\n .rst-current-version\n // Undo the tweaks done in RTD's CSS\n font-size: inherit\n line-height: inherit\n height: auto\n text-align: right\n padding: 12px\n\n // Match the rest of the body\n background: #1a1c1e\n\n .fa-book\n float: left\n color: white\n\n .fa-caret-down\n display: none\n\n .rst-current-version,\n .rst-other-versions,\n .injected\n display: block\n\n > .rst-current-version\n display: none\n",".highlight\n &:hover button.copybtn\n color: var(--color-code-foreground)\n\n button.copybtn\n // Make it visible\n opacity: 1\n\n // Align things correctly\n align-items: center\n\n height: 1.25em\n width: 1.25em\n\n top: 0.625rem // $code-spacing-vertical\n right: 0.5rem\n\n // Make it look better\n color: var(--color-background-item)\n background-color: var(--color-code-background)\n border: none\n\n // Change to cursor to make it obvious that you can click on it\n cursor: pointer\n\n // Transition smoothly, for aesthetics\n transition: color 300ms, opacity 300ms\n\n &:hover\n color: var(--color-brand-content)\n background-color: var(--color-code-background)\n\n &::after\n display: none\n color: var(--color-code-foreground)\n background-color: transparent\n\n &.success\n transition: color 0ms\n color: #22863a\n &::after\n display: block\n\n svg\n padding: 0\n","body\n // Colors\n --sd-color-primary: var(--color-brand-primary)\n --sd-color-primary-highlight: var(--color-brand-content)\n --sd-color-primary-text: var(--color-background-primary)\n\n // Shadows\n --sd-color-shadow: rgba(0, 0, 0, 0.05)\n\n // Cards\n --sd-color-card-border: var(--color-card-border)\n --sd-color-card-border-hover: var(--color-brand-content)\n --sd-color-card-background: var(--color-card-background)\n --sd-color-card-text: var(--color-foreground-primary)\n --sd-color-card-header: var(--color-card-marginals-background)\n --sd-color-card-footer: var(--color-card-marginals-background)\n\n // Tabs\n --sd-color-tabs-label-active: var(--color-brand-content)\n --sd-color-tabs-label-hover: var(--color-foreground-muted)\n --sd-color-tabs-label-inactive: var(--color-foreground-muted)\n --sd-color-tabs-underline-active: var(--color-brand-content)\n --sd-color-tabs-underline-hover: var(--color-foreground-border)\n --sd-color-tabs-underline-inactive: var(--color-background-border)\n --sd-color-tabs-overline: var(--color-background-border)\n --sd-color-tabs-underline: var(--color-background-border)\n\n// Tabs\n.sd-tab-content\n box-shadow: 0 -2px var(--sd-color-tabs-overline), 0 1px var(--sd-color-tabs-underline)\n\n// Shadows\n.sd-card // Have a shadow by default\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n.sd-shadow-sm\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-md\n box-shadow: 0 0.3rem 0.75rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-lg\n box-shadow: 0 0.6rem 1.5rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Cards\n.sd-card-hover:hover // Don't change scale on hover\n transform: none\n\n.sd-cards-carousel // Have a bit of gap in the carousel by default\n gap: 0.25rem\n padding: 0.25rem\n","// This file contains styles to tweak sphinx-inline-tabs to work well with Furo.\n\nbody\n --tabs--label-text: var(--color-foreground-muted)\n --tabs--label-text--hover: var(--color-foreground-muted)\n --tabs--label-text--active: var(--color-brand-content)\n --tabs--label-text--active--hover: var(--color-brand-content)\n --tabs--label-background: transparent\n --tabs--label-background--hover: transparent\n --tabs--label-background--active: transparent\n --tabs--label-background--active--hover: transparent\n --tabs--padding-x: 0.25em\n --tabs--margin-x: 1em\n --tabs--border: var(--color-background-border)\n --tabs--label-border: transparent\n --tabs--label-border--hover: var(--color-foreground-muted)\n --tabs--label-border--active: var(--color-brand-content)\n --tabs--label-border--active--hover: var(--color-brand-content)\n","// This file contains styles to tweak sphinx-panels to work well with Furo.\n\n// sphinx-panels includes Bootstrap 4, which uses .container which can conflict\n// with docutils' `.. container::` directive.\n[role=\"main\"] .container\n max-width: initial\n padding-left: initial\n padding-right: initial\n\n// Make the panels look nicer!\n.shadow.docutils\n border: none\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Make panel colors respond to dark mode\n.sphinx-bs .card\n background-color: var(--color-background-secondary)\n color: var(--color-foreground)\n"],"names":[],"sourceRoot":""}
\ No newline at end of file diff --git a/v7.2.2/_static/styles/furo.css b/v7.2.2/_static/styles/furo.css deleted file mode 100644 index 3d29a218..00000000 --- a/v7.2.2/_static/styles/furo.css +++ /dev/null @@ -1,2 +0,0 @@ -/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{-webkit-text-size-adjust:100%;line-height:1.15}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}[hidden],template{display:none}@media print{.content-icon-container,.headerlink,.mobile-header,.related-pages{display:none!important}.highlight{border:.1pt solid var(--color-foreground-border)}a,blockquote,dl,ol,pre,table,ul{page-break-inside:avoid}caption,figure,h1,h2,h3,h4,h5,h6,img{page-break-after:avoid;page-break-inside:avoid}dl,ol,ul{page-break-before:avoid}}.visually-hidden{clip:rect(0,0,0,0)!important;border:0!important;height:1px!important;margin:-1px!important;overflow:hidden!important;padding:0!important;position:absolute!important;white-space:nowrap!important;width:1px!important}:-moz-focusring{outline:auto}body{--font-stack:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;--font-stack--monospace:"SFMono-Regular",Menlo,Consolas,Monaco,Liberation Mono,Lucida Console,monospace;--font-size--normal:100%;--font-size--small:87.5%;--font-size--small--2:81.25%;--font-size--small--3:75%;--font-size--small--4:62.5%;--sidebar-caption-font-size:var(--font-size--small--2);--sidebar-item-font-size:var(--font-size--small);--sidebar-search-input-font-size:var(--font-size--small);--toc-font-size:var(--font-size--small--3);--toc-font-size--mobile:var(--font-size--normal);--toc-title-font-size:var(--font-size--small--4);--admonition-font-size:0.8125rem;--admonition-title-font-size:0.8125rem;--code-font-size:var(--font-size--small--2);--api-font-size:var(--font-size--small);--header-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*4);--header-padding:0.5rem;--sidebar-tree-space-above:1.5rem;--sidebar-caption-space-above:1rem;--sidebar-item-line-height:1rem;--sidebar-item-spacing-vertical:0.5rem;--sidebar-item-spacing-horizontal:1rem;--sidebar-item-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*2);--sidebar-expander-width:var(--sidebar-item-height);--sidebar-search-space-above:0.5rem;--sidebar-search-input-spacing-vertical:0.5rem;--sidebar-search-input-spacing-horizontal:0.5rem;--sidebar-search-input-height:1rem;--sidebar-search-icon-size:var(--sidebar-search-input-height);--toc-title-padding:0.25rem 0;--toc-spacing-vertical:1.5rem;--toc-spacing-horizontal:1.5rem;--toc-item-spacing-vertical:0.4rem;--toc-item-spacing-horizontal:1rem;--icon-search:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path d="M0 0h24v24H0z" stroke="none"/><circle cx="10" cy="10" r="7"/><path d="m21 21-6-6"/></svg>');--icon-pencil:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>');--icon-abstract:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 5h16v2H4V5m0 4h16v2H4V9m0 4h16v2H4v-2m0 4h10v2H4v-2z"/></svg>');--icon-info:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z"/></svg>');--icon-flame:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17.55 11.2c-.23-.3-.5-.56-.76-.82-.65-.6-1.4-1.03-2.03-1.66C13.3 7.26 13 4.85 13.91 3c-.91.23-1.75.75-2.45 1.32-2.54 2.08-3.54 5.75-2.34 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.22.1-.46.04-.64-.12a.83.83 0 0 1-.15-.17c-1.1-1.43-1.28-3.48-.53-5.12C5.89 10 5 12.3 5.14 14.47c.04.5.1 1 .27 1.5.14.6.4 1.2.72 1.73 1.04 1.73 2.87 2.97 4.84 3.22 2.1.27 4.35-.12 5.96-1.6 1.8-1.66 2.45-4.32 1.5-6.6l-.13-.26c-.2-.46-.47-.87-.8-1.25l.05-.01m-3.1 6.3c-.28.24-.73.5-1.08.6-1.1.4-2.2-.16-2.87-.82 1.19-.28 1.89-1.16 2.09-2.05.17-.8-.14-1.46-.27-2.23-.12-.74-.1-1.37.18-2.06.17.38.37.76.6 1.06.76 1 1.95 1.44 2.2 2.8.04.14.06.28.06.43.03.82-.32 1.72-.92 2.27h.01z"/></svg>');--icon-question:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m15.07 11.25-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 0 0-2-2 2 2 0 0 0-2 2H8a4 4 0 0 1 4-4 4 4 0 0 1 4 4 3.2 3.2 0 0 1-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10c0-5.53-4.5-10-10-10z"/></svg>');--icon-warning:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 14h-2v-4h2m0 8h-2v-2h2M1 21h22L12 2 1 21z"/></svg>');--icon-failure:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2c5.53 0 10 4.47 10 10s-4.47 10-10 10S2 17.53 2 12 6.47 2 12 2m3.59 5L12 10.59 8.41 7 7 8.41 10.59 12 7 15.59 8.41 17 12 13.41 15.59 17 17 15.59 13.41 12 17 8.41 15.59 7z"/></svg>');--icon-spark:url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m11.5 20 4.86-9.73H13V4l-5 9.73h3.5V20M12 2c2.75 0 5.1 1 7.05 2.95C21 6.9 22 9.25 22 12s-1 5.1-2.95 7.05C17.1 21 14.75 22 12 22s-5.1-1-7.05-2.95C3 17.1 2 14.75 2 12s1-5.1 2.95-7.05C6.9 3 9.25 2 12 2z"/></svg>');--color-admonition-title--caution:#ff9100;--color-admonition-title-background--caution:rgba(255,145,0,.2);--color-admonition-title--warning:#ff9100;--color-admonition-title-background--warning:rgba(255,145,0,.2);--color-admonition-title--danger:#ff5252;--color-admonition-title-background--danger:rgba(255,82,82,.2);--color-admonition-title--attention:#ff5252;--color-admonition-title-background--attention:rgba(255,82,82,.2);--color-admonition-title--error:#ff5252;--color-admonition-title-background--error:rgba(255,82,82,.2);--color-admonition-title--hint:#00c852;--color-admonition-title-background--hint:rgba(0,200,82,.2);--color-admonition-title--tip:#00c852;--color-admonition-title-background--tip:rgba(0,200,82,.2);--color-admonition-title--important:#00bfa5;--color-admonition-title-background--important:rgba(0,191,165,.2);--color-admonition-title--note:#00b0ff;--color-admonition-title-background--note:rgba(0,176,255,.2);--color-admonition-title--seealso:#448aff;--color-admonition-title-background--seealso:rgba(68,138,255,.2);--color-admonition-title--admonition-todo:grey;--color-admonition-title-background--admonition-todo:hsla(0,0%,50%,.2);--color-admonition-title:#651fff;--color-admonition-title-background:rgba(101,31,255,.2);--icon-admonition-default:var(--icon-abstract);--color-topic-title:#14b8a6;--color-topic-title-background:rgba(20,184,166,.2);--icon-topic-default:var(--icon-pencil);--color-problematic:#b30000;--color-foreground-primary:#000;--color-foreground-secondary:#5a5c63;--color-foreground-muted:#646776;--color-foreground-border:#878787;--color-background-primary:#fff;--color-background-secondary:#f8f9fb;--color-background-hover:#efeff4;--color-background-hover--transparent:#efeff400;--color-background-border:#eeebee;--color-background-item:#ccc;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2962ff;--color-brand-content:#2a5adf;--color-api-background:var(--color-background-hover--transparent);--color-api-background-hover:var(--color-background-hover);--color-api-overall:var(--color-foreground-secondary);--color-api-name:var(--color-problematic);--color-api-pre-name:var(--color-problematic);--color-api-paren:var(--color-foreground-secondary);--color-api-keyword:var(--color-foreground-primary);--color-highlight-on-target:#ffc;--color-inline-code-background:var(--color-background-secondary);--color-highlighted-background:#def;--color-highlighted-text:var(--color-foreground-primary);--color-guilabel-background:#ddeeff80;--color-guilabel-border:#bedaf580;--color-guilabel-text:var(--color-foreground-primary);--color-admonition-background:transparent;--color-table-header-background:var(--color-background-secondary);--color-table-border:var(--color-background-border);--color-card-border:var(--color-background-secondary);--color-card-background:transparent;--color-card-marginals-background:var(--color-background-secondary);--color-header-background:var(--color-background-primary);--color-header-border:var(--color-background-border);--color-header-text:var(--color-foreground-primary);--color-sidebar-background:var(--color-background-secondary);--color-sidebar-background-border:var(--color-background-border);--color-sidebar-brand-text:var(--color-foreground-primary);--color-sidebar-caption-text:var(--color-foreground-muted);--color-sidebar-link-text:var(--color-foreground-secondary);--color-sidebar-link-text--top-level:var(--color-brand-primary);--color-sidebar-item-background:var(--color-sidebar-background);--color-sidebar-item-background--current:var( --color-sidebar-item-background );--color-sidebar-item-background--hover:linear-gradient(90deg,var(--color-background-hover--transparent) 0%,var(--color-background-hover) var(--sidebar-item-spacing-horizontal),var(--color-background-hover) 100%);--color-sidebar-item-expander-background:transparent;--color-sidebar-item-expander-background--hover:var( --color-background-hover );--color-sidebar-search-text:var(--color-foreground-primary);--color-sidebar-search-background:var(--color-background-secondary);--color-sidebar-search-background--focus:var(--color-background-primary);--color-sidebar-search-border:var(--color-background-border);--color-sidebar-search-icon:var(--color-foreground-muted);--color-toc-background:var(--color-background-primary);--color-toc-title-text:var(--color-foreground-muted);--color-toc-item-text:var(--color-foreground-secondary);--color-toc-item-text--hover:var(--color-foreground-primary);--color-toc-item-text--active:var(--color-brand-primary);--color-content-foreground:var(--color-foreground-primary);--color-content-background:transparent;--color-link:var(--color-brand-content);--color-link--hover:var(--color-brand-content);--color-link-underline:var(--color-background-border);--color-link-underline--hover:var(--color-foreground-border)}.only-light{display:block!important}html body .only-dark{display:none!important}@media not print{body[data-theme=dark]{--color-problematic:#ee5151;--color-foreground-primary:#ffffffcc;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2b8cee;--color-brand-content:#368ce2;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body[data-theme=dark] .only-light{display:none!important}body[data-theme=dark] .only-dark{display:block!important}@media(prefers-color-scheme:dark){body:not([data-theme=light]){--color-problematic:#ee5151;--color-foreground-primary:#ffffffcc;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2b8cee;--color-brand-content:#368ce2;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body:not([data-theme=light]) .only-light{display:none!important}body:not([data-theme=light]) .only-dark{display:block!important}}}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto,body[data-theme=dark] .theme-toggle svg.theme-icon-when-dark,body[data-theme=light] .theme-toggle svg.theme-icon-when-light{display:block}body{font-family:var(--font-stack)}code,kbd,pre,samp{font-family:var(--font-stack--monospace)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}article{line-height:1.5}h1,h2,h3,h4,h5,h6{border-radius:.5rem;font-weight:700;line-height:1.25;margin:.5rem -.5rem;padding-left:.5rem;padding-right:.5rem}h1+p,h2+p,h3+p,h4+p,h5+p,h6+p{margin-top:0}h1{font-size:2.5em;margin-bottom:1rem}h1,h2{margin-top:1.75rem}h2{font-size:2em}h3{font-size:1.5em}h4{font-size:1.25em}h5{font-size:1.125em}h6{font-size:1em}small{font-size:80%;opacity:75%}p{margin-bottom:.75rem;margin-top:.5rem}hr.docutils{background-color:var(--color-background-border);border:0;height:1px;margin:2rem 0;padding:0}.centered{text-align:center}a{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}a:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link{color:inherit}a.muted-link:hover{color:var(--color-link);text-decoration-color:var(--color-link-underline--hover)}html{overflow-x:hidden;overflow-y:scroll;scroll-behavior:smooth}.sidebar-scroll,.toc-scroll,article[role=main] *{scrollbar-color:var(--color-foreground-border) transparent;scrollbar-width:thin}.sidebar-scroll::-webkit-scrollbar,.toc-scroll::-webkit-scrollbar,article[role=main] ::-webkit-scrollbar{height:.25rem;width:.25rem}.sidebar-scroll::-webkit-scrollbar-thumb,.toc-scroll::-webkit-scrollbar-thumb,article[role=main] ::-webkit-scrollbar-thumb{background-color:var(--color-foreground-border);border-radius:.125rem}body,html{background:var(--color-background-primary);color:var(--color-foreground-primary);height:100%}article{background:var(--color-content-background);color:var(--color-content-foreground);overflow-wrap:break-word}.page{display:flex;min-height:100%}.mobile-header{background-color:var(--color-header-background);border-bottom:1px solid var(--color-header-border);color:var(--color-header-text);display:none;height:var(--header-height);width:100%;z-index:10}.mobile-header.scrolled{border-bottom:none;box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2)}.mobile-header .header-center a{color:var(--color-header-text);text-decoration:none}.main{display:flex;flex:1}.sidebar-drawer{background:var(--color-sidebar-background);border-right:1px solid var(--color-sidebar-background-border);box-sizing:border-box;display:flex;justify-content:flex-end;min-width:15em;width:calc(50% - 26em)}.sidebar-container,.toc-drawer{box-sizing:border-box;width:15em}.toc-drawer{background:var(--color-toc-background);padding-right:1rem}.sidebar-sticky,.toc-sticky{display:flex;flex-direction:column;height:min(100%,100vh);height:100vh;position:sticky;top:0}.sidebar-scroll,.toc-scroll{flex-grow:1;flex-shrink:1;overflow:auto;scroll-behavior:smooth}.content{display:flex;flex-direction:column;justify-content:space-between;padding:0 3em;width:46em}.icon{display:inline-block;height:1rem;width:1rem}.icon svg{height:100%;width:100%}.announcement{align-items:center;background-color:var(--color-announcement-background);color:var(--color-announcement-text);display:flex;height:var(--header-height);overflow-x:auto}.announcement+.page{min-height:calc(100% - var(--header-height))}.announcement-content{box-sizing:border-box;min-width:100%;padding:.5rem;text-align:center;white-space:nowrap}.announcement-content a{color:var(--color-announcement-text);text-decoration-color:var(--color-announcement-text)}.announcement-content a:hover{color:var(--color-announcement-text);text-decoration-color:var(--color-link--hover)}.no-js .theme-toggle-container{display:none}.theme-toggle-container{vertical-align:middle}.theme-toggle{background:transparent;border:none;cursor:pointer;padding:0}.theme-toggle svg{color:var(--color-foreground-primary);display:none;height:1rem;vertical-align:middle;width:1rem}.theme-toggle-header{float:left;padding:1rem .5rem}.nav-overlay-icon,.toc-overlay-icon{cursor:pointer;display:none}.nav-overlay-icon .icon,.toc-overlay-icon .icon{color:var(--color-foreground-secondary);height:1rem;width:1rem}.nav-overlay-icon,.toc-header-icon{align-items:center;justify-content:center}.toc-content-icon{height:1.5rem;width:1.5rem}.content-icon-container{display:flex;float:right;gap:.5rem;margin-bottom:1rem;margin-left:1rem;margin-top:1.5rem}.content-icon-container .edit-this-page svg{color:inherit;height:1rem;width:1rem}.sidebar-toggle{display:none;position:absolute}.sidebar-toggle[name=__toc]{left:20px}.sidebar-toggle:checked{left:40px}.overlay{background-color:rgba(0,0,0,.54);height:0;opacity:0;position:fixed;top:0;transition:width 0ms,height 0ms,opacity .25s ease-out;width:0}.sidebar-overlay{z-index:20}.toc-overlay{z-index:40}.sidebar-drawer{transition:left .25s ease-in-out;z-index:30}.toc-drawer{transition:right .25s ease-in-out;z-index:50}#__navigation:checked~.sidebar-overlay{height:100%;opacity:1;width:100%}#__navigation:checked~.page .sidebar-drawer{left:0;top:0}#__toc:checked~.toc-overlay{height:100%;opacity:1;width:100%}#__toc:checked~.page .toc-drawer{right:0;top:0}.back-to-top{background:var(--color-background-primary);border-radius:1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 1px 0 hsla(220,9%,46%,.502);display:none;font-size:.8125rem;left:0;margin-left:50%;padding:.5rem .75rem .5rem .5rem;position:fixed;text-decoration:none;top:1rem;transform:translateX(-50%);z-index:10}.back-to-top svg{fill:currentColor;display:inline-block;height:1rem;width:1rem}.back-to-top span{margin-left:.25rem}.show-back-to-top .back-to-top{align-items:center;display:flex}@media(min-width:97em){html{font-size:110%}}@media(max-width:82em){.toc-content-icon{display:flex}.toc-drawer{border-left:1px solid var(--color-background-muted);height:100vh;position:fixed;right:-15em;top:0}.toc-tree{border-left:none;font-size:var(--toc-font-size--mobile)}.sidebar-drawer{width:calc(50% - 18.5em)}}@media(max-width:67em){.nav-overlay-icon{display:flex}.sidebar-drawer{height:100vh;left:-15em;position:fixed;top:0;width:15em}.toc-header-icon{display:flex}.theme-toggle-content,.toc-content-icon{display:none}.theme-toggle-header{display:block}.mobile-header{align-items:center;display:flex;justify-content:space-between;position:sticky;top:0}.mobile-header .header-left,.mobile-header .header-right{display:flex;height:var(--header-height);padding:0 var(--header-padding)}.mobile-header .header-left label,.mobile-header .header-right label{height:100%;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:100%}.nav-overlay-icon .icon,.theme-toggle svg{height:1.25rem;width:1.25rem}:target{scroll-margin-top:var(--header-height)}.back-to-top{top:calc(var(--header-height) + .5rem)}.page{flex-direction:column;justify-content:center}.content{margin-left:auto;margin-right:auto}}@media(max-width:52em){.content{overflow-x:auto;width:100%}}@media(max-width:46em){.content{padding:0 1em}article aside.sidebar{float:none;margin:1rem 0;width:100%}}.admonition,.topic{background:var(--color-admonition-background);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);font-size:var(--admonition-font-size);margin:1rem auto;overflow:hidden;padding:0 .5rem .5rem;page-break-inside:avoid}.admonition>:nth-child(2),.topic>:nth-child(2){margin-top:0}.admonition>:last-child,.topic>:last-child{margin-bottom:0}.admonition p.admonition-title,p.topic-title{font-size:var(--admonition-title-font-size);font-weight:500;line-height:1.3;margin:0 -.5rem .5rem;padding:.4rem .5rem .4rem 2rem;position:relative}.admonition p.admonition-title:before,p.topic-title:before{content:"";height:1rem;left:.5rem;position:absolute;width:1rem}p.admonition-title{background-color:var(--color-admonition-title-background)}p.admonition-title:before{background-color:var(--color-admonition-title);-webkit-mask-image:var(--icon-admonition-default);mask-image:var(--icon-admonition-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}p.topic-title{background-color:var(--color-topic-title-background)}p.topic-title:before{background-color:var(--color-topic-title);-webkit-mask-image:var(--icon-topic-default);mask-image:var(--icon-topic-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.admonition{border-left:.2rem solid var(--color-admonition-title)}.admonition.caution{border-left-color:var(--color-admonition-title--caution)}.admonition.caution>.admonition-title{background-color:var(--color-admonition-title-background--caution)}.admonition.caution>.admonition-title:before{background-color:var(--color-admonition-title--caution);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.warning{border-left-color:var(--color-admonition-title--warning)}.admonition.warning>.admonition-title{background-color:var(--color-admonition-title-background--warning)}.admonition.warning>.admonition-title:before{background-color:var(--color-admonition-title--warning);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.danger{border-left-color:var(--color-admonition-title--danger)}.admonition.danger>.admonition-title{background-color:var(--color-admonition-title-background--danger)}.admonition.danger>.admonition-title:before{background-color:var(--color-admonition-title--danger);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.attention{border-left-color:var(--color-admonition-title--attention)}.admonition.attention>.admonition-title{background-color:var(--color-admonition-title-background--attention)}.admonition.attention>.admonition-title:before{background-color:var(--color-admonition-title--attention);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.error{border-left-color:var(--color-admonition-title--error)}.admonition.error>.admonition-title{background-color:var(--color-admonition-title-background--error)}.admonition.error>.admonition-title:before{background-color:var(--color-admonition-title--error);-webkit-mask-image:var(--icon-failure);mask-image:var(--icon-failure)}.admonition.hint{border-left-color:var(--color-admonition-title--hint)}.admonition.hint>.admonition-title{background-color:var(--color-admonition-title-background--hint)}.admonition.hint>.admonition-title:before{background-color:var(--color-admonition-title--hint);-webkit-mask-image:var(--icon-question);mask-image:var(--icon-question)}.admonition.tip{border-left-color:var(--color-admonition-title--tip)}.admonition.tip>.admonition-title{background-color:var(--color-admonition-title-background--tip)}.admonition.tip>.admonition-title:before{background-color:var(--color-admonition-title--tip);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.important{border-left-color:var(--color-admonition-title--important)}.admonition.important>.admonition-title{background-color:var(--color-admonition-title-background--important)}.admonition.important>.admonition-title:before{background-color:var(--color-admonition-title--important);-webkit-mask-image:var(--icon-flame);mask-image:var(--icon-flame)}.admonition.note{border-left-color:var(--color-admonition-title--note)}.admonition.note>.admonition-title{background-color:var(--color-admonition-title-background--note)}.admonition.note>.admonition-title:before{background-color:var(--color-admonition-title--note);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition.seealso{border-left-color:var(--color-admonition-title--seealso)}.admonition.seealso>.admonition-title{background-color:var(--color-admonition-title-background--seealso)}.admonition.seealso>.admonition-title:before{background-color:var(--color-admonition-title--seealso);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.admonition-todo{border-left-color:var(--color-admonition-title--admonition-todo)}.admonition.admonition-todo>.admonition-title{background-color:var(--color-admonition-title-background--admonition-todo)}.admonition.admonition-todo>.admonition-title:before{background-color:var(--color-admonition-title--admonition-todo);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition-todo>.admonition-title{text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd{margin-left:2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:first-child{margin-top:.125rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list,dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:last-child{margin-bottom:.75rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list>dt{font-size:var(--font-size--small);text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd:empty{margin-bottom:.5rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul{margin-left:-1.2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p:nth-child(2){margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p+p:last-child:empty{margin-bottom:0;margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{color:var(--color-api-overall)}.sig:not(.sig-inline){background:var(--color-api-background);border-radius:.25rem;font-family:var(--font-stack--monospace);font-size:var(--api-font-size);font-weight:700;margin-left:-.25rem;margin-right:-.25rem;padding:.25rem .5rem .25rem 3em;text-indent:-2.5em;transition:background .1s ease-out}.sig:not(.sig-inline):hover{background:var(--color-api-background-hover)}.sig:not(.sig-inline) a.reference .viewcode-link{font-weight:400;width:3.5rem}em.property{font-style:normal}em.property:first-child{color:var(--color-api-keyword)}.sig-name{color:var(--color-api-name)}.sig-prename{color:var(--color-api-pre-name);font-weight:400}.sig-paren{color:var(--color-api-paren)}.sig-param{font-style:normal}.versionmodified{font-style:italic}div.deprecated p,div.versionadded p,div.versionchanged p{margin-bottom:.125rem;margin-top:.125rem}.viewcode-back,.viewcode-link{float:right;text-align:right}.line-block{margin-bottom:.75rem;margin-top:.5rem}.line-block .line-block{margin-bottom:0;margin-top:0;padding-left:1rem}.code-block-caption,article p.caption,table>caption{font-size:var(--font-size--small);text-align:center}.toctree-wrapper.compound .caption,.toctree-wrapper.compound :not(.caption)>.caption-text{font-size:var(--font-size--small);margin-bottom:0;text-align:initial;text-transform:uppercase}.toctree-wrapper.compound>ul{margin-bottom:0;margin-top:0}.sig-inline,code.literal{background:var(--color-inline-code-background);border-radius:.2em;font-size:var(--font-size--small--2);padding:.1em .2em}pre.literal-block .sig-inline,pre.literal-block code.literal{font-size:inherit;padding:0}p .sig-inline,p code.literal{border:1px solid var(--color-background-border)}.sig-inline{font-family:var(--font-stack--monospace)}div[class*=" highlight-"],div[class^=highlight-]{display:flex;margin:1em 0}div[class*=" highlight-"] .table-wrapper,div[class^=highlight-] .table-wrapper,pre{margin:0;padding:0}pre{overflow:auto}article[role=main] .highlight pre{line-height:1.5}.highlight pre,pre.literal-block{font-size:var(--code-font-size);padding:.625rem .875rem}pre.literal-block{background-color:var(--color-code-background);border-radius:.2rem;color:var(--color-code-foreground);margin-bottom:1rem;margin-top:1rem}.highlight{border-radius:.2rem;width:100%}.highlight .gp,.highlight span.linenos{pointer-events:none;-webkit-user-select:none;-moz-user-select:none;user-select:none}.highlight .hll{display:block;margin-left:-.875rem;margin-right:-.875rem;padding-left:.875rem;padding-right:.875rem}.code-block-caption{background-color:var(--color-code-background);border-bottom:1px solid;border-radius:.25rem;border-bottom-left-radius:0;border-bottom-right-radius:0;border-color:var(--color-background-border);color:var(--color-code-foreground);display:flex;font-weight:300;padding:.625rem .875rem}.code-block-caption+div[class]{margin-top:0}.code-block-caption+div[class] pre{border-top-left-radius:0;border-top-right-radius:0}.highlighttable{display:block;width:100%}.highlighttable tbody{display:block}.highlighttable tr{display:flex}.highlighttable td.linenos{background-color:var(--color-code-background);border-bottom-left-radius:.2rem;border-top-left-radius:.2rem;color:var(--color-code-foreground);padding:.625rem 0 .625rem .875rem}.highlighttable .linenodiv{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;font-size:var(--code-font-size);padding-right:.875rem}.highlighttable td.code{display:block;flex:1;overflow:hidden;padding:0}.highlighttable td.code .highlight{border-bottom-left-radius:0;border-top-left-radius:0}.highlight span.linenos{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;display:inline-block;margin-right:.875rem;padding-left:0;padding-right:.875rem}.footnote-reference{font-size:var(--font-size--small--4);vertical-align:super}dl.footnote.brackets{color:var(--color-foreground-secondary);display:grid;font-size:var(--font-size--small);grid-template-columns:max-content auto}dl.footnote.brackets dt{margin:0}dl.footnote.brackets dt>.fn-backref{margin-left:.25rem}dl.footnote.brackets dt:after{content:":"}dl.footnote.brackets dt .brackets:before{content:"["}dl.footnote.brackets dt .brackets:after{content:"]"}dl.footnote.brackets dd{margin:0;padding:0 1rem}aside.footnote{color:var(--color-foreground-secondary);font-size:var(--font-size--small)}aside.footnote>span,div.citation>span{float:left;font-weight:500;padding-right:.25rem}aside.footnote>p,div.citation>p{margin-left:2rem}img{box-sizing:border-box;height:auto;max-width:100%}article .figure,article figure{border-radius:.2rem;margin:0}article .figure :last-child,article figure :last-child{margin-bottom:0}article .align-left{clear:left;float:left;margin:0 1rem 1rem}article .align-right{clear:right;float:right;margin:0 1rem 1rem}article .align-center,article .align-default{display:block;margin-left:auto;margin-right:auto;text-align:center}article table.align-default{display:table;text-align:initial}.domainindex-jumpbox,.genindex-jumpbox{border-bottom:1px solid var(--color-background-border);border-top:1px solid var(--color-background-border);padding:.25rem}.domainindex-section h2,.genindex-section h2{margin-bottom:.5rem;margin-top:.75rem}.domainindex-section ul,.genindex-section ul{margin-bottom:0;margin-top:0}ol,ul{margin-bottom:1rem;margin-top:1rem;padding-left:1.2rem}ol li>p:first-child,ul li>p:first-child{margin-bottom:.25rem;margin-top:.25rem}ol li>p:last-child,ul li>p:last-child{margin-top:.25rem}ol li>ol,ol li>ul,ul li>ol,ul li>ul{margin-bottom:.5rem;margin-top:.5rem}ol.arabic{list-style:decimal}ol.loweralpha{list-style:lower-alpha}ol.upperalpha{list-style:upper-alpha}ol.lowerroman{list-style:lower-roman}ol.upperroman{list-style:upper-roman}.simple li>ol,.simple li>ul,.toctree-wrapper li>ol,.toctree-wrapper li>ul{margin-bottom:0;margin-top:0}.field-list dt,.option-list dt,dl.footnote dt,dl.glossary dt,dl.simple dt,dl:not([class]) dt{font-weight:500;margin-top:.25rem}.field-list dt+dt,.option-list dt+dt,dl.footnote dt+dt,dl.glossary dt+dt,dl.simple dt+dt,dl:not([class]) dt+dt{margin-top:0}.field-list dt .classifier:before,.option-list dt .classifier:before,dl.footnote dt .classifier:before,dl.glossary dt .classifier:before,dl.simple dt .classifier:before,dl:not([class]) dt .classifier:before{content:":";margin-left:.2rem;margin-right:.2rem}.field-list dd ul,.field-list dd>p:first-child,.option-list dd ul,.option-list dd>p:first-child,dl.footnote dd ul,dl.footnote dd>p:first-child,dl.glossary dd ul,dl.glossary dd>p:first-child,dl.simple dd ul,dl.simple dd>p:first-child,dl:not([class]) dd ul,dl:not([class]) dd>p:first-child{margin-top:.125rem}.field-list dd ul,.option-list dd ul,dl.footnote dd ul,dl.glossary dd ul,dl.simple dd ul,dl:not([class]) dd ul{margin-bottom:.125rem}.math-wrapper{overflow-x:auto;width:100%}div.math{position:relative;text-align:center}div.math .headerlink,div.math:focus .headerlink{display:none}div.math:hover .headerlink{display:inline-block}div.math span.eqno{position:absolute;right:.5rem;top:50%;transform:translateY(-50%);z-index:1}abbr[title]{cursor:help}.problematic{color:var(--color-problematic)}kbd:not(.compound){background-color:var(--color-background-secondary);border:1px solid var(--color-foreground-border);border-radius:.2rem;box-shadow:0 .0625rem 0 rgba(0,0,0,.2),inset 0 0 0 .125rem var(--color-background-primary);color:var(--color-foreground-primary);display:inline-block;font-size:var(--font-size--small--3);margin:0 .2rem;padding:0 .2rem;vertical-align:text-bottom}blockquote{background:var(--color-background-secondary);border-left:4px solid var(--color-background-border);margin-left:0;margin-right:0;padding:.5rem 1rem}blockquote .attribution{font-weight:600;text-align:right}blockquote.highlights,blockquote.pull-quote{font-size:1.25em}blockquote.epigraph,blockquote.pull-quote{border-left-width:0;border-radius:.5rem}blockquote.highlights{background:transparent;border-left-width:0}p .reference img{vertical-align:middle}p.rubric{font-size:1.125em;font-weight:700;line-height:1.25}dd p.rubric{font-size:var(--font-size--small);font-weight:inherit;line-height:inherit;text-transform:uppercase}article .sidebar{background-color:var(--color-background-secondary);border:1px solid var(--color-background-border);border-radius:.2rem;clear:right;float:right;margin-left:1rem;margin-right:0;width:30%}article .sidebar>*{padding-left:1rem;padding-right:1rem}article .sidebar>ol,article .sidebar>ul{padding-left:2.2rem}article .sidebar .sidebar-title{border-bottom:1px solid var(--color-background-border);font-weight:500;margin:0;padding:.5rem 1rem}.table-wrapper{margin-bottom:.5rem;margin-top:1rem;overflow-x:auto;padding:.2rem .2rem .75rem;width:100%}table.docutils{border-collapse:collapse;border-radius:.2rem;border-spacing:0;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)}table.docutils th{background:var(--color-table-header-background)}table.docutils td,table.docutils th{border-bottom:1px solid var(--color-table-border);border-left:1px solid var(--color-table-border);border-right:1px solid var(--color-table-border);padding:0 .25rem}table.docutils td p,table.docutils th p{margin:.25rem}table.docutils td:first-child,table.docutils th:first-child{border-left:none}table.docutils td:last-child,table.docutils th:last-child{border-right:none}table.docutils td.text-left,table.docutils th.text-left{text-align:left}table.docutils td.text-right,table.docutils th.text-right{text-align:right}table.docutils td.text-center,table.docutils th.text-center{text-align:center}:target{scroll-margin-top:.5rem}@media(max-width:67em){:target{scroll-margin-top:calc(.5rem + var(--header-height))}section>span:target{scroll-margin-top:calc(.8rem + var(--header-height))}}.headerlink{font-weight:100;-webkit-user-select:none;-moz-user-select:none;user-select:none}.code-block-caption>.headerlink,dl dt>.headerlink,figcaption p>.headerlink,h1>.headerlink,h2>.headerlink,h3>.headerlink,h4>.headerlink,h5>.headerlink,h6>.headerlink,p.caption>.headerlink,table>caption>.headerlink{margin-left:.5rem;visibility:hidden}.code-block-caption:hover>.headerlink,dl dt:hover>.headerlink,figcaption p:hover>.headerlink,h1:hover>.headerlink,h2:hover>.headerlink,h3:hover>.headerlink,h4:hover>.headerlink,h5:hover>.headerlink,h6:hover>.headerlink,p.caption:hover>.headerlink,table>caption:hover>.headerlink{visibility:visible}.code-block-caption>.toc-backref,dl dt>.toc-backref,figcaption p>.toc-backref,h1>.toc-backref,h2>.toc-backref,h3>.toc-backref,h4>.toc-backref,h5>.toc-backref,h6>.toc-backref,p.caption>.toc-backref,table>caption>.toc-backref{color:inherit;text-decoration-line:none}figure:hover>figcaption>p>.headerlink,table:hover>caption>.headerlink{visibility:visible}:target>h1:first-of-type,:target>h2:first-of-type,:target>h3:first-of-type,:target>h4:first-of-type,:target>h5:first-of-type,:target>h6:first-of-type,span:target~h1:first-of-type,span:target~h2:first-of-type,span:target~h3:first-of-type,span:target~h4:first-of-type,span:target~h5:first-of-type,span:target~h6:first-of-type{background-color:var(--color-highlight-on-target)}:target>h1:first-of-type code.literal,:target>h2:first-of-type code.literal,:target>h3:first-of-type code.literal,:target>h4:first-of-type code.literal,:target>h5:first-of-type code.literal,:target>h6:first-of-type code.literal,span:target~h1:first-of-type code.literal,span:target~h2:first-of-type code.literal,span:target~h3:first-of-type code.literal,span:target~h4:first-of-type code.literal,span:target~h5:first-of-type code.literal,span:target~h6:first-of-type code.literal{background-color:transparent}.literal-block-wrapper:target .code-block-caption,.this-will-duplicate-information-and-it-is-still-useful-here li :target,figure:target,table:target>caption{background-color:var(--color-highlight-on-target)}dt:target{background-color:var(--color-highlight-on-target)!important}.footnote-reference:target,.footnote>dt:target+dd{background-color:var(--color-highlight-on-target)}.guilabel{background-color:var(--color-guilabel-background);border:1px solid var(--color-guilabel-border);border-radius:.5em;color:var(--color-guilabel-text);font-size:.9em;padding:0 .3em}footer{display:flex;flex-direction:column;font-size:var(--font-size--small);margin-top:2rem}.bottom-of-page{align-items:center;border-top:1px solid var(--color-background-border);color:var(--color-foreground-secondary);display:flex;justify-content:space-between;line-height:1.5;margin-top:1rem;padding-bottom:1rem;padding-top:1rem}@media(max-width:46em){.bottom-of-page{flex-direction:column-reverse;gap:.25rem;text-align:center}}.bottom-of-page .left-details{font-size:var(--font-size--small)}.bottom-of-page .right-details{display:flex;flex-direction:column;gap:.25rem;text-align:right}.bottom-of-page .icons{display:flex;font-size:1rem;gap:.25rem;justify-content:flex-end}.bottom-of-page .icons a{text-decoration:none}.bottom-of-page .icons img,.bottom-of-page .icons svg{font-size:1.125rem;height:1em;width:1em}.related-pages a{align-items:center;display:flex;text-decoration:none}.related-pages a:hover .page-info .title{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}.related-pages a svg.furo-related-icon,.related-pages a svg.furo-related-icon>use{color:var(--color-foreground-border);flex-shrink:0;height:.75rem;margin:0 .5rem;width:.75rem}.related-pages a.next-page{clear:right;float:right;max-width:50%;text-align:right}.related-pages a.prev-page{clear:left;float:left;max-width:50%}.related-pages a.prev-page svg{transform:rotate(180deg)}.page-info{display:flex;flex-direction:column;overflow-wrap:anywhere}.next-page .page-info{align-items:flex-end}.page-info .context{align-items:center;color:var(--color-foreground-muted);display:flex;font-size:var(--font-size--small);padding-bottom:.1rem;text-decoration:none}ul.search{list-style:none;padding-left:0}ul.search li{border-bottom:1px solid var(--color-background-border);padding:1rem 0}[role=main] .highlighted{background-color:var(--color-highlighted-background);color:var(--color-highlighted-text)}.sidebar-brand{display:flex;flex-direction:column;flex-shrink:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none}.sidebar-brand-text{color:var(--color-sidebar-brand-text);font-size:1.5rem;overflow-wrap:break-word}.sidebar-brand-text,.sidebar-logo-container{margin:var(--sidebar-item-spacing-vertical) 0}.sidebar-logo{display:block;margin:0 auto;max-width:100%}.sidebar-search-container{align-items:center;background:var(--color-sidebar-search-background);display:flex;margin-top:var(--sidebar-search-space-above);position:relative}.sidebar-search-container:focus-within,.sidebar-search-container:hover{background:var(--color-sidebar-search-background--focus)}.sidebar-search-container:before{background-color:var(--color-sidebar-search-icon);content:"";height:var(--sidebar-search-icon-size);left:var(--sidebar-item-spacing-horizontal);-webkit-mask-image:var(--icon-search);mask-image:var(--icon-search);position:absolute;width:var(--sidebar-search-icon-size)}.sidebar-search{background:transparent;border:none;border-bottom:1px solid var(--color-sidebar-search-border);border-top:1px solid var(--color-sidebar-search-border);box-sizing:border-box;color:var(--color-sidebar-search-foreground);padding:var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal) var(--sidebar-search-input-spacing-vertical) calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size));width:100%;z-index:10}.sidebar-search:focus{outline:none}.sidebar-search::-moz-placeholder{font-size:var(--sidebar-search-input-font-size)}.sidebar-search::placeholder{font-size:var(--sidebar-search-input-font-size)}#searchbox .highlight-link{margin:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0;text-align:center}#searchbox .highlight-link a{color:var(--color-sidebar-search-icon);font-size:var(--font-size--small--2)}.sidebar-tree{font-size:var(--sidebar-item-font-size);margin-bottom:var(--sidebar-item-spacing-vertical);margin-top:var(--sidebar-tree-space-above)}.sidebar-tree ul{display:flex;flex-direction:column;list-style:none;margin-bottom:0;margin-top:0;padding:0}.sidebar-tree li{margin:0;position:relative}.sidebar-tree li>ul{margin-left:var(--sidebar-item-spacing-horizontal)}.sidebar-tree .icon,.sidebar-tree .reference{color:var(--color-sidebar-link-text)}.sidebar-tree .reference{box-sizing:border-box;display:inline-block;height:100%;line-height:var(--sidebar-item-line-height);overflow-wrap:anywhere;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none;width:100%}.sidebar-tree .reference:hover{background:var(--color-sidebar-item-background--hover)}.sidebar-tree .reference.external:after{color:var(--color-sidebar-link-text);content:url("data:image/svg+xml;charset=utf-8,%3Csvg width='12' height='12' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' stroke-width='1.5' stroke='%23607D8B' fill='none' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M0 0h24v24H0z' stroke='none'/%3E%3Cpath d='M11 7H6a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-5M10 14 20 4M15 4h5v5'/%3E%3C/svg%3E");margin:0 .25rem;vertical-align:middle}.sidebar-tree .current-page>.reference{font-weight:700}.sidebar-tree label{align-items:center;cursor:pointer;display:flex;height:var(--sidebar-item-height);justify-content:center;position:absolute;right:0;top:0;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:var(--sidebar-expander-width)}.sidebar-tree .caption,.sidebar-tree :not(.caption)>.caption-text{color:var(--color-sidebar-caption-text);font-size:var(--sidebar-caption-font-size);font-weight:700;margin:var(--sidebar-caption-space-above) 0 0 0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-transform:uppercase}.sidebar-tree li.has-children>.reference{padding-right:var(--sidebar-expander-width)}.sidebar-tree .toctree-l1>.reference,.sidebar-tree .toctree-l1>label .icon{color:var(--color-sidebar-link-text--top-level)}.sidebar-tree label{background:var(--color-sidebar-item-expander-background)}.sidebar-tree label:hover{background:var(--color-sidebar-item-expander-background--hover)}.sidebar-tree .current>.reference{background:var(--color-sidebar-item-background--current)}.sidebar-tree .current>.reference:hover{background:var(--color-sidebar-item-background--hover)}.toctree-checkbox{display:none;position:absolute}.toctree-checkbox~ul{display:none}.toctree-checkbox~label .icon svg{transform:rotate(90deg)}.toctree-checkbox:checked~ul{display:block}.toctree-checkbox:checked~label .icon svg{transform:rotate(-90deg)}.toc-title-container{padding:var(--toc-title-padding);padding-top:var(--toc-spacing-vertical)}.toc-title{color:var(--color-toc-title-text);font-size:var(--toc-title-font-size);padding-left:var(--toc-spacing-horizontal);text-transform:uppercase}.no-toc{display:none}.toc-tree-container{padding-bottom:var(--toc-spacing-vertical)}.toc-tree{border-left:1px solid var(--color-background-border);font-size:var(--toc-font-size);line-height:1.3;padding-left:calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal))}.toc-tree>ul>li:first-child{padding-top:0}.toc-tree>ul>li:first-child>ul{padding-left:0}.toc-tree>ul>li:first-child>a{display:none}.toc-tree ul{list-style-type:none;margin-bottom:0;margin-top:0;padding-left:var(--toc-item-spacing-horizontal)}.toc-tree li{padding-top:var(--toc-item-spacing-vertical)}.toc-tree li.scroll-current>.reference{color:var(--color-toc-item-text--active);font-weight:700}.toc-tree .reference{color:var(--color-toc-item-text);overflow-wrap:anywhere;text-decoration:none}.toc-scroll{max-height:100vh;overflow-y:scroll}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here){background:rgba(255,0,0,.25);color:var(--color-problematic)}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here):before{content:"ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling.Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch."}.text-align\:left>p{text-align:left}.text-align\:center>p{text-align:center}.text-align\:right>p{text-align:right} -/*# sourceMappingURL=furo.css.map*/
\ No newline at end of file diff --git a/v7.2.2/_static/styles/furo.css.map b/v7.2.2/_static/styles/furo.css.map deleted file mode 100644 index 1924b333..00000000 --- a/v7.2.2/_static/styles/furo.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"styles/furo.css","mappings":"AAAA,2EAA2E,CAU3E,KAEE,6BAA8B,CAD9B,gBAEF,CASA,KACE,QACF,CAMA,KACE,aACF,CAOA,GACE,aAAc,CACd,cACF,CAUA,GACE,sBAAuB,CACvB,QAAS,CACT,gBACF,CAOA,IACE,+BAAiC,CACjC,aACF,CASA,EACE,4BACF,CAOA,YACE,kBAAmB,CACnB,yBAA0B,CAC1B,gCACF,CAMA,SAEE,kBACF,CAOA,cAGE,+BAAiC,CACjC,aACF,CAeA,QAEE,aAAc,CACd,aAAc,CACd,iBAAkB,CAClB,uBACF,CAEA,IACE,aACF,CAEA,IACE,SACF,CASA,IACE,iBACF,CAUA,sCAKE,mBAAoB,CACpB,cAAe,CACf,gBAAiB,CACjB,QACF,CAOA,aAEE,gBACF,CAOA,cAEE,mBACF,CAMA,gDAIE,yBACF,CAMA,wHAIE,iBAAkB,CAClB,SACF,CAMA,4GAIE,6BACF,CAMA,SACE,0BACF,CASA,OACE,qBAAsB,CACtB,aAAc,CACd,aAAc,CACd,cAAe,CACf,SAAU,CACV,kBACF,CAMA,SACE,uBACF,CAMA,SACE,aACF,CAOA,6BAEE,qBAAsB,CACtB,SACF,CAMA,kFAEE,WACF,CAOA,cACE,4BAA6B,CAC7B,mBACF,CAMA,yCACE,uBACF,CAOA,6BACE,yBAA0B,CAC1B,YACF,CASA,QACE,aACF,CAMA,QACE,iBACF,CAiBA,kBACE,YACF,CCvVA,aAcE,kEACE,uBAOF,WACE,iDAMF,gCACE,wBAEF,qCAEE,uBADA,uBACA,CAEF,SACE,wBAtBA,CCpBJ,iBAOE,6BAEA,mBANA,qBAEA,sBACA,0BAFA,oBAHA,4BAOA,6BANA,mBAOA,CAEF,gBACE,aCPF,KCGE,mHAEA,wGAGA,wBAAyB,CACzB,wBAAyB,CACzB,4BAA6B,CAC7B,yBAA0B,CAC1B,2BAA4B,CAG5B,sDAAuD,CACvD,gDAAiD,CACjD,wDAAyD,CAGzD,0CAA2C,CAC3C,gDAAiD,CACjD,gDAAiD,CAKjD,gCAAiC,CACjC,sCAAuC,CAGvC,2CAA4C,CAG5C,uCAAwC,CChCxC,+FAGA,uBAAwB,CAGxB,iCAAkC,CAClC,kCAAmC,CAEnC,+BAAgC,CAChC,sCAAuC,CACvC,sCAAuC,CACvC,qGAIA,mDAAoD,CAEpD,mCAAoC,CACpC,8CAA+C,CAC/C,gDAAiD,CACjD,kCAAmC,CACnC,6DAA8D,CAG9D,6BAA8B,CAC9B,6BAA8B,CAC9B,+BAAgC,CAChC,kCAAmC,CACnC,kCAAmC,CCPjC,ukBCYA,srCAZF,kaCVA,mLAOA,oTAWA,2UAaA,0CACA,gEACA,0CAGA,gEAUA,yCACA,+DAGA,4CACA,CACA,iEAGA,sGACA,uCACA,4DAGA,sCACA,2DAEA,4CACA,kEACA,oGACA,CAEA,0GACA,+CAGA,+MAOA,+EACA,wCAIA,4DACA,sEACA,kEACA,sEACA,gDAGA,+DACA,0CACA,gEACA,gGACA,CAGA,2DACA,qDAGA,0CACA,8CACA,oDACA,oDL7GF,iCAEA,iEAME,oCKyGA,yDAIA,sCACA,kCACA,sDAGA,0CACA,kEACA,oDAEA,sDAGA,oCACA,oEAIA,CAGA,yDAGA,qDACA,oDAGA,6DAIA,iEAGA,2DAEA,2DL9IE,4DAEA,gEAIF,gEKgGA,gFAIA,oNAOA,qDAEA,gFAIA,4DAIA,oEAMA,yEAIA,6DACA,0DAGA,uDAGA,qDAEA,wDLpII,6DAEA,yDACE,2DAMN,uCAIA,yCACE,8CAGF,sDMjDA,6DAKA,oCAIA,4CACA,kBAGF,sBAMA,2BAME,qCAGA,qCAEA,iCAEA,+BAEA,mCAEA,qCAIA,CACA,gCACA,gDAKA,kCAIA,6BAEA,0CAQA,kCAIF,8BAGE,8BACA,uCAGF,sCAKE,kCAEA,sDAGA,iCACE,CACA,2FAGA,gCACE,CACA,+DCzEJ,wCAEA,sBAEF,yDAEE,mCACA,wDAGA,2GAGA,wIACE,gDAMJ,kCAGE,6BACA,0CAGA,gEACA,8BACA,uCAKA,sCAIA,kCACA,sDACA,iCACA,sCAOA,sDAKE,gGAIE,+CAGN,sBAEE,yCAMA,0BAOA,yLAKA,aACA,MAEF,6BACE,mBAEA,wCAEF,wCAIE,kCAGA,SACA,kCAKA,mBAGA,CAJA,eACA,CAHF,gBAEE,CAWA,mBACA,mBACA,mDAIA,YACA,mBACA,CAEE,kBAMF,OAPE,kBAOF,oCACA,yCAEA,wBAEA,cADA,WACA,GACA,oBACA,CAFA,gBAEA,aAGF,+CAEE,UAJE,wBAEJ,CAFI,SAIF,CACA,2BACA,GAGA,uBACE,CAJF,yBAGA,CACE,iDACA,uCAEA,yDACE,cACA,wDAKN,yDAIE,uBAEF,kBACE,uBAEA,kDAKA,0DAEA,CAHA,oBAIA,0GAWA,aAEA,CAHA,YAGA,4HAKF,+CAGE,sBAEF,WAKE,0CAGA,CANA,qCAGA,CAJA,WAOA,SAIA,0CACE,CALF,qCAIA,CACE,wBAEA,mBAEJ,gBACE,gBAIA,+CAKF,CAIE,kDAEA,CANF,8BAIE,CAEA,YAGA,CAfF,2BACE,CAHA,UAEF,CAYE,UAGA,2CACF,iEAOE,iCACA,8BAGA,wCAIA,wBAMI,0CAKF,CATA,6DAGA,CALF,qBAEE,CASA,YACA,yBAGA,CAEE,cAKN,CAPI,sBAOJ,gCAGE,qBAEA,WACA,aACA,sCAEA,mBACA,6BAGA,uEADA,qBACA,6BAIA,yBACA,qCAEE,UAEA,YACA,sBAEF,8BAGA,CAPE,aACA,WAMF,4BACE,sBACA,WAMJ,uBACE,cAYE,mBAXA,qDAKA,qCAGA,CAEA,YACA,CAHA,2BAEA,CACA,oCAEA,4CACA,uBAIA,sBAEJ,eAFI,cAIF,iBACE,CAHJ,kBAGI,yBAEA,oCAIA,qDAMF,mEAGE,+CAKA,gCAEA,qCAGA,oCAGE,sBACA,CAJF,WAEE,CAFF,eAEE,SAEA,mBACA,qCACE,aACA,CAFF,YADA,qBACA,WAEE,sBACA,kEAEN,cAEE,CAFF,YAEE,iDAKA,uCAIA,2DAKA,kBAEA,CAHA,sBAGA,mBACA,0BAEJ,yBAII,aADA,WACA,CAMF,UAFE,kBAEF,CAJF,gBAEI,CAFJ,iBAIE,6CC9ZF,yBACE,WACA,iBAEA,aAFA,iBAEA,6BAEA,kCACA,mBAKA,gCAGA,CARA,QAEA,CAGA,UALA,qBAEA,qDAGA,CALA,OAQA,4BACE,cAGF,2BACE,gCAEJ,CAHE,UAGF,8CAGE,CAHF,UAGE,wCAGA,qBACA,CAFA,UAEA,6CAGA,yCAIA,sBAHA,UAGA,kCACE,OACA,CADA,KACA,cAQF,0CACE,CAFF,kBACA,CACE,wEACA,CARA,YACA,CAKF,mBAFF,MACE,CAIE,gBAJF,iCAJE,cAGJ,CANI,oBAEA,CAKF,SAIE,2BADA,UACA,kBAGF,sCACA,CAFF,WACE,WACA,mBACE,kDACA,0EACA,uDAKJ,aACE,mDAII,CAJJ,6CAII,4BACA,sCACE,kEACA,+CACE,aACA,WADA,+BACA,uEANN,YACE,mDAEE,mBADF,0CACE,CADF,qBACE,0DACA,YACE,4DACA,sEANN,YACE,8CACA,kBADA,UACA,2CACE,2EACA,cACE,kEACA,mEANN,yBACE,4DACA,sBACE,+EAEE,iEACA,qEANN,sCACE,CAGE,iBAHF,gBAGE,qBACE,CAJJ,uBACA,gDACE,wDACA,6DAHF,2CACA,CADA,gBACA,eACE,CAGE,sBANN,8BACE,CAII,iBAFF,4DACA,WACE,YADF,uCACE,6EACA,2BANN,8CACE,kDACA,0CACE,8BACA,yFACE,sBACA,sFALJ,mEACA,sBACE,kEACA,6EACE,uCACA,kEALJ,qGAEE,kEACA,6EACE,uCACA,kEALJ,8CACA,uDACE,sEACA,2EACE,sCACA,iEALJ,mGACA,qCACE,oDACA,0DACE,6GACA,gDAGR,yDCrEA,sEACE,CACA,6GACE,gEACF,iGAIF,wFACE,qDAGA,mGAEE,2CAEF,4FACE,gCACF,wGACE,8DAEE,6FAIA,iJAKN,6GACE,gDAKF,yDACA,qCAGA,6BACA,kBACA,qDAKA,oCAEA,+DAGA,2CAGE,oDAIA,oEAEE,qBAGJ,wDAEE,uCAEF,kEAGA,8CAEA,uDAKA,oCAEA,yDAEE,gEAKF,+CC5FA,0EAGE,CACA,qDCLJ,+DAIE,sCAIA,kEACE,yBACA,2FAMA,gBACA,yGCbF,mBAOA,2MAIA,4HAYA,0DACE,8GAYF,8HAQE,mBAEA,6HAOF,YAGA,mIAME,eACA,CAFF,YAEE,4FAMJ,8BAEE,uBAYA,sCAEE,CAJF,oBAEA,CARA,wCAEA,CAHA,8BACA,CAFA,eACA,CAGA,wCAEA,CAEA,mDAIE,kCACE,6BACA,4CAKJ,kDAIA,eACE,aAGF,8BACE,uDACA,sCACA,cAEA,+BACA,CAFA,eAEA,wCAEF,YACE,iBACA,mCACA,0DAGF,qBAEE,CAFF,kBAEE,+BAIA,yCAEE,qBADA,gBACA,yBAKF,eACA,CAFF,YACE,CACA,iBACA,qDAEA,mDCvIJ,2FAOE,iCACA,CAEA,eACA,CAHA,kBAEA,CAFA,wBAGA,8BACA,eACE,CAFF,YAEE,0BACA,8CAGA,oBACE,oCAGA,kBACE,8DAEA,iBAEN,UACE,8BAIJ,+CAEE,qDAEF,kDAIE,YAEF,CAFE,YAEF,CCjCE,mFAJA,QACA,UAIE,CADF,iBACE,mCAGA,iDACE,+BAGF,wBAEA,mBAKA,6CAEF,CAHE,mBACA,CAEF,kCAIE,CARA,kBACA,CAFF,eASE,YACA,mBAGF,CAJE,UAIF,wCCjCA,oBDmCE,wBCpCJ,uCACE,8BACA,4CACA,oBAGA,2CCAA,6CAGE,CAPF,uBAIA,CDGA,gDACE,6BCVJ,CAWM,2CAEF,CAJA,kCAEE,CDJF,aCLF,gBDKE,uBCMA,gCAGA,gDAGE,wBAGJ,0BAEA,iBACE,aACF,CADE,UACF,uBACE,aACF,oBACE,YACF,4BACE,6CAMA,CAYF,6DAZE,mCAGE,iCASJ,4BAGE,4DADA,+BACA,CAFA,qBAEA,yBACE,aAEF,wBAHA,SAGA,iHACE,2DAKF,CANA,yCACE,CADF,oCAMA,uSAIA,sGACE,oDChEJ,WAEF,yBACE,QACA,eAEA,gBAEE,uCAGA,CALF,iCAKE,uCAGA,0BACA,CACA,oBACA,iCClBJ,gBACE,KAGF,qBACE,YAGF,CAHE,cAGF,gCAEE,mBACA,iEAEA,oCACA,wCAEA,sBACA,WAEA,CAFA,YAEA,8EAEA,mCAFA,iBAEA,6BAIA,wEAKA,sDAIE,CARF,mDAIA,CAIE,cAEF,8CAIA,oBAFE,iBAEF,8CAGE,eAEF,CAFE,YAEF,OAEE,kBAGJ,CAJI,eACA,CAFF,mBAKF,yCCjDE,oBACA,CAFA,iBAEA,uCAKE,iBACA,qCAGA,mBCZJ,CDWI,gBCXJ,6BAEE,eACA,sBAGA,eAEA,sBACA,oDACA,iGAMA,gBAFE,YAEF,8FAME,iJClBF,YACA,gNAUE,6BAEF,oTAcI,kBACF,gHAIA,qBACE,eACF,qDACE,kBACF,6DACE,4BCxCJ,oBAEF,qCAEI,+CAGF,uBACE,uDAGJ,oBAkBE,mDAhBA,+CAaA,CAbA,oBAaA,0FAEE,CAFF,gGAbA,+BAaA,0BAGA,mQAIA,oNAEE,iBAGJ,CAHI,gBADA,gBAIJ,8CAYI,CAZJ,wCAYI,sVACE,iCAGA,uEAHA,QAGA,qXAKJ,iDAGF,CARM,+CACE,iDAIN,CALI,gBAQN,mHACE,gBAGF,2DACE,0EAOA,0EAKA,6EC/EA,iDACA,gCACA,oDAGA,qBACA,oDCFA,cACA,eAEA,yBAGF,sBAEE,iBACA,sNAWA,iBACE,kBACA,wRAgBA,kBAEA,iOAgBA,uCACE,uEAEA,kBAEF,qUAuBE,iDAIJ,CACA,geCxFF,4BAEE,CAQA,6JACA,iDAIA,sEAGA,mDAOF,iDAGE,4DAIA,8CACA,qDAEE,eAFF,cAEE,oBAEF,uBAFE,kCAGA,eACA,iBACA,mBAIA,mDACA,CAHA,uCAEA,CAJA,0CACA,CAIA,gBAJA,gBACA,oBADA,gBAIA,wBAEJ,gBAGE,6BACA,YAHA,iBAGA,gCACA,iEAEA,6CACA,sDACA,0BADA,wBACA,0BACA,oIAIA,mBAFA,YAEA,qBACA,0CAIE,uBAEF,CAHA,yBACE,CAEF,iDACE,mFAKJ,oCACE,CANE,aAKJ,CACE,qEAIA,YAFA,WAEA,CAHA,aACA,CAEA,gBACE,4BACA,sBADA,aACA,gCAMF,oCACA,yDACA,2CAEA,qBAGE,kBAEA,CACA,mCAIF,CARE,YACA,CAOF,iCAEE,CAPA,oBACA,CAQA,oBACE,uDAEJ,sDAGA,CAHA,cAGA,0BACE,oDAIA,oCACA,4BACA,sBAGA,cAEA,oFAGA,sBAEA,yDACE,CAIA,iBAJA,wBAIA,6CAJA,6CAOA,4BAGJ,CAHI,cAGJ,yCAGA,kBACE,CAIA,iDAEA,CATA,YAEF,CACE,4CAGA,kBAIA,wEAEA,wDAIF,kCAOE,iDACA,CARF,WAIE,sCAGA,CANA,2CACA,CAMA,oEARF,iBACE,CACA,qCAMA,iBAuBE,uBAlBF,YAKA,2DALA,uDAKA,CALA,sBAiBA,4CACE,CALA,gRAIF,YACE,UAEN,uBACE,YACA,mCAOE,+CAGA,8BAGF,+CAGA,4BCjNA,SDiNA,qFCjNA,gDAGA,sCACA,qCACA,sDAIF,CAIE,kDAGA,CAPF,0CAOE,kBAEA,kDAEA,CAHA,eACA,CAFA,YACA,CADA,SAIA,mHAIE,CAGA,6CAFA,oCAeE,CAbF,yBACE,qBAEJ,CAGE,oBACA,CAEA,YAFA,2CACF,CACE,uBAEA,mFAEE,CALJ,oBACE,CAEA,UAEE,gCAGF,sDAEA,yCC7CJ,oCAGA,CD6CE,yXAQE,sCCrDJ,wCAGA,oCACE","sources":["webpack:///./node_modules/normalize.css/normalize.css","webpack:///./src/furo/assets/styles/base/_print.sass","webpack:///./src/furo/assets/styles/base/_screen-readers.sass","webpack:///./src/furo/assets/styles/base/_theme.sass","webpack:///./src/furo/assets/styles/variables/_fonts.scss","webpack:///./src/furo/assets/styles/variables/_spacing.scss","webpack:///./src/furo/assets/styles/variables/_icons.scss","webpack:///./src/furo/assets/styles/variables/_admonitions.scss","webpack:///./src/furo/assets/styles/variables/_colors.scss","webpack:///./src/furo/assets/styles/base/_typography.sass","webpack:///./src/furo/assets/styles/_scaffold.sass","webpack:///./src/furo/assets/styles/content/_admonitions.sass","webpack:///./src/furo/assets/styles/content/_api.sass","webpack:///./src/furo/assets/styles/content/_blocks.sass","webpack:///./src/furo/assets/styles/content/_captions.sass","webpack:///./src/furo/assets/styles/content/_code.sass","webpack:///./src/furo/assets/styles/content/_footnotes.sass","webpack:///./src/furo/assets/styles/content/_images.sass","webpack:///./src/furo/assets/styles/content/_indexes.sass","webpack:///./src/furo/assets/styles/content/_lists.sass","webpack:///./src/furo/assets/styles/content/_math.sass","webpack:///./src/furo/assets/styles/content/_misc.sass","webpack:///./src/furo/assets/styles/content/_rubrics.sass","webpack:///./src/furo/assets/styles/content/_sidebar.sass","webpack:///./src/furo/assets/styles/content/_tables.sass","webpack:///./src/furo/assets/styles/content/_target.sass","webpack:///./src/furo/assets/styles/content/_gui-labels.sass","webpack:///./src/furo/assets/styles/components/_footer.sass","webpack:///./src/furo/assets/styles/components/_sidebar.sass","webpack:///./src/furo/assets/styles/components/_table_of_contents.sass","webpack:///./src/furo/assets/styles/_shame.sass"],"sourcesContent":["/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */\n\n/* Document\n ========================================================================== */\n\n/**\n * 1. Correct the line height in all browsers.\n * 2. Prevent adjustments of font size after orientation changes in iOS.\n */\n\nhtml {\n line-height: 1.15; /* 1 */\n -webkit-text-size-adjust: 100%; /* 2 */\n}\n\n/* Sections\n ========================================================================== */\n\n/**\n * Remove the margin in all browsers.\n */\n\nbody {\n margin: 0;\n}\n\n/**\n * Render the `main` element consistently in IE.\n */\n\nmain {\n display: block;\n}\n\n/**\n * Correct the font size and margin on `h1` elements within `section` and\n * `article` contexts in Chrome, Firefox, and Safari.\n */\n\nh1 {\n font-size: 2em;\n margin: 0.67em 0;\n}\n\n/* Grouping content\n ========================================================================== */\n\n/**\n * 1. Add the correct box sizing in Firefox.\n * 2. Show the overflow in Edge and IE.\n */\n\nhr {\n box-sizing: content-box; /* 1 */\n height: 0; /* 1 */\n overflow: visible; /* 2 */\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\npre {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/* Text-level semantics\n ========================================================================== */\n\n/**\n * Remove the gray background on active links in IE 10.\n */\n\na {\n background-color: transparent;\n}\n\n/**\n * 1. Remove the bottom border in Chrome 57-\n * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.\n */\n\nabbr[title] {\n border-bottom: none; /* 1 */\n text-decoration: underline; /* 2 */\n text-decoration: underline dotted; /* 2 */\n}\n\n/**\n * Add the correct font weight in Chrome, Edge, and Safari.\n */\n\nb,\nstrong {\n font-weight: bolder;\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\ncode,\nkbd,\nsamp {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/**\n * Add the correct font size in all browsers.\n */\n\nsmall {\n font-size: 80%;\n}\n\n/**\n * Prevent `sub` and `sup` elements from affecting the line height in\n * all browsers.\n */\n\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\n\nsub {\n bottom: -0.25em;\n}\n\nsup {\n top: -0.5em;\n}\n\n/* Embedded content\n ========================================================================== */\n\n/**\n * Remove the border on images inside links in IE 10.\n */\n\nimg {\n border-style: none;\n}\n\n/* Forms\n ========================================================================== */\n\n/**\n * 1. Change the font styles in all browsers.\n * 2. Remove the margin in Firefox and Safari.\n */\n\nbutton,\ninput,\noptgroup,\nselect,\ntextarea {\n font-family: inherit; /* 1 */\n font-size: 100%; /* 1 */\n line-height: 1.15; /* 1 */\n margin: 0; /* 2 */\n}\n\n/**\n * Show the overflow in IE.\n * 1. Show the overflow in Edge.\n */\n\nbutton,\ninput { /* 1 */\n overflow: visible;\n}\n\n/**\n * Remove the inheritance of text transform in Edge, Firefox, and IE.\n * 1. Remove the inheritance of text transform in Firefox.\n */\n\nbutton,\nselect { /* 1 */\n text-transform: none;\n}\n\n/**\n * Correct the inability to style clickable types in iOS and Safari.\n */\n\nbutton,\n[type=\"button\"],\n[type=\"reset\"],\n[type=\"submit\"] {\n -webkit-appearance: button;\n}\n\n/**\n * Remove the inner border and padding in Firefox.\n */\n\nbutton::-moz-focus-inner,\n[type=\"button\"]::-moz-focus-inner,\n[type=\"reset\"]::-moz-focus-inner,\n[type=\"submit\"]::-moz-focus-inner {\n border-style: none;\n padding: 0;\n}\n\n/**\n * Restore the focus styles unset by the previous rule.\n */\n\nbutton:-moz-focusring,\n[type=\"button\"]:-moz-focusring,\n[type=\"reset\"]:-moz-focusring,\n[type=\"submit\"]:-moz-focusring {\n outline: 1px dotted ButtonText;\n}\n\n/**\n * Correct the padding in Firefox.\n */\n\nfieldset {\n padding: 0.35em 0.75em 0.625em;\n}\n\n/**\n * 1. Correct the text wrapping in Edge and IE.\n * 2. Correct the color inheritance from `fieldset` elements in IE.\n * 3. Remove the padding so developers are not caught out when they zero out\n * `fieldset` elements in all browsers.\n */\n\nlegend {\n box-sizing: border-box; /* 1 */\n color: inherit; /* 2 */\n display: table; /* 1 */\n max-width: 100%; /* 1 */\n padding: 0; /* 3 */\n white-space: normal; /* 1 */\n}\n\n/**\n * Add the correct vertical alignment in Chrome, Firefox, and Opera.\n */\n\nprogress {\n vertical-align: baseline;\n}\n\n/**\n * Remove the default vertical scrollbar in IE 10+.\n */\n\ntextarea {\n overflow: auto;\n}\n\n/**\n * 1. Add the correct box sizing in IE 10.\n * 2. Remove the padding in IE 10.\n */\n\n[type=\"checkbox\"],\n[type=\"radio\"] {\n box-sizing: border-box; /* 1 */\n padding: 0; /* 2 */\n}\n\n/**\n * Correct the cursor style of increment and decrement buttons in Chrome.\n */\n\n[type=\"number\"]::-webkit-inner-spin-button,\n[type=\"number\"]::-webkit-outer-spin-button {\n height: auto;\n}\n\n/**\n * 1. Correct the odd appearance in Chrome and Safari.\n * 2. Correct the outline style in Safari.\n */\n\n[type=\"search\"] {\n -webkit-appearance: textfield; /* 1 */\n outline-offset: -2px; /* 2 */\n}\n\n/**\n * Remove the inner padding in Chrome and Safari on macOS.\n */\n\n[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\n\n/**\n * 1. Correct the inability to style clickable types in iOS and Safari.\n * 2. Change font properties to `inherit` in Safari.\n */\n\n::-webkit-file-upload-button {\n -webkit-appearance: button; /* 1 */\n font: inherit; /* 2 */\n}\n\n/* Interactive\n ========================================================================== */\n\n/*\n * Add the correct display in Edge, IE 10+, and Firefox.\n */\n\ndetails {\n display: block;\n}\n\n/*\n * Add the correct display in all browsers.\n */\n\nsummary {\n display: list-item;\n}\n\n/* Misc\n ========================================================================== */\n\n/**\n * Add the correct display in IE 10+.\n */\n\ntemplate {\n display: none;\n}\n\n/**\n * Add the correct display in IE 10.\n */\n\n[hidden] {\n display: none;\n}\n","// This file contains styles for managing print media.\n\n////////////////////////////////////////////////////////////////////////////////\n// Hide elements not relevant to print media.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Hide icon container.\n .content-icon-container\n display: none !important\n\n // Hide showing header links if hovering over when printing.\n .headerlink\n display: none !important\n\n // Hide mobile header.\n .mobile-header\n display: none !important\n\n // Hide navigation links.\n .related-pages\n display: none !important\n\n////////////////////////////////////////////////////////////////////////////////\n// Tweaks related to decolorization.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Apply a border around code which no longer have a color background.\n .highlight\n border: 0.1pt solid var(--color-foreground-border)\n\n////////////////////////////////////////////////////////////////////////////////\n// Avoid page break in some relevant cases.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n ul, ol, dl, a, table, pre, blockquote\n page-break-inside: avoid\n\n h1, h2, h3, h4, h5, h6, img, figure, caption\n page-break-inside: avoid\n page-break-after: avoid\n\n ul, ol, dl\n page-break-before: avoid\n",".visually-hidden\n position: absolute !important\n width: 1px !important\n height: 1px !important\n padding: 0 !important\n margin: -1px !important\n overflow: hidden !important\n clip: rect(0,0,0,0) !important\n white-space: nowrap !important\n border: 0 !important\n\n:-moz-focusring\n outline: auto\n","// This file serves as the \"skeleton\" of the theming logic.\n//\n// This contains the bulk of the logic for handling dark mode, color scheme\n// toggling and the handling of color-scheme-specific hiding of elements.\n\nbody\n @include fonts\n @include spacing\n @include icons\n @include admonitions\n @include default-admonition(#651fff, \"abstract\")\n @include default-topic(#14B8A6, \"pencil\")\n\n @include colors\n\n.only-light\n display: block !important\nhtml body .only-dark\n display: none !important\n\n// Ignore dark-mode hints if print media.\n@media not print\n // Enable dark-mode, if requested.\n body[data-theme=\"dark\"]\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n // Enable dark mode, unless explicitly told to avoid.\n @media (prefers-color-scheme: dark)\n body:not([data-theme=\"light\"])\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n//\n// Theme toggle presentation\n//\nbody[data-theme=\"auto\"]\n .theme-toggle svg.theme-icon-when-auto\n display: block\n\nbody[data-theme=\"dark\"]\n .theme-toggle svg.theme-icon-when-dark\n display: block\n\nbody[data-theme=\"light\"]\n .theme-toggle svg.theme-icon-when-light\n display: block\n","// Fonts used by this theme.\n//\n// There are basically two things here -- using the system font stack and\n// defining sizes for various elements in %ages. We could have also used `em`\n// but %age is easier to reason about for me.\n\n@mixin fonts {\n // These are adapted from https://systemfontstack.com/\n --font-stack: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial,\n sans-serif, Apple Color Emoji, Segoe UI Emoji;\n --font-stack--monospace: \"SFMono-Regular\", Menlo, Consolas, Monaco,\n Liberation Mono, Lucida Console, monospace;\n\n --font-size--normal: 100%;\n --font-size--small: 87.5%;\n --font-size--small--2: 81.25%;\n --font-size--small--3: 75%;\n --font-size--small--4: 62.5%;\n\n // Sidebar\n --sidebar-caption-font-size: var(--font-size--small--2);\n --sidebar-item-font-size: var(--font-size--small);\n --sidebar-search-input-font-size: var(--font-size--small);\n\n // Table of Contents\n --toc-font-size: var(--font-size--small--3);\n --toc-font-size--mobile: var(--font-size--normal);\n --toc-title-font-size: var(--font-size--small--4);\n\n // Admonitions\n //\n // These aren't defined in terms of %ages, since nesting these is permitted.\n --admonition-font-size: 0.8125rem;\n --admonition-title-font-size: 0.8125rem;\n\n // Code\n --code-font-size: var(--font-size--small--2);\n\n // API\n --api-font-size: var(--font-size--small);\n}\n","// Spacing for various elements on the page\n//\n// If the user wants to tweak things in a certain way, they are permitted to.\n// They also have to deal with the consequences though!\n\n@mixin spacing {\n // Header!\n --header-height: calc(\n var(--sidebar-item-line-height) + 4 * #{var(--sidebar-item-spacing-vertical)}\n );\n --header-padding: 0.5rem;\n\n // Sidebar\n --sidebar-tree-space-above: 1.5rem;\n --sidebar-caption-space-above: 1rem;\n\n --sidebar-item-line-height: 1rem;\n --sidebar-item-spacing-vertical: 0.5rem;\n --sidebar-item-spacing-horizontal: 1rem;\n --sidebar-item-height: calc(\n var(--sidebar-item-line-height) + 2 *#{var(--sidebar-item-spacing-vertical)}\n );\n\n --sidebar-expander-width: var(--sidebar-item-height); // be square\n\n --sidebar-search-space-above: 0.5rem;\n --sidebar-search-input-spacing-vertical: 0.5rem;\n --sidebar-search-input-spacing-horizontal: 0.5rem;\n --sidebar-search-input-height: 1rem;\n --sidebar-search-icon-size: var(--sidebar-search-input-height);\n\n // Table of Contents\n --toc-title-padding: 0.25rem 0;\n --toc-spacing-vertical: 1.5rem;\n --toc-spacing-horizontal: 1.5rem;\n --toc-item-spacing-vertical: 0.4rem;\n --toc-item-spacing-horizontal: 1rem;\n}\n","// Expose theme icons as CSS variables.\n\n$icons: (\n // Adapted from tabler-icons\n // url: https://tablericons.com/\n \"search\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" stroke-width=\"1.5\" stroke=\"currentColor\" fill=\"none\" stroke-linecap=\"round\" stroke-linejoin=\"round\"><path stroke=\"none\" d=\"M0 0h24v24H0z\"/><circle cx=\"10\" cy=\"10\" r=\"7\" /><line x1=\"21\" y1=\"21\" x2=\"15\" y2=\"15\" /></svg>'),\n // Factored out from mkdocs-material on 24-Aug-2020.\n // url: https://squidfunk.github.io/mkdocs-material/reference/admonitions/\n \"pencil\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z\"/></svg>'),\n \"abstract\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M4 5h16v2H4V5m0 4h16v2H4V9m0 4h16v2H4v-2m0 4h10v2H4v-2z\"/></svg>'),\n \"info\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 002 12a10 10 0 0010 10 10 10 0 0010-10A10 10 0 0012 2z\"/></svg>'),\n \"flame\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M17.55 11.2c-.23-.3-.5-.56-.76-.82-.65-.6-1.4-1.03-2.03-1.66C13.3 7.26 13 4.85 13.91 3c-.91.23-1.75.75-2.45 1.32-2.54 2.08-3.54 5.75-2.34 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.22.1-.46.04-.64-.12a.83.83 0 01-.15-.17c-1.1-1.43-1.28-3.48-.53-5.12C5.89 10 5 12.3 5.14 14.47c.04.5.1 1 .27 1.5.14.6.4 1.2.72 1.73 1.04 1.73 2.87 2.97 4.84 3.22 2.1.27 4.35-.12 5.96-1.6 1.8-1.66 2.45-4.32 1.5-6.6l-.13-.26c-.2-.46-.47-.87-.8-1.25l.05-.01m-3.1 6.3c-.28.24-.73.5-1.08.6-1.1.4-2.2-.16-2.87-.82 1.19-.28 1.89-1.16 2.09-2.05.17-.8-.14-1.46-.27-2.23-.12-.74-.1-1.37.18-2.06.17.38.37.76.6 1.06.76 1 1.95 1.44 2.2 2.8.04.14.06.28.06.43.03.82-.32 1.72-.92 2.27h.01z\"/></svg>'),\n \"question\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M15.07 11.25l-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 00-2-2 2 2 0 00-2 2H8a4 4 0 014-4 4 4 0 014 4 3.2 3.2 0 01-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 002 12a10 10 0 0010 10 10 10 0 0010-10c0-5.53-4.5-10-10-10z\"/></svg>'),\n \"warning\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M13 14h-2v-4h2m0 8h-2v-2h2M1 21h22L12 2 1 21z\"/></svg>'),\n \"failure\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M12 2c5.53 0 10 4.47 10 10s-4.47 10-10 10S2 17.53 2 12 6.47 2 12 2m3.59 5L12 10.59 8.41 7 7 8.41 10.59 12 7 15.59 8.41 17 12 13.41 15.59 17 17 15.59 13.41 12 17 8.41 15.59 7z\"/></svg>'),\n \"spark\":\n url('data:image/svg+xml;charset=utf-8,<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\"><path d=\"M11.5 20l4.86-9.73H13V4l-5 9.73h3.5V20M12 2c2.75 0 5.1 1 7.05 2.95C21 6.9 22 9.25 22 12s-1 5.1-2.95 7.05C17.1 21 14.75 22 12 22s-5.1-1-7.05-2.95C3 17.1 2 14.75 2 12s1-5.1 2.95-7.05C6.9 3 9.25 2 12 2z\"/></svg>')\n);\n\n@mixin icons {\n @each $name, $glyph in $icons {\n --icon-#{$name}: #{$glyph};\n }\n}\n","// Admonitions\n\n// Structure of these is:\n// admonition-class: color \"icon-name\";\n//\n// The colors are translated into CSS variables below. The icons are\n// used directly in the main declarations to set the `mask-image` in\n// the title.\n\n// prettier-ignore\n$admonitions: (\n // Each of these has an reST directives for it.\n \"caution\": #ff9100 \"spark\",\n \"warning\": #ff9100 \"warning\",\n \"danger\": #ff5252 \"spark\",\n \"attention\": #ff5252 \"warning\",\n \"error\": #ff5252 \"failure\",\n \"hint\": #00c852 \"question\",\n \"tip\": #00c852 \"info\",\n \"important\": #00bfa5 \"flame\",\n \"note\": #00b0ff \"pencil\",\n \"seealso\": #448aff \"info\",\n \"admonition-todo\": #808080 \"pencil\"\n);\n\n@mixin default-admonition($color, $icon-name) {\n --color-admonition-title: #{$color};\n --color-admonition-title-background: #{rgba($color, 0.2)};\n\n --icon-admonition-default: var(--icon-#{$icon-name});\n}\n\n@mixin default-topic($color, $icon-name) {\n --color-topic-title: #{$color};\n --color-topic-title-background: #{rgba($color, 0.2)};\n\n --icon-topic-default: var(--icon-#{$icon-name});\n}\n\n@mixin admonitions {\n @each $name, $values in $admonitions {\n --color-admonition-title--#{$name}: #{nth($values, 1)};\n --color-admonition-title-background--#{$name}: #{rgba(\n nth($values, 1),\n 0.2\n )};\n }\n}\n","// Colors used throughout this theme.\n//\n// The aim is to give the user more control. Thus, instead of hard-coding colors\n// in various parts of the stylesheet, the approach taken is to define all\n// colors as CSS variables and reusing them in all the places.\n//\n// `colors-dark` depends on `colors` being included at a lower specificity.\n\n@mixin colors {\n --color-problematic: #b30000;\n\n // Base Colors\n --color-foreground-primary: black; // for main text and headings\n --color-foreground-secondary: #5a5c63; // for secondary text\n --color-foreground-muted: #646776; // for muted text\n --color-foreground-border: #878787; // for content borders\n\n --color-background-primary: white; // for content\n --color-background-secondary: #f8f9fb; // for navigation + ToC\n --color-background-hover: #efeff4ff; // for navigation-item hover\n --color-background-hover--transparent: #efeff400;\n --color-background-border: #eeebee; // for UI borders\n --color-background-item: #ccc; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #2962ff;\n --color-brand-content: #2a5adf;\n\n // API documentation\n --color-api-background: var(--color-background-hover--transparent);\n --color-api-background-hover: var(--color-background-hover);\n --color-api-overall: var(--color-foreground-secondary);\n --color-api-name: var(--color-problematic);\n --color-api-pre-name: var(--color-problematic);\n --color-api-paren: var(--color-foreground-secondary);\n --color-api-keyword: var(--color-foreground-primary);\n --color-highlight-on-target: #ffffcc;\n\n // Inline code background\n --color-inline-code-background: var(--color-background-secondary);\n\n // Highlighted text (search)\n --color-highlighted-background: #ddeeff;\n --color-highlighted-text: var(--color-foreground-primary);\n\n // GUI Labels\n --color-guilabel-background: #ddeeff80;\n --color-guilabel-border: #bedaf580;\n --color-guilabel-text: var(--color-foreground-primary);\n\n // Admonitions!\n --color-admonition-background: transparent;\n\n //////////////////////////////////////////////////////////////////////////////\n // Everything below this should be one of:\n // - var(...)\n // - *-gradient(...)\n // - special literal values (eg: transparent, none)\n //////////////////////////////////////////////////////////////////////////////\n\n // Tables\n --color-table-header-background: var(--color-background-secondary);\n --color-table-border: var(--color-background-border);\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: transparent;\n --color-card-marginals-background: var(--color-background-secondary);\n\n // Header\n --color-header-background: var(--color-background-primary);\n --color-header-border: var(--color-background-border);\n --color-header-text: var(--color-foreground-primary);\n\n // Sidebar (left)\n --color-sidebar-background: var(--color-background-secondary);\n --color-sidebar-background-border: var(--color-background-border);\n\n --color-sidebar-brand-text: var(--color-foreground-primary);\n --color-sidebar-caption-text: var(--color-foreground-muted);\n --color-sidebar-link-text: var(--color-foreground-secondary);\n --color-sidebar-link-text--top-level: var(--color-brand-primary);\n\n --color-sidebar-item-background: var(--color-sidebar-background);\n --color-sidebar-item-background--current: var(\n --color-sidebar-item-background\n );\n --color-sidebar-item-background--hover: linear-gradient(\n 90deg,\n var(--color-background-hover--transparent) 0%,\n var(--color-background-hover) var(--sidebar-item-spacing-horizontal),\n var(--color-background-hover) 100%\n );\n\n --color-sidebar-item-expander-background: transparent;\n --color-sidebar-item-expander-background--hover: var(\n --color-background-hover\n );\n\n --color-sidebar-search-text: var(--color-foreground-primary);\n --color-sidebar-search-background: var(--color-background-secondary);\n --color-sidebar-search-background--focus: var(--color-background-primary);\n --color-sidebar-search-border: var(--color-background-border);\n --color-sidebar-search-icon: var(--color-foreground-muted);\n\n // Table of Contents (right)\n --color-toc-background: var(--color-background-primary);\n --color-toc-title-text: var(--color-foreground-muted);\n --color-toc-item-text: var(--color-foreground-secondary);\n --color-toc-item-text--hover: var(--color-foreground-primary);\n --color-toc-item-text--active: var(--color-brand-primary);\n\n // Actual page contents\n --color-content-foreground: var(--color-foreground-primary);\n --color-content-background: transparent;\n\n // Links\n --color-link: var(--color-brand-content);\n --color-link--hover: var(--color-brand-content);\n --color-link-underline: var(--color-background-border);\n --color-link-underline--hover: var(--color-foreground-border);\n}\n\n@mixin colors-dark {\n --color-problematic: #ee5151;\n\n // Base Colors\n --color-foreground-primary: #ffffffcc; // for main text and headings\n --color-foreground-secondary: #9ca0a5; // for secondary text\n --color-foreground-muted: #81868d; // for muted text\n --color-foreground-border: #666666; // for content borders\n\n --color-background-primary: #131416; // for content\n --color-background-secondary: #1a1c1e; // for navigation + ToC\n --color-background-hover: #1e2124ff; // for navigation-item hover\n --color-background-hover--transparent: #1e212400;\n --color-background-border: #303335; // for UI borders\n --color-background-item: #444; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #2b8cee;\n --color-brand-content: #368ce2;\n\n // Highlighted text (search)\n --color-highlighted-background: #083563;\n\n // GUI Labels\n --color-guilabel-background: #08356380;\n --color-guilabel-border: #13395f80;\n\n // API documentation\n --color-api-keyword: var(--color-foreground-secondary);\n --color-highlight-on-target: #333300;\n\n // Admonitions\n --color-admonition-background: #18181a;\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: #18181a;\n --color-card-marginals-background: var(--color-background-hover);\n}\n","// This file contains the styling for making the content throughout the page,\n// including fonts, paragraphs, headings and spacing among these elements.\n\nbody\n font-family: var(--font-stack)\npre,\ncode,\nkbd,\nsamp\n font-family: var(--font-stack--monospace)\n\n// Make fonts look slightly nicer.\nbody\n -webkit-font-smoothing: antialiased\n -moz-osx-font-smoothing: grayscale\n\n// Line height from Bootstrap 4.1\narticle\n line-height: 1.5\n\n//\n// Headings\n//\nh1,\nh2,\nh3,\nh4,\nh5,\nh6\n line-height: 1.25\n font-weight: bold\n\n border-radius: 0.5rem\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n margin-left: -0.5rem\n margin-right: -0.5rem\n padding-left: 0.5rem\n padding-right: 0.5rem\n\n + p\n margin-top: 0\n\nh1\n font-size: 2.5em\n margin-top: 1.75rem\n margin-bottom: 1rem\nh2\n font-size: 2em\n margin-top: 1.75rem\nh3\n font-size: 1.5em\nh4\n font-size: 1.25em\nh5\n font-size: 1.125em\nh6\n font-size: 1em\n\nsmall\n opacity: 75%\n font-size: 80%\n\n// Paragraph\np\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n\n// Horizontal rules\nhr.docutils\n height: 1px\n padding: 0\n margin: 2rem 0\n background-color: var(--color-background-border)\n border: 0\n\n.centered\n text-align: center\n\n// Links\na\n text-decoration: underline\n\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n &:hover\n color: var(--color-link--hover)\n text-decoration-color: var(--color-link-underline--hover)\n &.muted-link\n color: inherit\n &:hover\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline--hover)\n","// This file contains the styles for the overall layouting of the documentation\n// skeleton, including the responsive changes as well as sidebar toggles.\n//\n// This is implemented as a mobile-last design, which isn't ideal, but it is\n// reasonably good-enough and I got pretty tired by the time I'd finished this\n// to move the rules around to fix this. Shouldn't take more than 3-4 hours,\n// if you know what you're doing tho.\n\n// HACK: Not all browsers account for the scrollbar width in media queries.\n// This results in horizontal scrollbars in the breakpoint where we go\n// from displaying everything to hiding the ToC. We accomodate for this by\n// adding a bit of padding to the TOC drawer, disabling the horizontal\n// scrollbar and allowing the scrollbars to cover the padding.\n// https://www.456bereastreet.com/archive/201301/media_query_width_and_vertical_scrollbars/\n\n// HACK: Always having the scrollbar visible, prevents certain browsers from\n// causing the content to stutter horizontally between taller-than-viewport and\n// not-taller-than-viewport pages.\n\nhtml\n overflow-x: hidden\n overflow-y: scroll\n scroll-behavior: smooth\n\n.sidebar-scroll, .toc-scroll, article[role=main] *\n // Override Firefox scrollbar style\n scrollbar-width: thin\n scrollbar-color: var(--color-foreground-border) transparent\n\n // Override Chrome scrollbar styles\n &::-webkit-scrollbar\n width: 0.25rem\n height: 0.25rem\n &::-webkit-scrollbar-thumb\n background-color: var(--color-foreground-border)\n border-radius: 0.125rem\n\n//\n// Overalls\n//\nhtml,\nbody\n height: 100%\n color: var(--color-foreground-primary)\n background: var(--color-background-primary)\n\narticle\n color: var(--color-content-foreground)\n background: var(--color-content-background)\n overflow-wrap: break-word\n\n.page\n display: flex\n // fill the viewport for pages with little content.\n min-height: 100%\n\n.mobile-header\n width: 100%\n height: var(--header-height)\n background-color: var(--color-header-background)\n color: var(--color-header-text)\n border-bottom: 1px solid var(--color-header-border)\n\n // Looks like sub-script/super-script have this, and we need this to\n // be \"on top\" of those.\n z-index: 10\n\n // We don't show the header on large screens.\n display: none\n\n // Add shadow when scrolled\n &.scrolled\n border-bottom: none\n box-shadow: 0 0 0.2rem rgba(0, 0, 0, 0.1), 0 0.2rem 0.4rem rgba(0, 0, 0, 0.2)\n\n .header-center\n a\n color: var(--color-header-text)\n text-decoration: none\n\n.main\n display: flex\n flex: 1\n\n// Sidebar (left) also covers the entire left portion of screen.\n.sidebar-drawer\n box-sizing: border-box\n\n border-right: 1px solid var(--color-sidebar-background-border)\n background: var(--color-sidebar-background)\n\n display: flex\n justify-content: flex-end\n // These next two lines took me two days to figure out.\n width: calc((100% - #{$full-width}) / 2 + #{$sidebar-width})\n min-width: $sidebar-width\n\n// Scroll-along sidebars\n.sidebar-container,\n.toc-drawer\n box-sizing: border-box\n width: $sidebar-width\n\n.toc-drawer\n background: var(--color-toc-background)\n // See HACK described on top of this document\n padding-right: 1rem\n\n.sidebar-sticky,\n.toc-sticky\n position: sticky\n top: 0\n height: min(100%, 100vh)\n height: 100vh\n\n display: flex\n flex-direction: column\n\n.sidebar-scroll,\n.toc-scroll\n flex-grow: 1\n flex-shrink: 1\n\n overflow: auto\n scroll-behavior: smooth\n\n// Central items.\n.content\n padding: 0 $content-padding\n width: $content-width\n\n display: flex\n flex-direction: column\n justify-content: space-between\n\n.icon\n display: inline-block\n height: 1rem\n width: 1rem\n svg\n width: 100%\n height: 100%\n\n//\n// Accommodate announcement banner\n//\n.announcement\n background-color: var(--color-announcement-background)\n color: var(--color-announcement-text)\n\n height: var(--header-height)\n display: flex\n align-items: center\n overflow-x: auto\n & + .page\n min-height: calc(100% - var(--header-height))\n\n.announcement-content\n box-sizing: border-box\n padding: 0.5rem\n min-width: 100%\n white-space: nowrap\n text-align: center\n\n a\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-announcement-text)\n\n &:hover\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-link--hover)\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for theme\n////////////////////////////////////////////////////////////////////////////////\n.no-js .theme-toggle-container // don't show theme toggle if there's no JS\n display: none\n\n.theme-toggle-container\n vertical-align: middle\n\n.theme-toggle\n cursor: pointer\n border: none\n padding: 0\n background: transparent\n\n.theme-toggle svg\n vertical-align: middle\n height: 1rem\n width: 1rem\n color: var(--color-foreground-primary)\n display: none\n\n.theme-toggle-header\n float: left\n padding: 1rem 0.5rem\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for elements\n////////////////////////////////////////////////////////////////////////////////\n.toc-overlay-icon, .nav-overlay-icon\n display: none\n cursor: pointer\n\n .icon\n color: var(--color-foreground-secondary)\n height: 1rem\n width: 1rem\n\n.toc-header-icon, .nav-overlay-icon\n // for when we set display: flex\n justify-content: center\n align-items: center\n\n.toc-content-icon\n height: 1.5rem\n width: 1.5rem\n\n.content-icon-container\n float: right\n display: flex\n margin-top: 1.5rem\n margin-left: 1rem\n margin-bottom: 1rem\n gap: 0.5rem\n\n .edit-this-page svg\n color: inherit\n height: 1rem\n width: 1rem\n\n.sidebar-toggle\n position: absolute\n display: none\n// <debugging things>\n.sidebar-toggle[name=\"__toc\"]\n left: 20px\n.sidebar-toggle:checked\n left: 40px\n// </debugging things>\n\n.overlay\n position: fixed\n top: 0\n width: 0\n height: 0\n\n transition: width 0ms, height 0ms, opacity 250ms ease-out\n\n opacity: 0\n background-color: rgba(0, 0, 0, 0.54)\n.sidebar-overlay\n z-index: 20\n.toc-overlay\n z-index: 40\n\n// Keep things on top and smooth.\n.sidebar-drawer\n z-index: 30\n transition: left 250ms ease-in-out\n.toc-drawer\n z-index: 50\n transition: right 250ms ease-in-out\n\n// Show the Sidebar\n#__navigation:checked\n & ~ .sidebar-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .sidebar-drawer\n top: 0\n left: 0\n // Show the toc sidebar\n#__toc:checked\n & ~ .toc-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .toc-drawer\n top: 0\n right: 0\n\n////////////////////////////////////////////////////////////////////////////////\n// Back to top\n////////////////////////////////////////////////////////////////////////////////\n.back-to-top\n text-decoration: none\n\n display: none\n position: fixed\n left: 0\n top: 1rem\n padding: 0.5rem\n padding-right: 0.75rem\n border-radius: 1rem\n font-size: 0.8125rem\n\n background: var(--color-background-primary)\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), #6b728080 0px 0px 1px 0px\n\n z-index: 10\n\n margin-left: 50%\n transform: translateX(-50%)\n svg\n height: 1rem\n width: 1rem\n fill: currentColor\n display: inline-block\n\n span\n margin-left: 0.25rem\n\n .show-back-to-top &\n display: flex\n align-items: center\n\n////////////////////////////////////////////////////////////////////////////////\n// Responsive layouting\n////////////////////////////////////////////////////////////////////////////////\n// Make things a bit bigger on bigger screens.\n@media (min-width: $full-width + $sidebar-width)\n html\n font-size: 110%\n\n@media (max-width: $full-width)\n // Collapse \"toc\" into the icon.\n .toc-content-icon\n display: flex\n .toc-drawer\n position: fixed\n height: 100vh\n top: 0\n right: -$sidebar-width\n border-left: 1px solid var(--color-background-muted)\n .toc-tree\n border-left: none\n font-size: var(--toc-font-size--mobile)\n\n // Accomodate for a changed content width.\n .sidebar-drawer\n width: calc((100% - #{$full-width - $sidebar-width}) / 2 + #{$sidebar-width})\n\n@media (max-width: $full-width - $sidebar-width)\n // Collapse \"navigation\".\n .nav-overlay-icon\n display: flex\n .sidebar-drawer\n position: fixed\n height: 100vh\n width: $sidebar-width\n\n top: 0\n left: -$sidebar-width\n\n // Swap which icon is visible.\n .toc-header-icon\n display: flex\n .toc-content-icon, .theme-toggle-content\n display: none\n .theme-toggle-header\n display: block\n\n // Show the header.\n .mobile-header\n position: sticky\n top: 0\n display: flex\n justify-content: space-between\n align-items: center\n\n .header-left,\n .header-right\n display: flex\n height: var(--header-height)\n padding: 0 var(--header-padding)\n label\n height: 100%\n width: 100%\n user-select: none\n\n .nav-overlay-icon .icon,\n .theme-toggle svg\n height: 1.25rem\n width: 1.25rem\n\n // Add a scroll margin for the content\n :target\n scroll-margin-top: var(--header-height)\n\n // Show back-to-top below the header\n .back-to-top\n top: calc(var(--header-height) + 0.5rem)\n\n // Center the page, and accommodate for the header.\n .page\n flex-direction: column\n justify-content: center\n .content\n margin-left: auto\n margin-right: auto\n\n@media (max-width: $content-width + 2* $content-padding)\n // Content should respect window limits.\n .content\n width: 100%\n overflow-x: auto\n\n@media (max-width: $content-width)\n .content\n padding: 0 $content-padding--small\n // Don't float sidebars to the right.\n article aside.sidebar\n float: none\n width: 100%\n margin: 1rem 0\n","//\n// The design here is strongly inspired by mkdocs-material.\n.admonition, .topic\n margin: 1rem auto\n padding: 0 0.5rem 0.5rem 0.5rem\n\n background: var(--color-admonition-background)\n\n border-radius: 0.2rem\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n font-size: var(--admonition-font-size)\n\n overflow: hidden\n page-break-inside: avoid\n\n // First element should have no margin, since the title has it.\n > :nth-child(2)\n margin-top: 0\n\n // Last item should have no margin, since we'll control that w/ padding\n > :last-child\n margin-bottom: 0\n\n.admonition p.admonition-title,\np.topic-title\n position: relative\n margin: 0 -0.5rem 0.5rem\n padding-left: 2rem\n padding-right: .5rem\n padding-top: .4rem\n padding-bottom: .4rem\n\n font-weight: 500\n font-size: var(--admonition-title-font-size)\n line-height: 1.3\n\n // Our fancy icon\n &::before\n content: \"\"\n position: absolute\n left: 0.5rem\n width: 1rem\n height: 1rem\n\n// Default styles\np.admonition-title\n background-color: var(--color-admonition-title-background)\n &::before\n background-color: var(--color-admonition-title)\n mask-image: var(--icon-admonition-default)\n mask-repeat: no-repeat\n\np.topic-title\n background-color: var(--color-topic-title-background)\n &::before\n background-color: var(--color-topic-title)\n mask-image: var(--icon-topic-default)\n mask-repeat: no-repeat\n\n//\n// Variants\n//\n.admonition\n border-left: 0.2rem solid var(--color-admonition-title)\n\n @each $type, $value in $admonitions\n &.#{$type}\n border-left-color: var(--color-admonition-title--#{$type})\n > .admonition-title\n background-color: var(--color-admonition-title-background--#{$type})\n &::before\n background-color: var(--color-admonition-title--#{$type})\n mask-image: var(--icon-#{nth($value, 2)})\n\n.admonition-todo > .admonition-title\n text-transform: uppercase\n","// This file stylizes the API documentation (stuff generated by autodoc). It's\n// deeply nested due to how autodoc structures the HTML without enough classes\n// to select the relevant items.\n\n// API docs!\ndl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)\n // Tweak the spacing of all the things!\n dd\n margin-left: 2rem\n > :first-child\n margin-top: 0.125rem\n > :last-child\n margin-bottom: 0.75rem\n\n // This is used for the arguments\n .field-list\n margin-bottom: 0.75rem\n\n // \"Headings\" (like \"Parameters\" and \"Return\")\n > dt\n text-transform: uppercase\n font-size: var(--font-size--small)\n\n dd:empty\n margin-bottom: 0.5rem\n dd > ul\n margin-left: -1.2rem\n > li\n > p:nth-child(2)\n margin-top: 0\n // When the last-empty-paragraph follows a paragraph, it doesn't need\n // to augument the existing spacing.\n > p + p:last-child:empty\n margin-top: 0\n margin-bottom: 0\n\n // Colorize the elements\n > dt\n color: var(--color-api-overall)\n\n.sig:not(.sig-inline)\n font-weight: bold\n\n font-size: var(--api-font-size)\n font-family: var(--font-stack--monospace)\n\n margin-left: -0.25rem\n margin-right: -0.25rem\n padding-top: 0.25rem\n padding-bottom: 0.25rem\n padding-right: 0.5rem\n\n // These are intentionally em, to properly match the font size.\n padding-left: 3em\n text-indent: -2.5em\n\n border-radius: 0.25rem\n\n background: var(--color-api-background)\n transition: background 100ms ease-out\n\n &:hover\n background: var(--color-api-background-hover)\n\n // adjust the size of the [source] link on the right.\n a.reference\n .viewcode-link\n font-weight: normal\n width: 3.5rem\n\nem.property\n font-style: normal\n &:first-child\n color: var(--color-api-keyword)\n.sig-name\n color: var(--color-api-name)\n.sig-prename\n font-weight: normal\n color: var(--color-api-pre-name)\n.sig-paren\n color: var(--color-api-paren)\n.sig-param\n font-style: normal\n\n.versionmodified\n font-style: italic\ndiv.versionadded, div.versionchanged, div.deprecated\n p\n margin-top: 0.125rem\n margin-bottom: 0.125rem\n\n// Align the [docs] and [source] to the right.\n.viewcode-link, .viewcode-back\n float: right\n text-align: right\n",".line-block\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n .line-block\n margin-top: 0rem\n margin-bottom: 0rem\n padding-left: 1rem\n","// Captions\narticle p.caption,\ntable > caption,\n.code-block-caption\n font-size: var(--font-size--small)\n text-align: center\n\n// Caption above a TOCTree\n.toctree-wrapper.compound\n .caption, :not(.caption) > .caption-text\n font-size: var(--font-size--small)\n text-transform: uppercase\n\n text-align: initial\n margin-bottom: 0\n\n > ul\n margin-top: 0\n margin-bottom: 0\n","// Inline code\ncode.literal, .sig-inline\n background: var(--color-inline-code-background)\n border-radius: 0.2em\n // Make the font smaller, and use padding to recover.\n font-size: var(--font-size--small--2)\n padding: 0.1em 0.2em\n\n pre.literal-block &\n font-size: inherit\n padding: 0\n\n p &\n border: 1px solid var(--color-background-border)\n\n.sig-inline\n font-family: var(--font-stack--monospace)\n\n// Code and Literal Blocks\n$code-spacing-vertical: 0.625rem\n$code-spacing-horizontal: 0.875rem\n\n// Wraps every literal block + line numbers.\ndiv[class*=\" highlight-\"],\ndiv[class^=\"highlight-\"]\n margin: 1em 0\n display: flex\n\n .table-wrapper\n margin: 0\n padding: 0\n\npre\n margin: 0\n padding: 0\n overflow: auto\n\n // Needed to have more specificity than pygments' \"pre\" selector. :(\n article[role=\"main\"] .highlight &\n line-height: 1.5\n\n &.literal-block,\n .highlight &\n font-size: var(--code-font-size)\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n // Make it look like all the other blocks.\n &.literal-block\n margin-top: 1rem\n margin-bottom: 1rem\n\n border-radius: 0.2rem\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n\n// All code is always contained in this.\n.highlight\n width: 100%\n border-radius: 0.2rem\n\n // Make line numbers and prompts un-selectable.\n .gp, span.linenos\n user-select: none\n pointer-events: none\n\n // Expand the line-highlighting.\n .hll\n display: block\n margin-left: -$code-spacing-horizontal\n margin-right: -$code-spacing-horizontal\n padding-left: $code-spacing-horizontal\n padding-right: $code-spacing-horizontal\n\n/* Make code block captions be nicely integrated */\n.code-block-caption\n display: flex\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n border-radius: 0.25rem\n border-bottom-left-radius: 0\n border-bottom-right-radius: 0\n font-weight: 300\n border-bottom: 1px solid\n\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n border-color: var(--color-background-border)\n\n + div[class]\n margin-top: 0\n pre\n border-top-left-radius: 0\n border-top-right-radius: 0\n\n// When `html_codeblock_linenos_style` is table.\n.highlighttable\n width: 100%\n display: block\n tbody\n display: block\n\n tr\n display: flex\n\n // Line numbers\n td.linenos\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n padding: $code-spacing-vertical $code-spacing-horizontal\n padding-right: 0\n border-top-left-radius: 0.2rem\n border-bottom-left-radius: 0.2rem\n\n .linenodiv\n padding-right: $code-spacing-horizontal\n font-size: var(--code-font-size)\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n\n // Actual code\n td.code\n padding: 0\n display: block\n flex: 1\n overflow: hidden\n\n .highlight\n border-top-left-radius: 0\n border-bottom-left-radius: 0\n\n// When `html_codeblock_linenos_style` is inline.\n.highlight\n span.linenos\n display: inline-block\n padding-left: 0\n padding-right: $code-spacing-horizontal\n margin-right: $code-spacing-horizontal\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n","// Inline Footnote Reference\n.footnote-reference\n font-size: var(--font-size--small--4)\n vertical-align: super\n\n// Definition list, listing the content of each note.\n// docutils <= 0.17\ndl.footnote.brackets\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\n display: grid\n grid-template-columns: max-content auto\n dt\n margin: 0\n > .fn-backref\n margin-left: 0.25rem\n\n &:after\n content: \":\"\n\n .brackets\n &:before\n content: \"[\"\n &:after\n content: \"]\"\n\n dd\n margin: 0\n padding: 0 1rem\n\n// docutils >= 0.18\naside.footnote\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\naside.footnote > span,\ndiv.citation > span\n float: left\n font-weight: 500\n padding-right: 0.25rem\n\naside.footnote > p,\ndiv.citation > p\n margin-left: 2rem\n","//\n// Figures\n//\nimg\n box-sizing: border-box\n max-width: 100%\n height: auto\n\narticle\n figure, .figure\n border-radius: 0.2rem\n\n margin: 0\n :last-child\n margin-bottom: 0\n\n .align-left\n float: left\n clear: left\n margin: 0 1rem 1rem\n\n .align-right\n float: right\n clear: right\n margin: 0 1rem 1rem\n\n .align-default,\n .align-center\n display: block\n text-align: center\n margin-left: auto\n margin-right: auto\n\n // WELL, table needs to be stylised like a table.\n table.align-default\n display: table\n text-align: initial\n",".genindex-jumpbox, .domainindex-jumpbox\n border-top: 1px solid var(--color-background-border)\n border-bottom: 1px solid var(--color-background-border)\n padding: 0.25rem\n\n.genindex-section, .domainindex-section\n h2\n margin-top: 0.75rem\n margin-bottom: 0.5rem\n ul\n margin-top: 0\n margin-bottom: 0\n","ul,\nol\n padding-left: 1.2rem\n\n // Space lists out like paragraphs\n margin-top: 1rem\n margin-bottom: 1rem\n // reduce margins within li.\n li\n > p:first-child\n margin-top: 0.25rem\n margin-bottom: 0.25rem\n\n > p:last-child\n margin-top: 0.25rem\n\n > ul,\n > ol\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n\nol\n &.arabic\n list-style: decimal\n &.loweralpha\n list-style: lower-alpha\n &.upperalpha\n list-style: upper-alpha\n &.lowerroman\n list-style: lower-roman\n &.upperroman\n list-style: upper-roman\n\n// Don't space lists out when they're \"simple\" or in a `.. toctree::`\n.simple,\n.toctree-wrapper\n li\n > ul,\n > ol\n margin-top: 0\n margin-bottom: 0\n\n// Definition Lists\n.field-list,\n.option-list,\ndl:not([class]),\ndl.simple,\ndl.footnote,\ndl.glossary\n dt\n font-weight: 500\n margin-top: 0.25rem\n + dt\n margin-top: 0\n\n .classifier::before\n content: \":\"\n margin-left: 0.2rem\n margin-right: 0.2rem\n\n dd\n > p:first-child,\n ul\n margin-top: 0.125rem\n\n ul\n margin-bottom: 0.125rem\n",".math-wrapper\n width: 100%\n overflow-x: auto\n\ndiv.math\n position: relative\n text-align: center\n\n .headerlink,\n &:focus .headerlink\n display: none\n\n &:hover .headerlink\n display: inline-block\n\n span.eqno\n position: absolute\n right: 0.5rem\n top: 50%\n transform: translate(0, -50%)\n z-index: 1\n","// Abbreviations\nabbr[title]\n cursor: help\n\n// \"Problematic\" content, as identified by Sphinx\n.problematic\n color: var(--color-problematic)\n\n// Keyboard / Mouse \"instructions\"\nkbd:not(.compound)\n margin: 0 0.2rem\n padding: 0 0.2rem\n border-radius: 0.2rem\n border: 1px solid var(--color-foreground-border)\n color: var(--color-foreground-primary)\n vertical-align: text-bottom\n\n font-size: var(--font-size--small--3)\n display: inline-block\n\n box-shadow: 0 0.0625rem 0 rgba(0, 0, 0, 0.2), inset 0 0 0 0.125rem var(--color-background-primary)\n\n background-color: var(--color-background-secondary)\n\n// Blockquote\nblockquote\n border-left: 4px solid var(--color-background-border)\n background: var(--color-background-secondary)\n\n margin-left: 0\n margin-right: 0\n padding: 0.5rem 1rem\n\n .attribution\n font-weight: 600\n text-align: right\n\n &.pull-quote,\n &.highlights\n font-size: 1.25em\n\n &.epigraph,\n &.pull-quote\n border-left-width: 0\n border-radius: 0.5rem\n\n &.highlights\n border-left-width: 0\n background: transparent\n\n// Center align embedded-in-text images\np .reference img\n vertical-align: middle\n","p.rubric\n line-height: 1.25\n font-weight: bold\n font-size: 1.125em\n\n // For Numpy-style documentation that's got rubrics within it.\n // https://github.com/pradyunsg/furo/discussions/505\n dd &\n line-height: inherit\n font-weight: inherit\n\n font-size: var(--font-size--small)\n text-transform: uppercase\n","article .sidebar\n float: right\n clear: right\n width: 30%\n\n margin-left: 1rem\n margin-right: 0\n\n border-radius: 0.2rem\n background-color: var(--color-background-secondary)\n border: var(--color-background-border) 1px solid\n\n > *\n padding-left: 1rem\n padding-right: 1rem\n\n > ul, > ol // lists need additional padding, because bullets.\n padding-left: 2.2rem\n\n .sidebar-title\n margin: 0\n padding: 0.5rem 1rem\n border-bottom: var(--color-background-border) 1px solid\n\n font-weight: 500\n\n// TODO: subtitle\n// TODO: dedicated variables?\n",".table-wrapper\n width: 100%\n overflow-x: auto\n margin-top: 1rem\n margin-bottom: 0.5rem\n padding: 0.2rem 0.2rem 0.75rem\n\ntable.docutils\n border-radius: 0.2rem\n border-spacing: 0\n border-collapse: collapse\n\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n th\n background: var(--color-table-header-background)\n\n td,\n th\n // Space things out properly\n padding: 0 0.25rem\n\n // Get the borders looking just-right.\n border-left: 1px solid var(--color-table-border)\n border-right: 1px solid var(--color-table-border)\n border-bottom: 1px solid var(--color-table-border)\n\n p\n margin: 0.25rem\n\n &:first-child\n border-left: none\n &:last-child\n border-right: none\n\n // MyST-parser tables set these classes for control of column alignment\n &.text-left\n text-align: left\n &.text-right\n text-align: right\n &.text-center\n text-align: center\n",":target\n scroll-margin-top: 0.5rem\n\n@media (max-width: $full-width - $sidebar-width)\n :target\n scroll-margin-top: calc(0.5rem + var(--header-height))\n\n // When a heading is selected\n section > span:target\n scroll-margin-top: calc(0.8rem + var(--header-height))\n\n// Permalinks\n.headerlink\n font-weight: 100\n user-select: none\n\nh1,\nh2,\nh3,\nh4,\nh5,\nh6,\ndl dt,\np.caption,\nfigcaption p,\ntable > caption,\n.code-block-caption\n > .headerlink\n margin-left: 0.5rem\n visibility: hidden\n &:hover > .headerlink\n visibility: visible\n\n // Don't change to link-like, if someone adds the contents directive.\n > .toc-backref\n color: inherit\n text-decoration-line: none\n\n// Figure and table captions are special.\nfigure:hover > figcaption > p > .headerlink,\ntable:hover > caption > .headerlink\n visibility: visible\n\n:target >, // Regular section[id] style anchors\nspan:target ~ // Non-regular span[id] style \"extra\" anchors\n h1,\n h2,\n h3,\n h4,\n h5,\n h6\n &:nth-of-type(1)\n background-color: var(--color-highlight-on-target)\n // .headerlink\n // visibility: visible\n code.literal\n background-color: transparent\n\ntable:target > caption,\nfigure:target\n background-color: var(--color-highlight-on-target)\n\n// Inline page contents\n.this-will-duplicate-information-and-it-is-still-useful-here li :target\n background-color: var(--color-highlight-on-target)\n\n// Code block permalinks\n.literal-block-wrapper:target .code-block-caption\n background-color: var(--color-highlight-on-target)\n\n// When a definition list item is selected\n//\n// There isn't really an alternative to !important here, due to the\n// high-specificity of API documentation's selector.\ndt:target\n background-color: var(--color-highlight-on-target) !important\n\n// When a footnote reference is selected\n.footnote > dt:target + dd,\n.footnote-reference:target\n background-color: var(--color-highlight-on-target)\n",".guilabel\n background-color: var(--color-guilabel-background)\n border: 1px solid var(--color-guilabel-border)\n color: var(--color-guilabel-text)\n\n padding: 0 0.3em\n border-radius: 0.5em\n font-size: 0.9em\n","// This file contains the styles used for stylizing the footer that's shown\n// below the content.\n\nfooter\n font-size: var(--font-size--small)\n display: flex\n flex-direction: column\n\n margin-top: 2rem\n\n// Bottom of page information\n.bottom-of-page\n display: flex\n align-items: center\n justify-content: space-between\n\n margin-top: 1rem\n padding-top: 1rem\n padding-bottom: 1rem\n\n color: var(--color-foreground-secondary)\n border-top: 1px solid var(--color-background-border)\n\n line-height: 1.5\n\n @media (max-width: $content-width)\n text-align: center\n flex-direction: column-reverse\n gap: 0.25rem\n\n .left-details\n font-size: var(--font-size--small)\n\n .right-details\n display: flex\n flex-direction: column\n gap: 0.25rem\n text-align: right\n\n .icons\n display: flex\n justify-content: flex-end\n gap: 0.25rem\n font-size: 1rem\n\n a\n text-decoration: none\n\n svg,\n img\n font-size: 1.125rem\n height: 1em\n width: 1em\n\n// Next/Prev page information\n.related-pages\n a\n display: flex\n align-items: center\n\n text-decoration: none\n &:hover .page-info .title\n text-decoration: underline\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n svg.furo-related-icon,\n svg.furo-related-icon > use\n flex-shrink: 0\n\n color: var(--color-foreground-border)\n\n width: 0.75rem\n height: 0.75rem\n margin: 0 0.5rem\n\n &.next-page\n max-width: 50%\n\n float: right\n clear: right\n text-align: right\n\n &.prev-page\n max-width: 50%\n\n float: left\n clear: left\n\n svg\n transform: rotate(180deg)\n\n.page-info\n display: flex\n flex-direction: column\n overflow-wrap: anywhere\n\n .next-page &\n align-items: flex-end\n\n .context\n display: flex\n align-items: center\n\n padding-bottom: 0.1rem\n\n color: var(--color-foreground-muted)\n font-size: var(--font-size--small)\n text-decoration: none\n","// This file contains the styles for the contents of the left sidebar, which\n// contains the navigation tree, logo, search etc.\n\n////////////////////////////////////////////////////////////////////////////////\n// Brand on top of the scrollable tree.\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-brand\n display: flex\n flex-direction: column\n flex-shrink: 0\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n text-decoration: none\n\n.sidebar-brand-text\n color: var(--color-sidebar-brand-text)\n overflow-wrap: break-word\n margin: var(--sidebar-item-spacing-vertical) 0\n font-size: 1.5rem\n\n.sidebar-logo-container\n margin: var(--sidebar-item-spacing-vertical) 0\n\n.sidebar-logo\n margin: 0 auto\n display: block\n max-width: 100%\n\n////////////////////////////////////////////////////////////////////////////////\n// Search\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-search-container\n display: flex\n align-items: center\n margin-top: var(--sidebar-search-space-above)\n\n position: relative\n\n background: var(--color-sidebar-search-background)\n &:hover,\n &:focus-within\n background: var(--color-sidebar-search-background--focus)\n\n &::before\n content: \"\"\n position: absolute\n left: var(--sidebar-item-spacing-horizontal)\n width: var(--sidebar-search-icon-size)\n height: var(--sidebar-search-icon-size)\n\n background-color: var(--color-sidebar-search-icon)\n mask-image: var(--icon-search)\n\n.sidebar-search\n box-sizing: border-box\n\n border: none\n border-top: 1px solid var(--color-sidebar-search-border)\n border-bottom: 1px solid var(--color-sidebar-search-border)\n\n padding-top: var(--sidebar-search-input-spacing-vertical)\n padding-bottom: var(--sidebar-search-input-spacing-vertical)\n padding-right: var(--sidebar-search-input-spacing-horizontal)\n padding-left: calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size))\n\n width: 100%\n\n color: var(--color-sidebar-search-foreground)\n background: transparent\n z-index: 10\n\n &:focus\n outline: none\n\n &::placeholder\n font-size: var(--sidebar-search-input-font-size)\n\n//\n// Hide Search Matches link\n//\n#searchbox .highlight-link\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0\n margin: 0\n text-align: center\n\n a\n color: var(--color-sidebar-search-icon)\n font-size: var(--font-size--small--2)\n\n////////////////////////////////////////////////////////////////////////////////\n// Structure/Skeleton of the navigation tree (left)\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-tree\n font-size: var(--sidebar-item-font-size)\n margin-top: var(--sidebar-tree-space-above)\n margin-bottom: var(--sidebar-item-spacing-vertical)\n\n ul\n padding: 0\n margin-top: 0\n margin-bottom: 0\n\n display: flex\n flex-direction: column\n\n list-style: none\n\n li\n position: relative\n margin: 0\n\n > ul\n margin-left: var(--sidebar-item-spacing-horizontal)\n\n .icon\n color: var(--color-sidebar-link-text)\n\n .reference\n box-sizing: border-box\n color: var(--color-sidebar-link-text)\n\n // Fill the parent.\n display: inline-block\n line-height: var(--sidebar-item-line-height)\n text-decoration: none\n\n // Don't allow long words to cause wrapping.\n overflow-wrap: anywhere\n\n height: 100%\n width: 100%\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n &:hover\n background: var(--color-sidebar-item-background--hover)\n\n // Add a nice little \"external-link\" arrow here.\n &.external::after\n content: url('data:image/svg+xml,<svg width=\"12\" height=\"12\" xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" stroke-width=\"1.5\" stroke=\"%23607D8B\" fill=\"none\" stroke-linecap=\"round\" stroke-linejoin=\"round\"><path stroke=\"none\" d=\"M0 0h24v24H0z\"/><path d=\"M11 7h-5a2 2 0 0 0 -2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2 -2v-5\" /><line x1=\"10\" y1=\"14\" x2=\"20\" y2=\"4\" /><polyline points=\"15 4 20 4 20 9\" /></svg>')\n margin: 0 0.25rem\n vertical-align: middle\n color: var(--color-sidebar-link-text)\n\n // Make the current page reference bold.\n .current-page > .reference\n font-weight: bold\n\n label\n position: absolute\n top: 0\n right: 0\n height: var(--sidebar-item-height)\n width: var(--sidebar-expander-width)\n\n cursor: pointer\n user-select: none\n\n display: flex\n justify-content: center\n align-items: center\n\n .caption, :not(.caption) > .caption-text\n font-size: var(--sidebar-caption-font-size)\n color: var(--color-sidebar-caption-text)\n\n font-weight: bold\n text-transform: uppercase\n\n margin: var(--sidebar-caption-space-above) 0 0 0\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n // If it has children, add a bit more padding to wrap the content to avoid\n // overlapping with the <label>\n li.has-children\n > .reference\n padding-right: var(--sidebar-expander-width)\n\n // Colorize the top-level list items and icon.\n .toctree-l1\n & > .reference,\n & > label .icon\n color: var(--color-sidebar-link-text--top-level)\n\n // Color changes on hover\n label\n background: var(--color-sidebar-item-expander-background)\n &:hover\n background: var(--color-sidebar-item-expander-background--hover)\n\n .current > .reference\n background: var(--color-sidebar-item-background--current)\n &:hover\n background: var(--color-sidebar-item-background--hover)\n\n.toctree-checkbox\n position: absolute\n display: none\n\n////////////////////////////////////////////////////////////////////////////////\n// Togglable expand/collapse\n////////////////////////////////////////////////////////////////////////////////\n.toctree-checkbox\n ~ ul\n display: none\n\n ~ label .icon svg\n transform: rotate(90deg)\n\n.toctree-checkbox:checked\n ~ ul\n display: block\n\n ~ label .icon svg\n transform: rotate(-90deg)\n","// This file contains the styles for the contents of the right sidebar, which\n// contains the table of contents for the current page.\n.toc-title-container\n padding: var(--toc-title-padding)\n padding-top: var(--toc-spacing-vertical)\n\n.toc-title\n color: var(--color-toc-title-text)\n font-size: var(--toc-title-font-size)\n padding-left: var(--toc-spacing-horizontal)\n text-transform: uppercase\n\n// If the ToC is not present, hide these elements coz they're not relevant.\n.no-toc\n display: none\n\n.toc-tree-container\n padding-bottom: var(--toc-spacing-vertical)\n\n.toc-tree\n font-size: var(--toc-font-size)\n line-height: 1.3\n border-left: 1px solid var(--color-background-border)\n\n padding-left: calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal))\n\n // Hide the first \"top level\" bullet.\n > ul > li:first-child\n padding-top: 0\n & > ul\n padding-left: 0\n & > a\n display: none\n\n ul\n list-style-type: none\n margin-top: 0\n margin-bottom: 0\n padding-left: var(--toc-item-spacing-horizontal)\n li\n padding-top: var(--toc-item-spacing-vertical)\n\n &.scroll-current >.reference\n color: var(--color-toc-item-text--active)\n font-weight: bold\n\n .reference\n color: var(--color-toc-item-text)\n text-decoration: none\n overflow-wrap: anywhere\n\n.toc-scroll\n max-height: 100vh\n overflow-y: scroll\n\n// Be very annoying when someone includes the table of contents\n.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here)\n color: var(--color-problematic)\n background: rgba(255, 0, 0, 0.25)\n &::before\n content: \"ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling.Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch.\"\n","// Shameful hacks, to work around bugs.\n\n// MyST parser doesn't correctly generate classes, to align table contents.\n// https://github.com/executablebooks/MyST-Parser/issues/412\n.text-align\\:left > p\n text-align: left\n\n.text-align\\:center > p\n text-align: center\n\n.text-align\\:right > p\n text-align: right\n"],"names":[],"sourceRoot":""}
\ No newline at end of file diff --git a/v7.2.2/changelog.html b/v7.2.2/changelog.html deleted file mode 100644 index 64e3bab3..00000000 --- a/v7.2.2/changelog.html +++ /dev/null @@ -1,663 +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="prev" title="site_api" href="output/botcore.site_api.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>Changelog - Pydis Core v7.2.2</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.2.2</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 no-toc" 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.2.2</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> -<li class="toctree-l1 has-children"><a class="reference internal" href="output/botcore.html">Botcore</a><input 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> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.exts.html">Exts</a></li> -<li class="toctree-l2 has-children"><a class="reference internal" href="output/botcore.utils.html">Utils</a><input 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> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.regex.html">regex</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.scheduling.html">scheduling</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.async_stats.html">async_stats</a></li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.site_api.html">site_api</a></li> -</ul> -</li> -</ul> -<p class="caption" role="heading"><span class="caption-text">Other:</span></p> -<ul class="current"> -<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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/changelog.html">main</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.9.2/changelog.html">v9.9.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.9.1/changelog.html">v9.9.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.9.0/changelog.html">v9.9.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.8.0/changelog.html">v9.8.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.7.0/changelog.html">v9.7.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.6.0/changelog.html">v9.6.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.5.1/changelog.html">v9.5.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.5.0/changelog.html">v9.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.4.1/changelog.html">v9.4.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.4.0/changelog.html">v9.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.3.0/changelog.html">v9.3.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.2.0/changelog.html">v9.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.10.0-alpha.2/changelog.html">v9.10.0-alpha.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.10.0-alpha.1/changelog.html">v9.10.0-alpha.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.1.1/changelog.html">v9.1.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v9.0.0/changelog.html">v9.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.3.0-beta/changelog.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.2.1/changelog.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.2.0/changelog.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.1.0/changelog.html">v8.1.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.0.0-beta.4/changelog.html">v8.0.0-beta.4</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.0.0-beta.3/changelog.html">v8.0.0-beta.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.0.0-beta.2/changelog.html">v8.0.0-beta.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.0.0-beta.1/changelog.html">v8.0.0-beta.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v8.0.0/changelog.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.5.0/changelog.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.4.0-beta1/changelog.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.4.0/changelog.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.3.1/changelog.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.3.0/changelog.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="changelog.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.1/changelog.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0/changelog.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.1.3/changelog.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.1.2/changelog.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.1.1/changelog.html">v7.1.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.7.0/changelog.html">v10.7.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.6.0/changelog.html">v10.6.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.5.1/changelog.html">v10.5.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.5.0/changelog.html">v10.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.4.0/changelog.html">v10.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.3.0/changelog.html">v10.3.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.2.0/changelog.html">v10.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.1.0/changelog.html">v10.1.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v10.0.0/changelog.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 no-toc" 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="changelog"> -<h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading">#</a></h1> -<section id="7.2.2"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v7.2.2">7.2.2</a> <span style="font-size: 75%;">9th July 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/98">#98</a><span>:</span> Only close <code class="docutils literal notranslate"><span class="pre">BotBase.stats._transport</span></code> if <code class="docutils literal notranslate"><span class="pre">BotBase.stats</span></code> was created</p></li> -</ul> -</section> -<section id="7.2.1"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v7.2.1">7.2.1</a> <span style="font-size: 75%;">30th June 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/91">#91</a><span>:</span> Add missing await to <code class="docutils literal notranslate"><span class="pre">BotBase.ping_services</span></code> in some cases.</p></li> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/91">#91</a><span>:</span> Pass missing self parameter to <code class="docutils literal notranslate"><span class="pre">BotBase.ping_services</span></code>.</p></li> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/91">#91</a><span>:</span> Fix incorrect docstring for <code class="docutils literal notranslate"><span class="pre">botcore.utils.member.handle_role_change</span></code>.</p></li> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/96">#96</a><span>:</span> Fix attempts to connect to <code class="docutils literal notranslate"><span class="pre">BotBase.statsd_url</span></code> when it is None.</p></li> -</ul> -</section> -<section id="7.2.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v7.2.0">7.2.0</a> <span style="font-size: 75%;">28th June 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/93">#93</a><span>:</span> Bump Discord.py to <a class="reference external" href="https://github.com/Rapptz/discord.py/commit/0eb3d26343969a25ffc43ba72eca42538d2e7e7a"><code class="docutils literal notranslate"><span class="pre">0eb3d26</span></code></a>:</p> -<ul> -<li><p>Adds support for auto mod, of which the new auto_mod MESSAGE_TYPE is needed for our filter system.</p></li> -</ul> -</li> -</ul> -</section> -<section id="7.1.3"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v7.1.3">7.1.3</a> <span style="font-size: 75%;">30th May 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/79">#79</a><span>:</span> Restore on-site changelog.</p></li> -<li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/79">#79</a><span>:</span> Add <a class="reference external" href="https://pypi.org/project/sphinx-multiversion/">sphinx-multiversion</a> to make available older doc versions.</p></li> -</ul> -</section> -<section id="7.1.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v7.1.0">7.1.0</a> <span style="font-size: 75%;">24th May 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/78">#78</a><span>:</span> Bump Discord.py to <a class="reference external" href="https://github.com/Rapptz/discord.py/tree/4cbe8f58e16f6a76371ce45a69e0832130d6d24f"><code class="docutils literal notranslate"><span class="pre">4cbe8f5</span></code></a>:</p> -<ul> -<li><p>This fixes a bug with permission resolution when dealing with timed out members.</p></li> -</ul> -</li> -</ul> -</section> -<section id="7.0.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v7.0.0">7.0.0</a> <span style="font-size: 75%;">10th May 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #F50F10;">Breaking</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/75">#75</a><span>:</span> Discord invite regex no longer returns a URL safe result, refer to documentation for safely handling it.</p></li> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/75">#75</a><span>:</span> Capture all characters up to a whitespace in the Discord Invite regex.</p></li> -</ul> -</section> -<section id="6.4.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v6.4.0">6.4.0</a> <span style="font-size: 75%;">26th April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/72">#72</a><span>:</span> Bump discord.py to <a class="reference external" href="https://github.com/Rapptz/discord.py/tree/5a06fa5f3e28d2b7191722e1a84c541560008aea"><code class="docutils literal notranslate"><span class="pre">5a06fa5</span></code></a>:</p> -<ul> -<li><p>Notably, one of the commits in this bump dynamically extends the timeout of <code class="docutils literal notranslate"><span class="pre">Guild.chunk()</span></code> based on the number or members, so it should actually work on our guild now.</p></li> -</ul> -</li> -</ul> -</section> -<section id="6.3.2"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v6.3.2">6.3.2</a> <span style="font-size: 75%;">25th April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/69">#69</a><span>:</span> Actually use <code class="docutils literal notranslate"><span class="pre">statsd_url</span></code> when it gets passed to <code class="docutils literal notranslate"><span class="pre">BotBase</span></code>.</p></li> -</ul> -</section> -<section id="6.3.1"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v6.3.1">6.3.1</a> <span style="font-size: 75%;">21st April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/68">#68</a><span>:</span> Correct version number in pyproject.toml</p></li> -</ul> -</section> -<section id="6.3.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v6.3.0">6.3.0</a> <span style="font-size: 75%;">21st April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span>:</span><span> </span> (Committed directly to main) Don’t load modules starting with <code class="docutils literal notranslate"><span class="pre">_</span></code></p></li> -</ul> -</section> -<section id="6.2.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v6.2.0">6.2.0</a> <span style="font-size: 75%;">21st April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/66">#66</a><span>:</span> Load each cog in it’s own task to avoid a single cog crashing entire load process.</p></li> -</ul> -</section> -<section id="6.1.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v6.1.0">6.1.0</a> <span style="font-size: 75%;">20th April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/65">#65</a><span>:</span> Add <code class="docutils literal notranslate"><span class="pre">unqualify</span></code> to the <code class="docutils literal notranslate"><span class="pre">botcore.utils</span></code> namespace for use in bots that manipulate extensions.</p></li> -</ul> -</section> -<section id="6.0.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v6.0.0">6.0.0</a> <span style="font-size: 75%;">19th April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #F50F10;">Breaking</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/64">#64</a><span>:</span> Bump discord.py to <a class="reference external" href="https://github.com/Rapptz/discord.py/tree/987235d5649e7c2b1a927637bab6547244ecb2cf"><code class="docutils literal notranslate"><span class="pre">987235d</span></code></a>:</p> -<ul> -<li><p>This reverts a change to help command behaviour that broke our custom pagination</p></li> -<li><p>This also adds basic forum channel support to discord.py</p></li> -</ul> -</li> -</ul> -</section> -<section id="5.0.4"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v5.0.4">5.0.4</a> <span style="font-size: 75%;">18th April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/63">#63</a><span>:</span> Allow passing an <code class="docutils literal notranslate"><span class="pre">api_client</span></code> to <code class="docutils literal notranslate"><span class="pre">BotBase.__init__</span></code> to specify the <code class="docutils literal notranslate"><span class="pre">botcore.site_api.APIClient</span></code> instance to use.</p></li> -</ul> -</section> -<section id="5.0.3"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v5.0.3">5.0.3</a> <span style="font-size: 75%;">18th April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/61">#61</a><span>:</span> Reconnect to redis session on setup if it is closed.</p></li> -</ul> -</section> -<section id="5.0.2"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v5.0.2">5.0.2</a> <span style="font-size: 75%;">5th April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/56">#56</a><span>:</span> Move the creation of the <code class="docutils literal notranslate"><span class="pre">asyncio.Event</span></code>, <code class="docutils literal notranslate"><span class="pre">BotBase._guild_available</span></code> to within the setup hook, to avoid a deprecation notice.</p></li> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/56">#56</a><span>:</span> Create a dummy <code class="docutils literal notranslate"><span class="pre">AsyncstatsdClient</span></code> before connecting to real url, in case a connection cannot be made on init.</p></li> -</ul> -</section> -<section id="5.0.1"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v5.0.1">5.0.1</a> <span style="font-size: 75%;">2nd April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/54">#54</a><span>:</span> Move creation of BotBase’s <code class="docutils literal notranslate"><span class="pre">aiohttp.AsyncResolver</span></code> to the async setup hook, to avoid deprecation notice</p></li> -</ul> -</section> -<section id="5.0.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v5.0.0">5.0.0</a> <span style="font-size: 75%;">2nd April 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #F50F10;">Breaking</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/42">#42</a><span>:</span> Remove public extensions util.</p></li> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/42">#42</a><span>:</span> Add async statsd client.</p></li> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/42">#42</a><span>:</span> Add <code class="docutils literal notranslate"><span class="pre">BotBase</span></code>, a <code class="docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code> sub-class, which abstracts a lot of logic shared between our bots.</p></li> -<li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/42">#42</a><span>:</span> Bump Discord.py to latest alpha commit.</p></li> -</ul> -</section> -<section id="4.0.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v4.0.0">4.0.0</a> <span style="font-size: 75%;">14th March 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #F50F10;">Breaking</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/39">#39</a><span>:</span> Migrate back to Discord.py 2.0.</p></li> -</ul> -</section> -<section id="3.0.1"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v3.0.1">3.0.1</a> <span style="font-size: 75%;">5th March 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/37">#37</a><span>:</span> Setup log tracing when <code class="docutils literal notranslate"><span class="pre">botcore.utils.logging</span></code> is imported so that it can be used within botcore functions.</p></li> -</ul> -</section> -<section id="3.0.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v3.0.0">3.0.0</a> <span style="font-size: 75%;">3rd March 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #F50F10;">Breaking</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/35">#35</a><span>:</span> Move <code class="docutils literal notranslate"><span class="pre">apply_monkey_patches()</span></code> directly to <cite>botcore.utils</cite> namespace.</p></li> -</ul> -</section> -<section id="2.1.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v2.1.0">2.1.0</a> <span style="font-size: 75%;">24th February 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/34">#34</a><span>:</span> Port the Site API wrapper from the bot repo.</p></li> -</ul> -</section> -<section id="2.0.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v2.0.0">2.0.0</a> <span style="font-size: 75%;">22nd February 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #F50F10;">Breaking</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/32">#32</a><span>:</span> Migrate from discord.py 2.0a0 to disnake.</p></li> -<li><p>[<span style="color: #F50F10;">Breaking</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/35">#35</a><span>:</span> Moved regex to <code class="docutils literal notranslate"><span class="pre">botcore.utils</span></code> namespace</p></li> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/29">#29</a><span>:</span> Port many common utilities from our bots:</p> -<ul> -<li><p>caching</p></li> -<li><p>channel</p></li> -<li><p>extensions</p></li> -<li><p>loggers</p></li> -<li><p>members</p></li> -<li><p>scheduling</p></li> -</ul> -</li> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/32">#32</a><span>:</span> Add common monkey patches.</p></li> -<li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/2">#2</a><span>:</span> Added intersphinx to docs.</p></li> -</ul> -</section> -<section id="1.2.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v1.2.0">1.2.0</a> <span style="font-size: 75%;">9th January 2022</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/12">#12</a><span>:</span> Code block detection regex.</p></li> -</ul> -</section> -<section id="1.1.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v1.1.0">1.1.0</a> <span style="font-size: 75%;">2nd December 2021</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/2">#2</a><span>:</span> Regex utility.</p></li> -<li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/2">#2</a><span>:</span> Autogenerated docs.</p></li> -</ul> -</section> -<section id="1.0.0"> -<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v1.0.0">1.0.0</a> <span style="font-size: 75%;">17th November 2021</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/1">#1</a><span>:</span> Core package, poetry, and linting CI.</p></li> -</ul> -</section> -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - - <a class="prev-page" href="output/botcore.site_api.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">site_api</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 no-toc"> - - - - </aside> - </div> -</div><script src="_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/genindex.html b/v7.2.2/genindex.html deleted file mode 100644 index b972ae38..00000000 --- a/v7.2.2/genindex.html +++ /dev/null @@ -1,872 +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"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.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>Index - Pydis Core v7.2.2</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.2.2</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 no-toc" 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.2.2</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> -<li class="toctree-l1 has-children"><a class="reference internal" href="output/botcore.html">Botcore</a><input 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> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.exts.html">Exts</a></li> -<li class="toctree-l2 has-children"><a class="reference internal" href="output/botcore.utils.html">Utils</a><input 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> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.regex.html">regex</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.scheduling.html">scheduling</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.async_stats.html">async_stats</a></li> -<li class="toctree-l2"><a class="reference internal" href="output/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/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 current-page"> - <a class="version_link reference internal" href="genindex.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/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 no-toc" 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 class="genindex-section"> - <h1 id="index">Index</h1> - <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#W"><strong>W</strong></a></div> -</section> -<section id="_" class="genindex-section"> - <h2>_</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.caching.html#botcore.utils.caching.AsyncCache.__call__">__call__() (AsyncCache method)</a> -</li> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.__contains__">__contains__() (Scheduler method)</a> -</li> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.__init__">__init__() (APIClient method)</a> - - <ul> - <li><a href="output/botcore.utils.caching.html#botcore.utils.caching.AsyncCache.__init__">(AsyncCache method)</a> -</li> - <li><a href="output/botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.__init__">(AsyncStatsClient method)</a> -</li> - <li><a href="output/botcore.html#botcore.BotBase.__init__">(BotBase method)</a> -</li> - <li><a href="output/botcore.site_api.html#botcore.site_api.ResponseCodeError.__init__">(ResponseCodeError method)</a> -</li> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.__init__">(Scheduler method)</a> -</li> - <li><a href="output/botcore.html#botcore.StartupError.__init__">(StartupError method)</a> -</li> - </ul></li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.ResponseCodeError.__str__">__str__() (ResponseCodeError method)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="A" class="genindex-section"> - <h2>A</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.html#botcore.BotBase.add_cog">add_cog() (BotBase method)</a> -</li> - <li><a href="output/botcore.html#botcore.BotBase.add_command">add_command() (BotBase method)</a> -</li> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient">APIClient (class in botcore.site_api)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.html#botcore.utils.apply_monkey_patches">apply_monkey_patches() (in module botcore.utils)</a> -</li> - <li><a href="output/botcore.utils.caching.html#botcore.utils.caching.AsyncCache">AsyncCache (class in botcore.utils.caching)</a> -</li> - <li><a href="output/botcore.async_stats.html#botcore.async_stats.AsyncStatsClient">AsyncStatsClient (class in botcore.async_stats)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="B" class="genindex-section"> - <h2>B</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.html#botcore.BotBase">BotBase (class in botcore)</a> -</li> - <li> - botcore - - <ul> - <li><a href="output/botcore.html#module-botcore">module</a> -</li> - </ul></li> - <li> - botcore.async_stats - - <ul> - <li><a href="output/botcore.async_stats.html#module-botcore.async_stats">module</a> -</li> - </ul></li> - <li> - botcore.exts - - <ul> - <li><a href="output/botcore.exts.html#module-botcore.exts">module</a> -</li> - </ul></li> - <li> - botcore.site_api - - <ul> - <li><a href="output/botcore.site_api.html#module-botcore.site_api">module</a> -</li> - </ul></li> - <li> - botcore.utils - - <ul> - <li><a href="output/botcore.utils.html#module-botcore.utils">module</a> -</li> - </ul></li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li> - botcore.utils.caching - - <ul> - <li><a href="output/botcore.utils.caching.html#module-botcore.utils.caching">module</a> -</li> - </ul></li> - <li> - botcore.utils.channel - - <ul> - <li><a href="output/botcore.utils.channel.html#module-botcore.utils.channel">module</a> -</li> - </ul></li> - <li> - botcore.utils.logging - - <ul> - <li><a href="output/botcore.utils.logging.html#module-botcore.utils.logging">module</a> -</li> - </ul></li> - <li> - botcore.utils.members - - <ul> - <li><a href="output/botcore.utils.members.html#module-botcore.utils.members">module</a> -</li> - </ul></li> - <li> - botcore.utils.regex - - <ul> - <li><a href="output/botcore.utils.regex.html#module-botcore.utils.regex">module</a> -</li> - </ul></li> - <li> - botcore.utils.scheduling - - <ul> - <li><a href="output/botcore.utils.scheduling.html#module-botcore.utils.scheduling">module</a> -</li> - </ul></li> - </ul></td> - </tr></table> -</section> - -<section id="C" class="genindex-section"> - <h2>C</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.cancel">cancel() (Scheduler method)</a> -</li> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.cancel_all">cancel_all() (Scheduler method)</a> -</li> - <li><a href="output/botcore.utils.caching.html#botcore.utils.caching.AsyncCache.clear">clear() (AsyncCache method)</a> - - <ul> - <li><a href="output/botcore.html#botcore.BotBase.clear">(BotBase method)</a> -</li> - </ul></li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.close">close() (APIClient method)</a> - - <ul> - <li><a href="output/botcore.html#botcore.BotBase.close">(BotBase method)</a> -</li> - </ul></li> - <li><a href="output/botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket">create_socket() (AsyncStatsClient method)</a> -</li> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.create_task">create_task() (in module botcore.utils.scheduling)</a> -</li> - <li><a href="output/botcore.utils.logging.html#botcore.utils.logging.CustomLogger">CustomLogger (class in botcore.utils.logging)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="D" class="genindex-section"> - <h2>D</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.delete">delete() (APIClient method)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.regex.html#botcore.utils.regex.DISCORD_INVITE">DISCORD_INVITE (in module botcore.utils.regex)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="F" class="genindex-section"> - <h2>F</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.regex.html#botcore.utils.regex.FORMATTED_CODE_REGEX">FORMATTED_CODE_REGEX (in module botcore.utils.regex)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="G" class="genindex-section"> - <h2>G</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.get">get() (APIClient method)</a> -</li> - <li><a href="output/botcore.utils.logging.html#botcore.utils.logging.get_logger">get_logger() (in module botcore.utils.logging)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.channel.html#botcore.utils.channel.get_or_fetch_channel">get_or_fetch_channel() (in module botcore.utils.channel)</a> -</li> - <li><a href="output/botcore.utils.members.html#botcore.utils.members.get_or_fetch_member">get_or_fetch_member() (in module botcore.utils.members)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="H" class="genindex-section"> - <h2>H</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.members.html#botcore.utils.members.handle_role_change">handle_role_change() (in module botcore.utils.members)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="I" class="genindex-section"> - <h2>I</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.channel.html#botcore.utils.channel.is_in_category">is_in_category() (in module botcore.utils.channel)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="L" class="genindex-section"> - <h2>L</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.html#botcore.BotBase.load_extensions">load_extensions() (BotBase method)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.html#botcore.BotBase.log_to_dev_log">log_to_dev_log() (BotBase method)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="M" class="genindex-section"> - <h2>M</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.maybe_raise_for_status">maybe_raise_for_status() (APIClient static method)</a> -</li> - <li> - module - - <ul> - <li><a href="output/botcore.html#module-botcore">botcore</a> -</li> - <li><a href="output/botcore.async_stats.html#module-botcore.async_stats">botcore.async_stats</a> -</li> - <li><a href="output/botcore.exts.html#module-botcore.exts">botcore.exts</a> -</li> - <li><a href="output/botcore.site_api.html#module-botcore.site_api">botcore.site_api</a> -</li> - <li><a href="output/botcore.utils.html#module-botcore.utils">botcore.utils</a> -</li> - <li><a href="output/botcore.utils.caching.html#module-botcore.utils.caching">botcore.utils.caching</a> -</li> - <li><a href="output/botcore.utils.channel.html#module-botcore.utils.channel">botcore.utils.channel</a> -</li> - <li><a href="output/botcore.utils.logging.html#module-botcore.utils.logging">botcore.utils.logging</a> -</li> - <li><a href="output/botcore.utils.members.html#module-botcore.utils.members">botcore.utils.members</a> -</li> - <li><a href="output/botcore.utils.regex.html#module-botcore.utils.regex">botcore.utils.regex</a> -</li> - <li><a href="output/botcore.utils.scheduling.html#module-botcore.utils.scheduling">botcore.utils.scheduling</a> -</li> - </ul></li> - </ul></td> - </tr></table> -</section> - -<section id="O" class="genindex-section"> - <h2>O</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.html#botcore.BotBase.on_guild_available">on_guild_available() (BotBase method)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.html#botcore.BotBase.on_guild_unavailable">on_guild_unavailable() (BotBase method)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="P" class="genindex-section"> - <h2>P</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.patch">patch() (APIClient method)</a> -</li> - <li><a href="output/botcore.html#botcore.BotBase.ping_services">ping_services() (BotBase method)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.post">post() (APIClient method)</a> -</li> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.put">put() (APIClient method)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="R" class="genindex-section"> - <h2>R</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.regex.html#botcore.utils.regex.RAW_CODE_REGEX">RAW_CODE_REGEX (in module botcore.utils.regex)</a> -</li> - <li><a href="output/botcore.html#botcore.BotBase.remove_command">remove_command() (BotBase method)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.request">request() (APIClient method)</a> -</li> - <li><a href="output/botcore.site_api.html#botcore.site_api.ResponseCodeError">ResponseCodeError</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="S" class="genindex-section"> - <h2>S</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.schedule">schedule() (Scheduler method)</a> -</li> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.schedule_at">schedule_at() (Scheduler method)</a> -</li> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.schedule_later">schedule_later() (Scheduler method)</a> -</li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler">Scheduler (class in botcore.utils.scheduling)</a> -</li> - <li><a href="output/botcore.html#botcore.BotBase.setup_hook">setup_hook() (BotBase method)</a> -</li> - <li><a href="output/botcore.html#botcore.StartupError">StartupError</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="T" class="genindex-section"> - <h2>T</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.logging.html#botcore.utils.logging.CustomLogger.trace">trace() (CustomLogger method)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="U" class="genindex-section"> - <h2>U</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.html#botcore.utils.unqualify">unqualify() (in module botcore.utils)</a> -</li> - </ul></td> - </tr></table> -</section> - -<section id="W" class="genindex-section"> - <h2>W</h2> - <table style="width: 100%" class="indextable genindextable"><tr> - <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.html#botcore.BotBase.wait_until_guild_available">wait_until_guild_available() (BotBase method)</a> -</li> - </ul></td> - </tr></table> -</section> - - - </article> - </div> - <footer> - - <div class="related-pages"> - - - </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 no-toc"> - - - - </aside> - </div> -</div><script src="_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/index.html b/v7.2.2/index.html deleted file mode 100644 index 478587fe..00000000 --- a/v7.2.2/index.html +++ /dev/null @@ -1,555 +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="Botcore" href="output/botcore.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>Pydis Core v7.2.2</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="#"><div class="brand">Pydis Core v7.2.2</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 no-toc" 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="#"> - - <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.2.2</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> -<li class="toctree-l1 has-children"><a class="reference internal" href="output/botcore.html">Botcore</a><input 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> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.exts.html">Exts</a></li> -<li class="toctree-l2 has-children"><a class="reference internal" href="output/botcore.utils.html">Utils</a><input 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> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.regex.html">regex</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.scheduling.html">scheduling</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.async_stats.html">async_stats</a></li> -<li class="toctree-l2"><a class="reference internal" href="output/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/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 current-page"> - <a class="version_link reference internal" href="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/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 no-toc" 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="bot-core-project-documentation"> -<h1>Bot Core Project Documentation<a class="headerlink" href="#bot-core-project-documentation" title="Link to this heading">#</a></h1> -</section> -<section id="reference"> -<h1>Reference<a class="headerlink" href="#reference" title="Link to this heading">#</a></h1> -<div class="toctree-wrapper compound"> -<p class="caption" role="heading"><span class="caption-text">Modules:</span></p> -<ul> -<li class="toctree-l1"><a class="reference internal" href="output/botcore.html">Botcore</a><ul> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.html#botcore.BotBase"><code class="docutils literal notranslate"><span class="pre">BotBase</span></code></a><ul> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.__init__"><code class="docutils literal notranslate"><span class="pre">BotBase.__init__()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.add_cog"><code class="docutils literal notranslate"><span class="pre">BotBase.add_cog()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.add_command"><code class="docutils literal notranslate"><span class="pre">BotBase.add_command()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.clear"><code class="docutils literal notranslate"><span class="pre">BotBase.clear()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.close"><code class="docutils literal notranslate"><span class="pre">BotBase.close()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.load_extensions"><code class="docutils literal notranslate"><span class="pre">BotBase.load_extensions()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.log_to_dev_log"><code class="docutils literal notranslate"><span class="pre">BotBase.log_to_dev_log()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.on_guild_available"><code class="docutils literal notranslate"><span class="pre">BotBase.on_guild_available()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.on_guild_unavailable"><code class="docutils literal notranslate"><span class="pre">BotBase.on_guild_unavailable()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.ping_services"><code class="docutils literal notranslate"><span class="pre">BotBase.ping_services()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.remove_command"><code class="docutils literal notranslate"><span class="pre">BotBase.remove_command()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.setup_hook"><code class="docutils literal notranslate"><span class="pre">BotBase.setup_hook()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.BotBase.wait_until_guild_available"><code class="docutils literal notranslate"><span class="pre">BotBase.wait_until_guild_available()</span></code></a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.html#botcore.StartupError"><code class="docutils literal notranslate"><span class="pre">StartupError</span></code></a><ul> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.html#botcore.StartupError.__init__"><code class="docutils literal notranslate"><span class="pre">StartupError.__init__()</span></code></a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.html#subpackages">Subpackages</a><ul> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.exts.html">Exts</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.html">Utils</a><ul> -<li class="toctree-l4"><a class="reference internal" href="output/botcore.utils.html#botcore.utils.apply_monkey_patches"><code class="docutils literal notranslate"><span class="pre">apply_monkey_patches()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="output/botcore.utils.html#botcore.utils.unqualify"><code class="docutils literal notranslate"><span class="pre">unqualify()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="output/botcore.utils.html#submodules">Submodules</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.html#submodules">Submodules</a><ul> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.async_stats.html">async_stats</a><ul> -<li class="toctree-l4"><a class="reference internal" href="output/botcore.async_stats.html#botcore.async_stats.AsyncStatsClient"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.site_api.html">site_api</a><ul> -<li class="toctree-l4"><a class="reference internal" href="output/botcore.site_api.html#botcore.site_api.APIClient"><code class="docutils literal notranslate"><span class="pre">APIClient</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="output/botcore.site_api.html#botcore.site_api.ResponseCodeError"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a></li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="toctree-wrapper compound"> -</div> -</section> -<section id="extras"> -<h1>Extras<a class="headerlink" href="#extras" title="Link to this heading">#</a></h1> -<ul class="simple"> -<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> -<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> -<li><p><a class="reference external" href="https://github.com/python-discord/bot-core/blob/main/docs/README.md">Information</a></p></li> -<li><p><a class="reference internal" href="changelog.html"><span class="doc">Changelog</span></a></p></li> -</ul> -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="output/botcore.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">Botcore</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </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 no-toc"> - - - - </aside> - </div> -</div><script src="_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/index_redirect.html b/v7.2.2/index_redirect.html deleted file mode 100644 index 3173e8fe..00000000 --- a/v7.2.2/index_redirect.html +++ /dev/null @@ -1,63 +0,0 @@ -<!doctype html> -<html class="no-js" lang="en" data-content_root="./"> - <head> - - <script>window.location.replace("./main/index.html")</script> - <meta charset="utf-8"/> - <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.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>Pydis Core v7.2.2</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> - - <div style="display: flex; text-align: center; justify-content: center; align-items: center; height: 100%;"> - <h2><a href="./main/index.html"> - Please click here if you were not redirected to the latest build. - </a></h2> - </div> -<script src="_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/objects.inv b/v7.2.2/objects.inv Binary files differdeleted file mode 100644 index bfc32520..00000000 --- a/v7.2.2/objects.inv +++ /dev/null diff --git a/v7.2.2/output/botcore.async_stats.html b/v7.2.2/output/botcore.async_stats.html deleted file mode 100644 index baeabd97..00000000 --- a/v7.2.2/output/botcore.async_stats.html +++ /dev/null @@ -1,560 +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="site_api" href="botcore.site_api.html" /><link rel="prev" title="scheduling" href="botcore.utils.scheduling.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>async_stats - Pydis Core v7.2.2</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.2.2</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.2.2</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 has-children"><a class="reference internal" href="botcore.utils.html">Utils</a><input 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> -<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.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 current current-page"><a class="current reference internal" href="#">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.async_stats.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.async_stats.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.async_stats.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.async_stats.html">v8.1.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.async_stats.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.async_stats.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.async_stats.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.async_stats.html">v8.0.0-beta.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0/output/botcore.async_stats.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.async_stats.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.async_stats.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.async_stats.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.async_stats.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.async_stats.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.async_stats.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.async_stats.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.async_stats.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.async_stats.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.async_stats.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.async_stats.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.async_stats"> -<span id="async-stats"></span><h1>async_stats<a class="headerlink" href="#module-botcore.async_stats" title="Link to this heading">#</a></h1> -<p>An async transport method for statsd communication.</p> -<dl class="py class"> -<dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Link to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatsClientBase</span></code></a></p> -<p>An async implementation of <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statsd.client.base.StatsClientBase</span></code></a> that supports async stat communication.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.__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">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/async_stats.py#L15-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.__init__" title="Link to this definition">#</a></dt> -<dd><p>Create a new <a class="reference internal" href="#botcore.async_stats.AsyncStatsClient" title="botcore.async_stats.AsyncStatsClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a>.</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>loop</strong> (<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop" title="(in Python v3.12)"><em>asyncio.AbstractEventLoop</em></a>) – The event loop to use when creating the -<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a>.</p></li> -<li><p><strong>host</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 host to connect to.</p></li> -<li><p><strong>port</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 port to connect to.</p></li> -<li><p><strong>prefix</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 prefix to use for all stats.</p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.create_socket"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/async_stats.py#L40-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.create_socket" title="Link to this definition">#</a></dt> -<dd><p>Use <a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a> from the loop given on init to create a socket.</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.site_api.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">site_api</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.utils.scheduling.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">scheduling</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="#">async_stats</a><ul> -<li><a class="reference internal" href="#botcore.async_stats.AsyncStatsClient"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a><ul> -<li><a class="reference internal" href="#botcore.async_stats.AsyncStatsClient.__init__"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient.__init__()</span></code></a></li> -<li><a class="reference internal" href="#botcore.async_stats.AsyncStatsClient.create_socket"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket()</span></code></a></li> -</ul> -</li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.exts.html b/v7.2.2/output/botcore.exts.html deleted file mode 100644 index f89e3a0d..00000000 --- a/v7.2.2/output/botcore.exts.html +++ /dev/null @@ -1,502 +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="Utils" href="botcore.utils.html" /><link rel="prev" title="Botcore" href="botcore.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>Exts - Pydis Core v7.2.2</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.2.2</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 no-toc" 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.2.2</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 current current-page"><a class="current reference internal" href="#">Exts</a></li> -<li class="toctree-l2 has-children"><a class="reference internal" href="botcore.utils.html">Utils</a><input 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> -<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.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.exts.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.exts.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.exts.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.exts.html">v8.1.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.exts.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.exts.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.exts.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.exts.html">v8.0.0-beta.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0/output/botcore.exts.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.exts.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.exts.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.exts.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.exts.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.exts.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.exts.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.exts.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.exts.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.exts.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.exts.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.exts.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 no-toc" 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.exts"> -<span id="exts"></span><h1>Exts<a class="headerlink" href="#module-botcore.exts" title="Link to this heading">#</a></h1> -<p>Reusable Discord cogs.</p> -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="botcore.utils.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">Utils</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.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">Botcore</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 no-toc"> - - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.html b/v7.2.2/output/botcore.html deleted file mode 100644 index 9b17fcf2..00000000 --- a/v7.2.2/output/botcore.html +++ /dev/null @@ -1,803 +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="Exts" href="botcore.exts.html" /><link rel="prev" title="Bot Core Project Documentation" href="../index.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>Botcore - Pydis Core v7.2.2</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.2.2</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.2.2</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 current-page"><a class="current reference internal" href="#">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> -<li class="toctree-l2"><a class="reference internal" href="botcore.exts.html">Exts</a></li> -<li class="toctree-l2 has-children"><a class="reference internal" href="botcore.utils.html">Utils</a><input 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> -<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.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.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.html">v8.1.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.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.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.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.html">v8.0.0-beta.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0/output/botcore.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.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"> -<span id="botcore"></span><h1>Botcore<a class="headerlink" href="#module-botcore" title="Link to this heading">#</a></h1> -<p>Useful utilities and tools for Discord bot development.</p> -<dl class="py class"> -<dt class="sig sig-object py" id="botcore.BotBase"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</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="n"><span class="pre">api_client</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="n"><span class="pre">statsd_url</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L36-L292"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Link to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></p> -<p>A sub-class that implements many common features that Python Discord bots use.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.BotBase.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</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="n"><span class="pre">api_client</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="n"><span class="pre">statsd_url</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L39-L89"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.__init__" title="Link to this definition">#</a></dt> -<dd><p>Initialise the base bot instance.</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>guild_id</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 ID of the guild use for <a class="reference internal" href="#botcore.BotBase.wait_until_guild_available" title="botcore.BotBase.wait_until_guild_available"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait_until_guild_available()</span></code></a>.</p></li> -<li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></span>) – A list of role IDs that the bot is allowed to mention.</p></li> -<li><p><strong>http_session</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.9)"><em>aiohttp.ClientSession</em></a>) – The session to use for the bot.</p></li> -<li><p><strong>redis_session</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">RedisSession</span></code>]</span>) – The <a class="reference external" href="https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession">async_rediscache.RedisSession</a> to use for the bot.</p></li> -<li><p><strong>api_client</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIClient</span></code></a>]</span>) – The <a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">botcore.site_api.APIClient</span></code></a> instance to use for the bot.</p></li> -<li><p><strong>statsd_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<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 URL of the statsd server to use for the bot. If not given, -a dummy statsd client will be created.</p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.BotBase.add_cog"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L152-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_cog" title="Link to this definition">#</a></dt> -<dd><p>Add the given <code class="docutils literal notranslate"><span class="pre">cog</span></code> to the bot and log the operation.</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.BotBase.add_command"> -<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L157-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_command" title="Link to this definition">#</a></dt> -<dd><p>Add <code class="docutils literal notranslate"><span class="pre">command</span></code> as normal and then add its root aliases to the bot.</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.BotBase.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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L177-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.clear" title="Link to this definition">#</a></dt> -<dd><p>Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.</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.BotBase.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L258-L292"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.close" title="Link to this definition">#</a></dt> -<dd><p>Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.</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.BotBase.load_extensions"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Link to this definition">#</a></dt> -<dd><p>Load all the extensions within the given module and save them to <code class="docutils literal notranslate"><span class="pre">self.all_extensions</span></code>.</p> -<p>This should be ran in a task on the event loop to avoid deadlocks caused by <code class="docutils literal notranslate"><span class="pre">wait_for</span></code> calls.</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.BotBase.log_to_dev_log"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L205-L208"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.log_to_dev_log" title="Link to this definition">#</a></dt> -<dd><p>Log the given message to #dev-log.</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.BotBase.on_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Link to this definition">#</a></dt> -<dd><p>Set the internal guild available event when self.guild_id becomes available.</p> -<p>If the cache appears to still be empty (no members, no channels, or no roles), the event -will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</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.BotBase.on_guild_unavailable"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L181-L187"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_unavailable" title="Link to this definition">#</a></dt> -<dd><p>Clear the internal guild available event when self.guild_id becomes unavailable.</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.BotBase.ping_services"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L254-L257"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.ping_services" title="Link to this definition">#</a></dt> -<dd><p>Ping all required services on setup to ensure they are up before starting.</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.BotBase.remove_command"> -<span class="sig-name descname"><span class="pre">remove_command</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Link to this definition">#</a></dt> -<dd><p>Remove a command/alias as normal and then remove its root aliases from the bot.</p> -<p>Individual root aliases cannot be removed by this function. -To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</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/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a>]</span></p> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.BotBase.setup_hook"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L218-L253"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Link to this definition">#</a></dt> -<dd><p>An async init to startup generic services.</p> -<p>Connects to statsd, and calls -<a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket" title="botcore.async_stats.AsyncStatsClient.create_socket"><code class="xref py py-func docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket</span></code></a> -and <a class="reference internal" href="#botcore.BotBase.ping_services" title="botcore.BotBase.ping_services"><code class="xref py py-func docutils literal notranslate"><span class="pre">ping_services()</span></code></a>.</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.BotBase.wait_until_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Link to this definition">#</a></dt> -<dd><p>Wait until the guild that matches the <code class="docutils literal notranslate"><span class="pre">guild_id</span></code> given at init is available (and the cache is ready).</p> -<p>The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE -gateway event before giving up and thus not populating the cache for unavailable guilds.</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> - -<dl class="py exception"> -<dt class="sig sig-object py" id="botcore.StartupError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Link to this definition">#</a></dt> -<dd><p>Bases: <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></p> -<p>Exception class for startup errors.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.StartupError.__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">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/_bot.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Link to this definition">#</a></dt> -<dd></dd></dl> - -</dd></dl> - -<section id="subpackages"> -<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading">#</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="botcore.exts.html">Exts</a></li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.html">Utils</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.html#botcore.utils.apply_monkey_patches"><code class="docutils literal notranslate"><span class="pre">apply_monkey_patches()</span></code></a></li> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.html#botcore.utils.unqualify"><code class="docutils literal notranslate"><span class="pre">unqualify()</span></code></a></li> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.html#submodules">Submodules</a><ul> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a><ul> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.caching.html#botcore.utils.caching.AsyncCache"><code class="docutils literal notranslate"><span class="pre">AsyncCache</span></code></a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a><ul> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.channel.html#botcore.utils.channel.get_or_fetch_channel"><code class="docutils literal notranslate"><span class="pre">get_or_fetch_channel()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.channel.html#botcore.utils.channel.is_in_category"><code class="docutils literal notranslate"><span class="pre">is_in_category()</span></code></a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.logging.html">logging</a><ul> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.logging.html#botcore.utils.logging.CustomLogger"><code class="docutils literal notranslate"><span class="pre">CustomLogger</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.logging.html#botcore.utils.logging.get_logger"><code class="docutils literal notranslate"><span class="pre">get_logger()</span></code></a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.members.html">members</a><ul> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.members.html#botcore.utils.members.get_or_fetch_member"><code class="docutils literal notranslate"><span class="pre">get_or_fetch_member()</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.members.html#botcore.utils.members.handle_role_change"><code class="docutils literal notranslate"><span class="pre">handle_role_change()</span></code></a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.regex.html">regex</a><ul> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.DISCORD_INVITE"><code class="docutils literal notranslate"><span class="pre">DISCORD_INVITE</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.FORMATTED_CODE_REGEX"><code class="docutils literal notranslate"><span class="pre">FORMATTED_CODE_REGEX</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.RAW_CODE_REGEX"><code class="docutils literal notranslate"><span class="pre">RAW_CODE_REGEX</span></code></a></li> -</ul> -</li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html">scheduling</a><ul> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler"><code class="docutils literal notranslate"><span class="pre">Scheduler</span></code></a></li> -<li class="toctree-l4"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.create_task"><code class="docutils literal notranslate"><span class="pre">create_task()</span></code></a></li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</section> -<section id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="botcore.async_stats.html">async_stats</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a><ul> -<li class="toctree-l3"><a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.__init__"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient.__init__()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket()</span></code></a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="botcore.site_api.html">site_api</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient"><code class="docutils literal notranslate"><span class="pre">APIClient</span></code></a><ul> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.__init__"><code class="docutils literal notranslate"><span class="pre">APIClient.__init__()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.close"><code class="docutils literal notranslate"><span class="pre">APIClient.close()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.delete"><code class="docutils literal notranslate"><span class="pre">APIClient.delete()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.get"><code class="docutils literal notranslate"><span class="pre">APIClient.get()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.maybe_raise_for_status"><code class="docutils literal notranslate"><span class="pre">APIClient.maybe_raise_for_status()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.patch"><code class="docutils literal notranslate"><span class="pre">APIClient.patch()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.post"><code class="docutils literal notranslate"><span class="pre">APIClient.post()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.put"><code class="docutils literal notranslate"><span class="pre">APIClient.put()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.request"><code class="docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.ResponseCodeError"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a><ul> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.ResponseCodeError.__init__"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError.__init__()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.ResponseCodeError.__str__"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError.__str__()</span></code></a></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</section> -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="botcore.exts.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">Exts</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="../index.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">Home</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="#">Botcore</a><ul> -<li><a class="reference internal" href="#botcore.BotBase"><code class="docutils literal notranslate"><span class="pre">BotBase</span></code></a><ul> -<li><a class="reference internal" href="#botcore.BotBase.__init__"><code class="docutils literal notranslate"><span class="pre">BotBase.__init__()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.add_cog"><code class="docutils literal notranslate"><span class="pre">BotBase.add_cog()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.add_command"><code class="docutils literal notranslate"><span class="pre">BotBase.add_command()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.clear"><code class="docutils literal notranslate"><span class="pre">BotBase.clear()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.close"><code class="docutils literal notranslate"><span class="pre">BotBase.close()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.load_extensions"><code class="docutils literal notranslate"><span class="pre">BotBase.load_extensions()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.log_to_dev_log"><code class="docutils literal notranslate"><span class="pre">BotBase.log_to_dev_log()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.on_guild_available"><code class="docutils literal notranslate"><span class="pre">BotBase.on_guild_available()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.on_guild_unavailable"><code class="docutils literal notranslate"><span class="pre">BotBase.on_guild_unavailable()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.ping_services"><code class="docutils literal notranslate"><span class="pre">BotBase.ping_services()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.remove_command"><code class="docutils literal notranslate"><span class="pre">BotBase.remove_command()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.setup_hook"><code class="docutils literal notranslate"><span class="pre">BotBase.setup_hook()</span></code></a></li> -<li><a class="reference internal" href="#botcore.BotBase.wait_until_guild_available"><code class="docutils literal notranslate"><span class="pre">BotBase.wait_until_guild_available()</span></code></a></li> -</ul> -</li> -<li><a class="reference internal" href="#botcore.StartupError"><code class="docutils literal notranslate"><span class="pre">StartupError</span></code></a><ul> -<li><a class="reference internal" href="#botcore.StartupError.__init__"><code class="docutils literal notranslate"><span class="pre">StartupError.__init__()</span></code></a></li> -</ul> -</li> -<li><a class="reference internal" href="#subpackages">Subpackages</a></li> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.site_api.html b/v7.2.2/output/botcore.site_api.html deleted file mode 100644 index 0b7440e5..00000000 --- a/v7.2.2/output/botcore.site_api.html +++ /dev/null @@ -1,708 +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="Changelog" href="../changelog.html" /><link rel="prev" title="async_stats" href="botcore.async_stats.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>site_api - Pydis Core v7.2.2</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.2.2</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.2.2</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 has-children"><a class="reference internal" href="botcore.utils.html">Utils</a><input 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> -<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.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 current current-page"><a class="current reference internal" href="#">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.site_api.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.site_api.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.site_api.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.site_api.html">v8.1.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.site_api.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.site_api.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.site_api.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.site_api.html">v8.0.0-beta.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.0.0/output/botcore.site_api.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.site_api.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.site_api.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.site_api.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.site_api.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.site_api.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.site_api.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.site_api.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.site_api.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.site_api.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.site_api.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.site_api.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.site_api"> -<span id="site-api"></span><h1>site_api<a class="headerlink" href="#module-botcore.site_api" title="Link to this heading">#</a></h1> -<p>An API wrapper around the Site API.</p> -<dl class="py class"> -<dt class="sig sig-object py" id="botcore.site_api.APIClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L42-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" 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>A wrapper for the Django Site API.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.APIClient.__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">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L48-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.__init__" title="Link to this definition">#</a></dt> -<dd><p>Initialize a new <a class="reference internal" href="#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">APIClient</span></code></a> instance.</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>site_api_url</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 URL of the site API.</p></li> -<li><p><strong>site_api_token</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 token to use for authentication.</p></li> -<li><p><strong>session_kwargs</strong> – Keyword arguments to pass to the <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientSession</span></code></a> constructor.</p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.APIClient.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L75-L78"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.close" title="Link to this definition">#</a></dt> -<dd><p>Close the aiohttp session.</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.site_api.APIClient.delete"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L137-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.delete" title="Link to this definition">#</a></dt> -<dd><p>Send a DELETE request to the site API and return the JSON response.</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>endpoint</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 endpoint to send the request to.</p></li> -<li><p><strong>raise_for_status</strong> (<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>) – Whether or not to raise an exception if the response is not OK.</p></li> -<li><p><strong>**kwargs</strong> – Any extra keyword arguments to pass to <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.request" title="(in aiohttp v3.9)"><code class="xref py py-func docutils literal notranslate"><span class="pre">aiohttp.request()</span></code></a>.</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/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</span></p> -</dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>The JSON response the API returns, or None if the response is 204 No Content.</p> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.APIClient.get"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L121-L124"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.get" title="Link to this definition">#</a></dt> -<dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with GET passed as the method.</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/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></span></p> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.APIClient.maybe_raise_for_status"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L79-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.maybe_raise_for_status" title="Link to this definition">#</a></dt> -<dd><p>Raise <a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> for non-OK response if an exception should be raised.</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>response</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse" title="(in aiohttp v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientResponse</span></code></a>) – The response to check.</p></li> -<li><p><strong>should_raise</strong> (<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>) – Whether or not to raise an exception.</p></li> -</ul> -</dd> -<dt class="field-even">Raises<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><strong>ResponseCodeError</strong></a> – If the response is not OK and <code class="docutils literal notranslate"><span class="pre">should_raise</span></code> is True.</p> -</dd> -<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.site_api.APIClient.patch"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L125-L128"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.patch" title="Link to this definition">#</a></dt> -<dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PATCH passed as the method.</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/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></span></p> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.APIClient.post"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L129-L132"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.post" title="Link to this definition">#</a></dt> -<dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with POST passed as the method.</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/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></span></p> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.APIClient.put"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L133-L136"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.put" title="Link to this definition">#</a></dt> -<dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PUT passed as the method.</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/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></span></p> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.APIClient.request"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L100-L120"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.request" title="Link to this definition">#</a></dt> -<dd><p>Send an HTTP request to the site API and return the JSON response.</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>method</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 HTTP method to use.</p></li> -<li><p><strong>endpoint</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 endpoint to send the request to.</p></li> -<li><p><strong>raise_for_status</strong> (<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>) – Whether or not to raise an exception if the response is not OK.</p></li> -<li><p><strong>**kwargs</strong> – Any extra keyword arguments to pass to <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.request" title="(in aiohttp v3.9)"><code class="xref py py-func docutils literal notranslate"><span class="pre">aiohttp.request()</span></code></a>.</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/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></span></p> -</dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>The JSON response the API returns.</p> -</dd> -<dt class="field-even">Raises<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><strong>ResponseCodeError</strong></a> – If the response is not OK and <code class="docutils literal notranslate"><span class="pre">raise_for_status</span></code> is True.</p> -</dd> -</dl> -</dd></dl> - -</dd></dl> - -<dl class="py exception"> -<dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</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="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Link to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a></p> -<p>Raised in <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> when a non-OK HTTP response is received.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__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">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</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="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L17-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__init__" title="Link to this definition">#</a></dt> -<dd><p>Initialize a new <a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> instance.</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>response</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse" title="(in aiohttp v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientResponse</span></code></a>) – The response object from the request.</p></li> -<li><p><strong>response_json</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</span>) – The JSON response returned from the request, if any.</p></li> -<li><p><strong>response_text</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<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 text of the request, if any.</p></li> -</ul> -</dd> -</dl> -</dd></dl> - -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__str__"> -<span class="sig-name descname"><span class="pre">__str__</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Link to this definition">#</a></dt> -<dd><p>Return a string representation of the error.</p> -</dd></dl> - -</dd></dl> - -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="../changelog.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">Changelog</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.async_stats.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">async_stats</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="#">site_api</a><ul> -<li><a class="reference internal" href="#botcore.site_api.APIClient"><code class="docutils literal notranslate"><span class="pre">APIClient</span></code></a><ul> -<li><a class="reference internal" href="#botcore.site_api.APIClient.__init__"><code class="docutils literal notranslate"><span class="pre">APIClient.__init__()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.APIClient.close"><code class="docutils literal notranslate"><span class="pre">APIClient.close()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.APIClient.delete"><code class="docutils literal notranslate"><span class="pre">APIClient.delete()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.APIClient.get"><code class="docutils literal notranslate"><span class="pre">APIClient.get()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.APIClient.maybe_raise_for_status"><code class="docutils literal notranslate"><span class="pre">APIClient.maybe_raise_for_status()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.APIClient.patch"><code class="docutils literal notranslate"><span class="pre">APIClient.patch()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.APIClient.post"><code class="docutils literal notranslate"><span class="pre">APIClient.post()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.APIClient.put"><code class="docutils literal notranslate"><span class="pre">APIClient.put()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.APIClient.request"><code class="docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a></li> -</ul> -</li> -<li><a class="reference internal" href="#botcore.site_api.ResponseCodeError"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a><ul> -<li><a class="reference internal" href="#botcore.site_api.ResponseCodeError.__init__"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError.__init__()</span></code></a></li> -<li><a class="reference internal" href="#botcore.site_api.ResponseCodeError.__str__"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError.__str__()</span></code></a></li> -</ul> -</li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.utils.caching.html b/v7.2.2/output/botcore.utils.caching.html deleted file mode 100644 index 4c55d210..00000000 --- a/v7.2.2/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.2.2</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.2.2</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.2.2</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 current-page"> - <a class="version_link reference internal" href="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 "> - <a class="version_link reference internal" href="../../v7.1.1/output/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.utils.channel.html b/v7.2.2/output/botcore.utils.channel.html deleted file mode 100644 index bce266ce..00000000 --- a/v7.2.2/output/botcore.utils.channel.html +++ /dev/null @@ -1,570 +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="logging" href="botcore.utils.logging.html" /><link rel="prev" title="caching" href="botcore.utils.caching.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>channel - Pydis Core v7.2.2</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.2.2</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.2.2</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 current current-page"><a class="current reference internal" href="#">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.channel.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.channel.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.channel.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.channel.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.channel.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.channel.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.channel.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.channel.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.channel.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.utils.channel.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.utils.channel.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.channel.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.channel.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.utils.channel.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.channel.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.utils.channel.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.channel.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.utils.channel.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.utils.channel.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.utils.channel.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.channel"> -<span id="channel"></span><h1>channel<a class="headerlink" href="#module-botcore.utils.channel" title="Link to this heading">#</a></h1> -<p>Useful helper functions for interacting with various discord channel objects.</p> -<dl class="py function"> -<dt class="sig sig-object py" id="botcore.utils.channel.get_or_fetch_channel"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.get_or_fetch_channel" title="Link to this definition">#</a></dt> -<dd><p>Attempt to get or fetch the given <code class="docutils literal notranslate"><span class="pre">channel_id</span></code> from the bots cache, and return it.</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>bot</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></span>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code></a> instance to use for getting/fetching.</p></li> -<li><p><strong>channel_id</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 channel to get/fetch.</p></li> -</ul> -</dd> -<dt class="field-even">Raises<span class="colon">:</span></dt> -<dd class="field-even"><ul class="simple"> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.4.0a)"><strong>discord.InvalidData</strong></a> – An unknown channel type was received from Discord.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.HTTPException" title="(in discord.py v2.4.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.4.0a)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.4.0a)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li> -</ul> -</dd> -<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://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a></span></p> -</dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>The channel from the ID.</p> -</dd> -</dl> -</dd></dl> - -<dl class="py function"> -<dt class="sig sig-object py" id="botcore.utils.channel.is_in_category"> -<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.is_in_category" title="Link to this definition">#</a></dt> -<dd><p>Return whether the given <code class="docutils literal notranslate"><span class="pre">channel</span></code> in the the category with the id <code class="docutils literal notranslate"><span class="pre">category_id</span></code>.</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>channel</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a></span>) – The channel to check.</p></li> -<li><p><strong>category_id</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 category to check for.</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/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 bool depending on whether the channel is in the category.</p> -</dd> -</dl> -</dd></dl> - -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="botcore.utils.logging.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">logging</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.utils.caching.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">caching</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="#">channel</a><ul> -<li><a class="reference internal" href="#botcore.utils.channel.get_or_fetch_channel"><code class="docutils literal notranslate"><span class="pre">get_or_fetch_channel()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.channel.is_in_category"><code class="docutils literal notranslate"><span class="pre">is_in_category()</span></code></a></li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.utils.html b/v7.2.2/output/botcore.utils.html deleted file mode 100644 index dd0b082b..00000000 --- a/v7.2.2/output/botcore.utils.html +++ /dev/null @@ -1,613 +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="caching" href="botcore.utils.caching.html" /><link rel="prev" title="Exts" href="botcore.exts.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>Utils - Pydis Core v7.2.2</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.2.2</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.2.2</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 current-page"><a class="current reference internal" href="#">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> -<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.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.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.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.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.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.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.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.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.utils.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.utils.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.utils.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.utils.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.utils.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.utils.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.utils.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"> -<span id="utils"></span><h1>Utils<a class="headerlink" href="#module-botcore.utils" title="Link to this heading">#</a></h1> -<p>Useful utilities and tools for Discord bot development.</p> -<dl class="py function"> -<dt class="sig sig-object py" id="botcore.utils.apply_monkey_patches"> -<span class="sig-name descname"><span class="pre">apply_monkey_patches</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Link to this definition">#</a></dt> -<dd><p>Applies all common monkey patches for our bots.</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> -<dl> -<dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names -that will act as top-level groups rather than being aliases of the command’s group.</p> -<p>It’s stored as an attribute also named <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code></p> -</dd> -<dt>Patches discord’s internal <code class="docutils literal notranslate"><span class="pre">send_typing</span></code> method so that it ignores 403 errors from Discord.</dt><dd><p>When under heavy load Discord has added a CloudFlare worker to this route, which causes 403 errors to be thrown.</p> -</dd> -</dl> -</dd></dl> - -<dl class="py function"> -<dt class="sig sig-object py" id="botcore.utils.unqualify"> -<span class="sig-name descname"><span class="pre">unqualify</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.unqualify" title="Link to this definition">#</a></dt> -<dd><p>Return an unqualified name given a qualified module/package <code class="docutils literal notranslate"><span class="pre">name</span></code>.</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 module name to unqualify.</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/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></p> -</dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>The unqualified module name.</p> -</dd> -</dl> -</dd></dl> - -<section id="submodules"> -<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.caching.html">caching</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.caching.html#botcore.utils.caching.AsyncCache"><code class="docutils literal notranslate"><span class="pre">AsyncCache</span></code></a><ul> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html#botcore.utils.caching.AsyncCache.__call__"><code class="docutils literal notranslate"><span class="pre">AsyncCache.__call__()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html#botcore.utils.caching.AsyncCache.__init__"><code class="docutils literal notranslate"><span class="pre">AsyncCache.__init__()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html#botcore.utils.caching.AsyncCache.clear"><code class="docutils literal notranslate"><span class="pre">AsyncCache.clear()</span></code></a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.channel.html">channel</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.channel.html#botcore.utils.channel.get_or_fetch_channel"><code class="docutils literal notranslate"><span class="pre">get_or_fetch_channel()</span></code></a></li> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.channel.html#botcore.utils.channel.is_in_category"><code class="docutils literal notranslate"><span class="pre">is_in_category()</span></code></a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.logging.html">logging</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.logging.html#botcore.utils.logging.CustomLogger"><code class="docutils literal notranslate"><span class="pre">CustomLogger</span></code></a><ul> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.logging.html#botcore.utils.logging.CustomLogger.trace"><code class="docutils literal notranslate"><span class="pre">CustomLogger.trace()</span></code></a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.logging.html#botcore.utils.logging.get_logger"><code class="docutils literal notranslate"><span class="pre">get_logger()</span></code></a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.members.html">members</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.members.html#botcore.utils.members.get_or_fetch_member"><code class="docutils literal notranslate"><span class="pre">get_or_fetch_member()</span></code></a></li> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.members.html#botcore.utils.members.handle_role_change"><code class="docutils literal notranslate"><span class="pre">handle_role_change()</span></code></a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.regex.html">regex</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.DISCORD_INVITE"><code class="docutils literal notranslate"><span class="pre">DISCORD_INVITE</span></code></a></li> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.FORMATTED_CODE_REGEX"><code class="docutils literal notranslate"><span class="pre">FORMATTED_CODE_REGEX</span></code></a></li> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.RAW_CODE_REGEX"><code class="docutils literal notranslate"><span class="pre">RAW_CODE_REGEX</span></code></a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.scheduling.html">scheduling</a><ul> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler"><code class="docutils literal notranslate"><span class="pre">Scheduler</span></code></a><ul> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.__contains__"><code class="docutils literal notranslate"><span class="pre">Scheduler.__contains__()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.__init__"><code class="docutils literal notranslate"><span class="pre">Scheduler.__init__()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.cancel"><code class="docutils literal notranslate"><span class="pre">Scheduler.cancel()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.cancel_all"><code class="docutils literal notranslate"><span class="pre">Scheduler.cancel_all()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.schedule"><code class="docutils literal notranslate"><span class="pre">Scheduler.schedule()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.schedule_at"><code class="docutils literal notranslate"><span class="pre">Scheduler.schedule_at()</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.schedule_later"><code class="docutils literal notranslate"><span class="pre">Scheduler.schedule_later()</span></code></a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.create_task"><code class="docutils literal notranslate"><span class="pre">create_task()</span></code></a></li> -</ul> -</li> -</ul> -</div> -</section> -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="botcore.utils.caching.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">caching</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.exts.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">Exts</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="#">Utils</a><ul> -<li><a class="reference internal" href="#botcore.utils.apply_monkey_patches"><code class="docutils literal notranslate"><span class="pre">apply_monkey_patches()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.unqualify"><code class="docutils literal notranslate"><span class="pre">unqualify()</span></code></a></li> -<li><a class="reference internal" href="#submodules">Submodules</a></li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.utils.logging.html b/v7.2.2/output/botcore.utils.logging.html deleted file mode 100644 index e84c3405..00000000 --- a/v7.2.2/output/botcore.utils.logging.html +++ /dev/null @@ -1,571 +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="members" href="botcore.utils.members.html" /><link rel="prev" title="channel" href="botcore.utils.channel.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>logging - Pydis Core v7.2.2</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.2.2</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.2.2</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 current current-page"><a class="current reference internal" href="#">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.logging.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.logging.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.logging.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.logging.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.logging.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.logging.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.logging.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.logging.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.logging.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.utils.logging.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.utils.logging.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.logging.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.logging.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.utils.logging.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.logging.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.utils.logging.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.logging.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.utils.logging.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.utils.logging.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.utils.logging.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.logging"> -<span id="logging"></span><h1>logging<a class="headerlink" href="#module-botcore.utils.logging" title="Link to this heading">#</a></h1> -<p>Common logging related functions.</p> -<dl class="py class"> -<dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Link to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logger</span></code></a></p> -<p>Custom implementation of the <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Logger</span></code></a> class with an added <a class="reference internal" href="#botcore.utils.logging.CustomLogger.trace" title="botcore.utils.logging.CustomLogger.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a> method.</p> -<dl class="py method"> -<dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger.trace"> -<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</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/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Link to this definition">#</a></dt> -<dd><p>Log the given message with the severity <code class="docutils literal notranslate"><span class="pre">"TRACE"</span></code>.</p> -<p>To pass exception information, use the keyword argument exc_info with a true value:</p> -<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">"Houston, we have an </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"interesting problem"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> -</pre></div> -</div> -<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>msg</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 message to be logged.</p></li> -<li><p><strong>args</strong> – Passed to the base log function as is.</p></li> -<li><p><strong>kwargs</strong> – Passed to the base log function as is.</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.logging.get_logger"> -<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/logging.py#L35-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.get_logger" title="Link to this definition">#</a></dt> -<dd><p>Utility to make mypy recognise that logger is of type <a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a>.</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/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<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 given to the logger.</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 internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomLogger</span></code></a></span></p> -</dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>An instance of the <a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a> class.</p> -</dd> -</dl> -</dd></dl> - -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="botcore.utils.members.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">members</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.utils.channel.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">channel</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="#">logging</a><ul> -<li><a class="reference internal" href="#botcore.utils.logging.CustomLogger"><code class="docutils literal notranslate"><span class="pre">CustomLogger</span></code></a><ul> -<li><a class="reference internal" href="#botcore.utils.logging.CustomLogger.trace"><code class="docutils literal notranslate"><span class="pre">CustomLogger.trace()</span></code></a></li> -</ul> -</li> -<li><a class="reference internal" href="#botcore.utils.logging.get_logger"><code class="docutils literal notranslate"><span class="pre">get_logger()</span></code></a></li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.utils.members.html b/v7.2.2/output/botcore.utils.members.html deleted file mode 100644 index 90feae28..00000000 --- a/v7.2.2/output/botcore.utils.members.html +++ /dev/null @@ -1,556 +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="regex" href="botcore.utils.regex.html" /><link rel="prev" title="logging" href="botcore.utils.logging.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>members - Pydis Core v7.2.2</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.2.2</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.2.2</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.logging.html">logging</a></li> -<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">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.members.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.members.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.members.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.members.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.members.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.members.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.members.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.members.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.members.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.utils.members.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.utils.members.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.members.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.members.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.utils.members.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.members.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.utils.members.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.members.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.utils.members.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.utils.members.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.utils.members.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.members"> -<span id="members"></span><h1>members<a class="headerlink" href="#module-botcore.utils.members" title="Link to this heading">#</a></h1> -<p>Useful helper functions for interactin with <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> objects.</p> -<dl class="py function"> -<dt class="sig sig-object py" id="botcore.utils.members.get_or_fetch_member"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/members.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.get_or_fetch_member" title="Link to this definition">#</a></dt> -<dd><p>Attempt to get a member from cache; on failure fetch from the API.</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/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a>]</span></p> -</dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> or <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> to indicate the member could not be found.</p> -</dd> -</dl> -</dd></dl> - -<dl class="py function"> -<dt class="sig sig-object py" id="botcore.utils.members.handle_role_change"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/members.py#L31-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Link to this definition">#</a></dt> -<dd><p>Await the given <code class="docutils literal notranslate"><span class="pre">coro</span></code> with <code class="docutils literal notranslate"><span class="pre">role</span></code> as the sole argument.</p> -<p>Handle errors that we expect to be raised from -<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</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>member</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The member that is being modified for logging purposes.</p></li> -<li><p><strong>coro</strong> (<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>[[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>], <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>) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> or <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> -<li><p><strong>role</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a></span>) – The role to be passed to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</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> - -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="botcore.utils.regex.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">regex</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.utils.logging.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">logging</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="#">members</a><ul> -<li><a class="reference internal" href="#botcore.utils.members.get_or_fetch_member"><code class="docutils literal notranslate"><span class="pre">get_or_fetch_member()</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.members.handle_role_change"><code class="docutils literal notranslate"><span class="pre">handle_role_change()</span></code></a></li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.utils.regex.html b/v7.2.2/output/botcore.utils.regex.html deleted file mode 100644 index 717eeebf..00000000 --- a/v7.2.2/output/botcore.utils.regex.html +++ /dev/null @@ -1,553 +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="scheduling" href="botcore.utils.scheduling.html" /><link rel="prev" title="members" href="botcore.utils.members.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>regex - Pydis Core v7.2.2</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.2.2</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.2.2</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.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 current current-page"><a class="current reference internal" href="#">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.regex.html">v8.3.0-beta</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.regex.html">v8.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.regex.html">v8.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.regex.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.regex.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.regex.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.regex.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.regex.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.regex.html">v8.0.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.5.0/output/botcore.utils.regex.html">v7.5.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.utils.regex.html">v7.4.0-beta1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.regex.html">v7.4.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.regex.html">v7.3.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.3.0/output/botcore.utils.regex.html">v7.3.0</a> - </li> - - <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.regex.html">v7.2.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.1/output/botcore.utils.regex.html">v7.2.1</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.regex.html">v7.2.0</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.3/output/botcore.utils.regex.html">v7.1.3</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.2/output/botcore.utils.regex.html">v7.1.2</a> - </li> - - <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.1.1/output/botcore.utils.regex.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.regex"> -<span id="regex"></span><h1>regex<a class="headerlink" href="#module-botcore.utils.regex" title="Link to this heading">#</a></h1> -<p>Common regular expressions.</p> -<dl class="py data"> -<dt class="sig sig-object py" id="botcore.utils.regex.DISCORD_INVITE"> -<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Link to this definition">#</a></dt> -<dd><p>Regex for Discord server invites.</p> -<div class="admonition warning"> -<p class="admonition-title">Warning</p> -<p>This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in -any HTTP requests or similar. Please ensure you sanitise the output using something -such as <a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.quote()</span></code></a>.</p> -</div> -<dl class="field-list simple"> -</dl> -</dd></dl> - -<dl class="py data"> -<dt class="sig sig-object py" id="botcore.utils.regex.FORMATTED_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Link to this definition">#</a></dt> -<dd><p>Regex for formatted code, using Discord’s code blocks.</p> -<dl class="field-list simple"> -</dl> -</dd></dl> - -<dl class="py data"> -<dt class="sig sig-object py" id="botcore.utils.regex.RAW_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/70bdf0f7e50cf182390dbeed38232438d54ea16e/botcore/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Link to this definition">#</a></dt> -<dd><p>Regex for raw code, <em>not</em> using Discord’s code blocks.</p> -<dl class="field-list simple"> -</dl> -</dd></dl> - -</section> - - </article> - </div> - <footer> - - <div class="related-pages"> - <a class="next-page" href="botcore.utils.scheduling.html"> - <div class="page-info"> - <div class="context"> - <span>Next</span> - </div> - <div class="title">scheduling</div> - </div> - <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> - </a> - <a class="prev-page" href="botcore.utils.members.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">members</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="#">regex</a><ul> -<li><a class="reference internal" href="#botcore.utils.regex.DISCORD_INVITE"><code class="docutils literal notranslate"><span class="pre">DISCORD_INVITE</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.regex.FORMATTED_CODE_REGEX"><code class="docutils literal notranslate"><span class="pre">FORMATTED_CODE_REGEX</span></code></a></li> -<li><a class="reference internal" href="#botcore.utils.regex.RAW_CODE_REGEX"><code class="docutils literal notranslate"><span class="pre">RAW_CODE_REGEX</span></code></a></li> -</ul> -</li> -</ul> - - </div> - </div> - </div> - - - </aside> - </div> -</div><script src="../_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/output/botcore.utils.scheduling.html b/v7.2.2/output/botcore.utils.scheduling.html deleted file mode 100644 index f2bd397b..00000000 --- a/v7.2.2/output/botcore.utils.scheduling.html +++ /dev/null @@ -1,686 +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 v7.2.2</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.2.2</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.2.2</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.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="../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 "> - <a class="version_link reference internal" href="../../v8.0.0-beta.1/output/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 current-page"> - <a class="version_link reference internal" href="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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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=9fcf24ae"></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 diff --git a/v7.2.2/py-modindex.html b/v7.2.2/py-modindex.html deleted file mode 100644 index 31317c74..00000000 --- a/v7.2.2/py-modindex.html +++ /dev/null @@ -1,557 +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"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.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>Python Module Index - Pydis Core v7.2.2</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.2.2</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 no-toc" 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.2.2</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> -<li class="toctree-l1 has-children"><a class="reference internal" href="output/botcore.html">Botcore</a><input 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> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.exts.html">Exts</a></li> -<li class="toctree-l2 has-children"><a class="reference internal" href="output/botcore.utils.html">Utils</a><input 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> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.regex.html">regex</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.scheduling.html">scheduling</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.async_stats.html">async_stats</a></li> -<li class="toctree-l2"><a class="reference internal" href="output/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/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 current-page"> - <a class="version_link reference internal" href="py-modindex.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/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 no-toc" 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 class="domainindex-section"> - <h1>Python Module Index</h1> - <div class="domainindex-jumpbox"><a href="#cap-b"><strong>b</strong></a></div> -</section> -<table class="domainindex-table"> - <tr class="pcap"> - <td></td><td> </td><td></td> - </tr> - <tr class="cap" id="cap-b"> - <td></td><td><strong>b</strong></td><td></td> - </tr> - <tr> - <td><img src="_static/minus.png" class="toggler" - id="toggle-1" style="display: none" alt="-" /></td> - <td> - <a href="output/botcore.html#module-botcore"><code class="xref">botcore</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.async_stats.html#module-botcore.async_stats"><code class="xref">botcore.async_stats</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.exts.html#module-botcore.exts"><code class="xref">botcore.exts</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.site_api.html#module-botcore.site_api"><code class="xref">botcore.site_api</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.utils.html#module-botcore.utils"><code class="xref">botcore.utils</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.utils.caching.html#module-botcore.utils.caching"><code class="xref">botcore.utils.caching</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.utils.channel.html#module-botcore.utils.channel"><code class="xref">botcore.utils.channel</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.utils.logging.html#module-botcore.utils.logging"><code class="xref">botcore.utils.logging</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.utils.members.html#module-botcore.utils.members"><code class="xref">botcore.utils.members</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.utils.regex.html#module-botcore.utils.regex"><code class="xref">botcore.utils.regex</code></a></td><td> - <em></em></td> - </tr> - <tr class="cg-1"> - <td></td> - <td>    - <a href="output/botcore.utils.scheduling.html#module-botcore.utils.scheduling"><code class="xref">botcore.utils.scheduling</code></a></td><td> - <em></em></td> - </tr> -</table> - - </article> - </div> - <footer> - - <div class="related-pages"> - - - </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 no-toc"> - - - - </aside> - </div> -</div><script src="_static/documentation_options.js?v=9fcf24ae"></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 diff --git a/v7.2.2/search.html b/v7.2.2/search.html deleted file mode 100644 index 4c3f7e4f..00000000 --- a/v7.2.2/search.html +++ /dev/null @@ -1,490 +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"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="#" /> - - <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>Search - Pydis Core v7.2.2</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.2.2</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 no-toc" 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.2.2</span> - -</a><form class="sidebar-search-container" method="get" action="#" 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> -<li class="toctree-l1 has-children"><a class="reference internal" href="output/botcore.html">Botcore</a><input 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> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.exts.html">Exts</a></li> -<li class="toctree-l2 has-children"><a class="reference internal" href="output/botcore.utils.html">Utils</a><input 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> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.regex.html">regex</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.scheduling.html">scheduling</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.async_stats.html">async_stats</a></li> -<li class="toctree-l2"><a class="reference internal" href="output/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/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 current-page"> - <a class="version_link reference internal" href="search.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/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 no-toc" 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"> - -<noscript> -<div class="admonition error"> - <p class="admonition-title">Error</p> - <p> - Please activate JavaScript to enable the search functionality. - </p> -</div> -</noscript> - -<div id="search-results"></div> - - </article> - </div> - <footer> - - <div class="related-pages"> - - - </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 no-toc"> - - - - </aside> - </div> -</div><script src="_static/documentation_options.js?v=9fcf24ae"></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> - -<script src="_static/searchtools.js"></script> -<script src="_static/language_data.js"></script> -<script src="searchindex.js"></script></body> -</html>
\ No newline at end of file diff --git a/v7.2.2/searchindex.js b/v7.2.2/searchindex.js deleted file mode 100644 index 86be3555..00000000 --- a/v7.2.2/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "2": [0, 2], "9th": 0, "juli": 0, "2022": 0, "bug": 0, "98": 0, "onli": [0, 2], "close": [0, 1, 2, 5, 12], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 12], "creat": [0, 2, 3, 7, 12], "1": [0, 9], "30th": 0, "june": 0, "91": 0, "add": [0, 2], "miss": 0, "await": [0, 10], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 9, 10, 12], "self": [0, 2], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 12], "fix": 0, "incorrect": 0, "docstr": 0, "botcor": [0, 1], "util": [0, 1, 2, 7, 9], "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 10], "96": 0, "attempt": [0, 2, 8, 10], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 12], "i": [0, 2, 5, 6, 8, 9, 10, 12], "none": [0, 2, 3, 5, 6, 7, 9, 10, 12], "0": [0, 7, 9], "28th": 0, "support": [0, 3, 6, 12], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 10, 11], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 12], "new": [0, 3, 5, 7, 12], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "3": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 9], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "featur": [0, 2], "78": 0, "4cbe8f5": 0, "thi": [0, 2, 6, 8, 10, 11, 12], "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 12], "out": 0, "10th": 0, "break": 0, "75": 0, "invit": [0, 11], "regex": [0, 2, 6], "longer": 0, "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 12], "url": [0, 2, 5], "safe": 0, "result": [0, 12], "refer": 0, "document": 0, "handl": [0, 10, 12], "captur": [0, 11], "all": [0, 2, 3, 6, 12], "charact": 0, "up": [0, 2], "whitespac": [0, 11], "6": 0, "4": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "timeout": 0, "guild": [0, 2, 10], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 12], "number": 0, "so": [0, 6], "should": [0, 2, 5], "actual": 0, "work": 0, "now": [0, 12], "25th": 0, "69": 0, "us": [0, 2, 3, 5, 6, 8, 9, 10, 11, 12], "get": [0, 2, 5, 8, 10], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 12], "t": [0, 12], "load": [0, 2, 6], "modul": [0, 2, 6, 12], "start": [0, 2, 12], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 11, 12], "own": 0, "task": [0, 2, 12], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 12], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 9], "pagin": 0, "also": [0, 6], "basic": 0, "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "allow": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 9, 12], "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 12], "specifi": 0, "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 9, 12], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 12], "event": [0, 2, 3, 12], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 12], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 10], "42": 0, "remov": [0, 2], "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 12], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 10, 12], "trace": [0, 6, 9], "import": 0, "can": [0, 12], "function": [0, 2, 7, 8, 9, 10, 12], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 10], "wrapper": [0, 5, 12], "from": [0, 2, 3, 5, 6, 8, 10, 12], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 9, 11], "cach": [0, 2, 6, 8, 10], "logger": [0, 9], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 11], "block": [0, 11], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "17th": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 9], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 9], "guild_id": 2, "allowed_rol": 2, "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 12], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12], "A": [2, 5, 6, 7, 8, 12], "implement": [2, 3, 7, 9], "python": [2, 12], "initialis": [2, 7], "int": [2, 3, 7, 8, 12], "The": [2, 3, 5, 6, 7, 8, 9, 10, 12], "id": [2, 8, 12], "list": 2, "role": [2, 10], "mention": 2, "clientsess": [2, 5], "option": [2, 5, 7, 9, 10], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 12], "server": [2, 11], "If": [2, 5, 12], "given": [2, 3, 6, 8, 9, 10, 12], "oper": [2, 12], "type": [2, 3, 5, 6, 7, 8, 9, 10, 12], "normal": 2, "its": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 12], "instanti": [2, 12], "instead": [2, 12], "connector": 2, "resolv": 2, "save": 2, "them": [2, 12], "all_extens": 2, "ran": 2, "loop": [2, 3, 12], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 12], "messag": [2, 9, 12], "dev": 2, "set": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 12], "servic": 2, "ensur": [2, 11], "thei": 2, "ar": [2, 7, 11], "name": [2, 6, 9, 12], "alia": [2, 6], "individu": 2, "To": [2, 9], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "gener": [2, 12], "create_socket": [2, 3], "wait": [2, 12], "until": [2, 11], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 12], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 9, 12], "error": [2, 5, 6, 10], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 9], "get_logg": [2, 6, 9], "get_or_fetch_memb": [2, 6, 10], "discord_invit": [2, 6, 11], "formatted_code_regex": [2, 6, 11], "raw_code_regex": [2, 6, 11], "create_task": [2, 6, 12], "delet": [2, 5, 7], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 11], "__str__": [2, 5], "transport": 3, "method": [3, 5, 6, 9], "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 12], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 10, 12], "django": 5, "initi": [5, 12], "token": 5, "authent": 5, "keyword": [5, 6, 9], "argument": [5, 6, 7, 9, 10], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 9, 12], "send": 5, "json": 5, "respons": 5, "bool": [5, 8, 12], "whether": [5, 8], "rais": [5, 8, 10, 12], "ok": 5, "ani": [5, 11, 12], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 12], "http": [5, 11], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 11], "root_alias": 6, "two": 6, "sequenc": 6, "act": 6, "top": 6, "level": [6, 9], "rather": 6, "than": 6, "being": [6, 10], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "ha": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "__contains__": [6, 12], "cancel": [6, 12], "cancel_al": [6, 12], "schedule_at": [6, 12], "schedule_lat": [6, 12], "relat": [7, 9], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 10, 12], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 12], "offset": 7, "provid": [7, 12], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 10], "wrap": [7, 12], "target": 7, "how": [7, 12], "item": 7, "helper": [8, 10], "interact": 8, "variou": 8, "channel_id": 8, "fetch": [8, 10], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 11], "do": 8, "have": [8, 9], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "msg": 9, "sever": 9, "exc_info": 9, "valu": 9, "houston": 9, "we": [9, 10], "interest": 9, "problem": 9, "mypi": 9, "recognis": 9, "interactin": 10, "member_id": 10, "failur": 10, "indic": 10, "could": 10, "found": [10, 12], "coro": [10, 12], "sole": 10, "expect": 10, "add_rol": 10, "remove_rol": 10, "modifi": 10, "purpos": 10, "intend": 10, "regular": 11, "express": 11, "pattern": 11, "similar": 11, "pleas": 11, "sanitis": 11, "output": 11, "someth": 11, "urllib": 11, "pars": 11, "quot": 11, "format": 11, "raw": 11, "execut": 12, "keep": 12, "track": 12, "must": 12, "distinguish": 12, "other": 12, "contain": 12, "suggest": 12, "immedi": 12, "futur": 12, "uniqu": 12, "prematur": 12, "same": 12, "current": 12, "done": 12, "task_id": 12, "hashabl": 12, "look": 12, "unschedul": 12, "identifi": 12, "warn": 12, "doesn": 12, "exist": 12, "known": 12, "alreadi": 12, "prevent": 12, "unawait": 12, "ll": 12, "elsewher": 12, "timezon": 12, "awar": 12, "calcul": 12, "subtract": 12, "na\u00efv": 12, "utc": 12, "past": 12, "datetim": 12, "delai": 12, "after": 12, "union": 12, "float": 12, "long": 12, "suppressed_except": 12, "event_loop": 12, "otherwis": 12, "run": 12, "typevar": 12, "task_return": 12, "tupl": 12}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "logging"], [10, 0, 0, "-", "members"], [11, 0, 0, "-", "regex"], [12, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.logging": [[9, 1, 1, "", "CustomLogger"], [9, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[9, 2, 1, "", "trace"]], "botcore.utils.members": [[10, 4, 1, "", "get_or_fetch_member"], [10, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[11, 5, 1, "", "DISCORD_INVITE"], [11, 5, 1, "", "FORMATTED_CODE_REGEX"], [11, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[12, 1, 1, "", "Scheduler"], [12, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[12, 2, 1, "", "__contains__"], [12, 2, 1, "", "__init__"], [12, 2, 1, "", "cancel"], [12, 2, 1, "", "cancel_all"], [12, 2, 1, "", "schedule"], [12, 2, 1, "", "schedule_at"], [12, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "log": 9, "member": 10, "regex": 11, "schedul": 12}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 60}, "alltitles": {"async_stats": [[3, "module-botcore.async_stats"]], "site_api": [[5, "module-botcore.site_api"]], "Exts": [[4, "module-botcore.exts"]], "channel": [[8, "module-botcore.utils.channel"]], "caching": [[7, "module-botcore.utils.caching"]], "Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "members": [[10, "module-botcore.utils.members"]], "regex": [[11, "module-botcore.utils.regex"]], "logging": [[9, "module-botcore.utils.logging"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Changelog": [[0, "changelog"]], "scheduling": [[12, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.logging"], [10, "module-botcore.utils.members"], [11, "module-botcore.utils.regex"], [12, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "customlogger (class in botcore.utils.logging)": [[9, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[9, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[9, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[9, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[10, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[10, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[10, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[11, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[11, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[11, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[11, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[12, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[12, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[12, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule_later"]]}})
\ No newline at end of file diff --git a/v7.2.2/versions.html b/v7.2.2/versions.html deleted file mode 100644 index 68fdd958..00000000 --- a/v7.2.2/versions.html +++ /dev/null @@ -1,763 +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"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.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>Versions - Pydis Core v7.2.2</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.2.2</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 no-toc" 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.2.2</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> -<li class="toctree-l1 has-children"><a class="reference internal" href="output/botcore.html">Botcore</a><input 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> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.exts.html">Exts</a></li> -<li class="toctree-l2 has-children"><a class="reference internal" href="output/botcore.utils.html">Utils</a><input 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> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.regex.html">regex</a></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.scheduling.html">scheduling</a></li> -</ul> -</li> -<li class="toctree-l2"><a class="reference internal" href="output/botcore.async_stats.html">async_stats</a></li> -<li class="toctree-l2"><a class="reference internal" href="output/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 current-page"> - - <a class="reference internal" href="#">Versions</a> - <input checked 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/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 current-page"> - <a class="version_link reference internal" href="versions.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/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 no-toc" 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"> - - <h1>Versions</h1> - <dl> - <dt>Documentation is available for the following versions:</dt> - <dd><ul> - - - <li> - <a class="reference internal" href="../main/index.html">main</a> - - - latest - </li> - - <li> - <a class="reference internal" href="../v9.9.2/index.html">v9.9.2</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.9.1/index.html">v9.9.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.9.0/index.html">v9.9.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.8.0/index.html">v9.8.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.7.0/index.html">v9.7.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.6.0/index.html">v9.6.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.5.1/index.html">v9.5.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.5.0/index.html">v9.5.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.4.1/index.html">v9.4.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.4.0/index.html">v9.4.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.3.0/index.html">v9.3.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.2.0/index.html">v9.2.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.10.0-alpha.2/index.html">v9.10.0-alpha.2</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.10.0-alpha.1/index.html">v9.10.0-alpha.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.1.1/index.html">v9.1.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v9.0.0/index.html">v9.0.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.3.0-beta/index.html">v8.3.0-beta</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.2.1/index.html">v8.2.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.2.0/index.html">v8.2.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.1.0/index.html">v8.1.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.0.0-beta.3/index.html">v8.0.0-beta.3</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.0.0-beta.2/index.html">v8.0.0-beta.2</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.0.0-beta.1/index.html">v8.0.0-beta.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v8.0.0/index.html">v8.0.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.5.0/index.html">v7.5.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.4.0-beta1/index.html">v7.4.0-beta1</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.4.0/index.html">v7.4.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.3.1/index.html">v7.3.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.3.0/index.html">v7.3.0</a> - - - </li> - - <li> - <a class="reference internal" href="versions.html">v7.2.2</a> - (current) - - </li> - - <li> - <a class="reference internal" href="../v7.2.1/index.html">v7.2.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.2.0/index.html">v7.2.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.1.3/index.html">v7.1.3</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.1.2/index.html">v7.1.2</a> - - - </li> - - <li> - <a class="reference internal" href="../v7.1.1/index.html">v7.1.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.7.0/index.html">v10.7.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.6.0/index.html">v10.6.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.5.1/index.html">v10.5.1</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.5.0/index.html">v10.5.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.4.0/index.html">v10.4.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.3.0/index.html">v10.3.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.2.0/index.html">v10.2.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.1.0/index.html">v10.1.0</a> - - - </li> - - <li> - <a class="reference internal" href="../v10.0.0/index.html">v10.0.0</a> - - - </li> - - </ul></dd> - </dl> - - </article> - </div> - <footer> - - <div class="related-pages"> - - - </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 no-toc"> - - - - </aside> - </div> -</div><script src="_static/documentation_options.js?v=9fcf24ae"></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 |
