diff options
Diffstat (limited to 'v7.4.0')
41 files changed, 874 insertions, 324 deletions
diff --git a/v7.4.0/.buildinfo b/v7.4.0/.buildinfo index 43681d7a..ea2cd5f8 100644 --- a/v7.4.0/.buildinfo +++ b/v7.4.0/.buildinfo @@ -1,4 +1,4 @@ # 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: bee895c78f10c7d31977310f9bfcfd78 +config: c48fa56e9f411d5ff1ca748ff35d313b tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.4.0/.doctrees/changelog.doctree b/v7.4.0/.doctrees/changelog.doctree Binary files differindex 3dbd1a7a..9deb9d57 100644 --- a/v7.4.0/.doctrees/changelog.doctree +++ b/v7.4.0/.doctrees/changelog.doctree diff --git a/v7.4.0/.doctrees/environment.pickle b/v7.4.0/.doctrees/environment.pickle Binary files differindex 40349668..d334bab2 100644 --- a/v7.4.0/.doctrees/environment.pickle +++ b/v7.4.0/.doctrees/environment.pickle diff --git a/v7.4.0/.doctrees/index.doctree b/v7.4.0/.doctrees/index.doctree Binary files differindex 97c1ce01..904262ae 100644 --- a/v7.4.0/.doctrees/index.doctree +++ b/v7.4.0/.doctrees/index.doctree diff --git a/v7.4.0/.doctrees/output/botcore.async_stats.doctree b/v7.4.0/.doctrees/output/botcore.async_stats.doctree Binary files differindex 3dba8968..d5b6d02f 100644 --- a/v7.4.0/.doctrees/output/botcore.async_stats.doctree +++ b/v7.4.0/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.4.0/.doctrees/output/botcore.doctree b/v7.4.0/.doctrees/output/botcore.doctree Binary files differindex 7ab2fde4..fec5bd07 100644 --- a/v7.4.0/.doctrees/output/botcore.doctree +++ b/v7.4.0/.doctrees/output/botcore.doctree diff --git a/v7.4.0/.doctrees/output/botcore.exts.doctree b/v7.4.0/.doctrees/output/botcore.exts.doctree Binary files differindex c333cd42..5966c118 100644 --- a/v7.4.0/.doctrees/output/botcore.exts.doctree +++ b/v7.4.0/.doctrees/output/botcore.exts.doctree diff --git a/v7.4.0/.doctrees/output/botcore.site_api.doctree b/v7.4.0/.doctrees/output/botcore.site_api.doctree Binary files differindex 28491222..0b98dc07 100644 --- a/v7.4.0/.doctrees/output/botcore.site_api.doctree +++ b/v7.4.0/.doctrees/output/botcore.site_api.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.caching.doctree b/v7.4.0/.doctrees/output/botcore.utils.caching.doctree Binary files differindex a055da4a..20de86cf 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.channel.doctree b/v7.4.0/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 579e4e9d..554ef42f 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.doctree b/v7.4.0/.doctrees/output/botcore.utils.doctree Binary files differindex e2e23501..49d4af3a 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree b/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree Binary files differindex 376464cf..2cc0db8e 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.logging.doctree b/v7.4.0/.doctrees/output/botcore.utils.logging.doctree Binary files differindex b87dbb49..00dfb6d8 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.members.doctree b/v7.4.0/.doctrees/output/botcore.utils.members.doctree Binary files differindex 729465bb..a81b43aa 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.members.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.regex.doctree b/v7.4.0/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 9de654ad..9def71c1 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree b/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 1bde69d2..683f161c 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.4.0/_static/basic.css b/v7.4.0/_static/basic.css index 4e9a9f1f..eeb0519a 100644 --- a/v7.4.0/_static/basic.css +++ b/v7.4.0/_static/basic.css @@ -236,6 +236,16 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -324,15 +334,11 @@ aside.sidebar { 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; @@ -371,8 +377,6 @@ div.body p.centered { 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; @@ -380,8 +384,6 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, -nav.contents::after, -aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -606,26 +608,19 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -aside.footnote > span, -div.citation > span { +dl.footnote > dt, +dl.citation > dt { float: left; + margin-right: 0.5em; } -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 { + +dl.footnote > dd, +dl.citation > dd { margin-bottom: 0em; } -aside.footnote > p:last-of-type:after, -div.citation > p:last-of-type:after { + +dl.footnote > dd:after, +dl.citation > dd:after { content: ""; clear: both; } @@ -641,6 +636,10 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } +dl.field-list > dt:after { + content: ":"; +} + dl.field-list > dd { padding-left: 0.5em; diff --git a/v7.4.0/_static/doctools.js b/v7.4.0/_static/doctools.js index c3db08d1..527b876c 100644 --- a/v7.4.0/_static/doctools.js +++ b/v7.4.0/_static/doctools.js @@ -10,6 +10,13 @@ */ "use strict"; +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + const _ready = (callback) => { if (document.readyState !== "loading") { callback(); @@ -19,72 +26,10 @@ const _ready = (callback) => { }; /** - * 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))); - parent.insertBefore( - span, - parent.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling - ) - ); - node.nodeValue = val.substr(0, pos); - - 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 Documentation = { init: () => { - Documentation.highlightSearchWords(); Documentation.initDomainIndexTable(); Documentation.initOnKeyListeners(); }, @@ -127,51 +72,6 @@ const Documentation = { }, /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords: () => { - const highlight = - new URLSearchParams(window.location.search).get("highlight") || ""; - 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:Documentation.hideSearchWords()">' + - Documentation.gettext("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")); - const url = new URL(window.location); - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - }, - - /** * helper function to focus on search bar */ focusSearchBar: () => { @@ -210,15 +110,11 @@ const Documentation = { ) return; - const blacklistedElements = new Set([ - "TEXTAREA", - "INPUT", - "SELECT", - "BUTTON", - ]); document.addEventListener("keydown", (event) => { - if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements - if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys + // 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) { @@ -240,10 +136,6 @@ const Documentation = { event.preventDefault(); } break; - case "Escape": - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; - Documentation.hideSearchWords(); - event.preventDefault(); } } diff --git a/v7.4.0/_static/pygments.css b/v7.4.0/_static/pygments.css index 75471509..053cfd3d 100644 --- a/v7.4.0/_static/pygments.css +++ b/v7.4.0/_static/pygments.css @@ -54,7 +54,6 @@ .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 */ @@ -139,7 +138,6 @@ 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 */ @@ -224,7 +222,6 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert 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 */ diff --git a/v7.4.0/_static/searchtools.js b/v7.4.0/_static/searchtools.js index f2fb7d5c..e89e34d4 100644 --- a/v7.4.0/_static/searchtools.js +++ b/v7.4.0/_static/searchtools.js @@ -57,14 +57,14 @@ const _removeChildren = (element) => { const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string -const _displayItem = (item, highlightTerms, searchTerms) => { +const _displayItem = (item, searchTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - const [docName, title, anchor, descr] = item; + const [docName, title, anchor, descr, score, _filename] = item; let listItem = document.createElement("li"); let requestUrl; @@ -82,10 +82,9 @@ const _displayItem = (item, highlightTerms, searchTerms) => { requestUrl = docUrlRoot + docName + docFileSuffix; linkUrl = docName + docLinkSuffix; } - const params = new URLSearchParams(); - params.set("highlight", [...highlightTerms].join(" ")); let linkEl = listItem.appendChild(document.createElement("a")); - linkEl.href = linkUrl + "?" + params.toString() + anchor; + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; linkEl.innerHTML = title; if (descr) listItem.appendChild(document.createElement("span")).innerHTML = @@ -96,7 +95,7 @@ const _displayItem = (item, highlightTerms, searchTerms) => { .then((data) => { if (data) listItem.appendChild( - Search.makeSearchSummary(data, searchTerms, highlightTerms) + Search.makeSearchSummary(data, searchTerms) ); }); Search.output.appendChild(listItem); @@ -116,15 +115,14 @@ const _finishSearch = (resultCount) => { const _displayNextItem = ( results, resultCount, - highlightTerms, searchTerms ) => { // results left, load the summary and display it // this is intended to be dynamic (don't sub resultsCount) if (results.length) { - _displayItem(results.pop(), highlightTerms, searchTerms); + _displayItem(results.pop(), searchTerms); setTimeout( - () => _displayNextItem(results, resultCount, highlightTerms, searchTerms), + () => _displayNextItem(results, resultCount, searchTerms), 5 ); } @@ -237,6 +235,12 @@ const Search = { * 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(); @@ -264,6 +268,10 @@ const Search = { } }); + 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]); @@ -272,6 +280,40 @@ const Search = { 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)) @@ -318,7 +360,7 @@ const Search = { // console.info("search results:", Search.lastresults); // print the results - _displayNextItem(results, results.length, highlightTerms, searchTerms); + _displayNextItem(results, results.length, searchTerms); }, /** @@ -399,8 +441,8 @@ const Search = { // prepare search const terms = Search._index.terms; const titleTerms = Search._index.titleterms; - const docNames = Search._index.docnames; const filenames = Search._index.filenames; + const docNames = Search._index.docnames; const titles = Search._index.titles; const scoreMap = new Map(); @@ -497,11 +539,9 @@ const Search = { /** * helper function to return a node containing the * search summary for a given text. keywords is a list - * of stemmed words, highlightWords is the list of normal, unstemmed - * words. the first one is used to find the occurrence, the - * latter for highlighting it. + * of stemmed words. */ - makeSearchSummary: (htmlText, keywords, highlightWords) => { + makeSearchSummary: (htmlText, keywords) => { const text = Search.htmlToText(htmlText); if (text === "") return null; @@ -519,10 +559,6 @@ const Search = { summary.classList.add("context"); summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - highlightWords.forEach((highlightWord) => - _highlightText(summary, highlightWord, "highlighted") - ); - return summary; }, }; diff --git a/v7.4.0/_static/sphinx_highlight.js b/v7.4.0/_static/sphinx_highlight.js new file mode 100644 index 00000000..aae669d7 --- /dev/null +++ b/v7.4.0/_static/sphinx_highlight.js @@ -0,0 +1,144 @@ +/* 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))); + parent.insertBefore( + span, + parent.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + + 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(SphinxHighlight.highlightSearchWords); +_ready(SphinxHighlight.initEscapeListener); diff --git a/v7.4.0/changelog.html b/v7.4.0/changelog.html index 9e9cc983..e83d310d 100644 --- a/v7.4.0/changelog.html +++ b/v7.4.0/changelog.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>Changelog - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -206,6 +206,10 @@ </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> @@ -569,6 +573,7 @@ <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <script src="_static/scripts/furo.js"></script> <script src="_static/changelog.js"></script> </body> diff --git a/v7.4.0/genindex.html b/v7.4.0/genindex.html index e7b34dfb..54444899 100644 --- a/v7.4.0/genindex.html +++ b/v7.4.0/genindex.html @@ -4,7 +4,7 @@ <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/><title>Index - Bot Core v7.4.0</title> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/><title>Index - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -204,6 +204,10 @@ </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> @@ -796,6 +800,7 @@ <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <script src="_static/scripts/furo.js"></script> <script src="_static/changelog.js"></script> </body> diff --git a/v7.4.0/index.html b/v7.4.0/index.html index e10dde89..bc875e11 100644 --- a/v7.4.0/index.html +++ b/v7.4.0/index.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -206,6 +206,10 @@ </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> @@ -340,17 +344,46 @@ <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></li> -<li class="toctree-l3"><a class="reference internal" href="output/botcore.site_api.html">site_api</a></li> +<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> @@ -416,6 +449,7 @@ <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <script src="_static/scripts/furo.js"></script> <script src="_static/changelog.js"></script> </body> diff --git a/v7.4.0/index_redirect.html b/v7.4.0/index_redirect.html index 62623834..844879b9 100644 --- a/v7.4.0/index_redirect.html +++ b/v7.4.0/index_redirect.html @@ -7,7 +7,7 @@ <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> @@ -59,6 +59,7 @@ <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <script src="_static/scripts/furo.js"></script> <script src="_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.async_stats.html b/v7.4.0/output/botcore.async_stats.html index 511a9579..7ddf4e01 100644 --- a/v7.4.0/output/botcore.async_stats.html +++ b/v7.4.0/output/botcore.async_stats.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>async_stats - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </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> @@ -325,7 +329,7 @@ <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"> + <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> @@ -344,7 +348,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</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.10)"><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.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a>.</p></li> @@ -361,7 +365,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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.10)"><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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -416,8 +420,31 @@ </footer> </div> - <aside class="toc-drawer no-toc"> + <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> @@ -427,6 +454,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.exts.html b/v7.4.0/output/botcore.exts.html index 5161af05..b2369c98 100644 --- a/v7.4.0/output/botcore.exts.html +++ b/v7.4.0/output/botcore.exts.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>Exts - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -206,6 +206,10 @@ </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> @@ -392,6 +396,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.html b/v7.4.0/output/botcore.html index 216e5422..354445d5 100644 --- a/v7.4.0/output/botcore.html +++ b/v7.4.0/output/botcore.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>Botcore - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -206,6 +206,10 @@ </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> @@ -344,7 +348,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/_bot.py#L39-L89"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.__init__" title="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>guild_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – 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> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – A list of role IDs that the bot is allowed to mention.</p></li> @@ -363,7 +367,7 @@ a dummy statsd client will be created.</p></li> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -374,7 +378,7 @@ a dummy statsd client will be created.</p></li> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -385,7 +389,7 @@ a dummy statsd client will be created.</p></li> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/_bot.py#L177-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.clear" title="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -396,7 +400,7 @@ a dummy statsd client will be created.</p></li> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/_bot.py#L258-L292"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.close" title="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -408,7 +412,7 @@ a dummy statsd client will be created.</p></li> <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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -419,7 +423,7 @@ a dummy statsd client will be created.</p></li> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -432,7 +436,7 @@ a dummy statsd client will be created.</p></li> <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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -443,7 +447,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -454,7 +458,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -467,7 +471,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><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.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a>]</p> </dd> </dl> @@ -481,7 +485,7 @@ To remove them, either remove the entire command or manually edit <cite>bot.all_ <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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -494,7 +498,7 @@ and <a class="reference internal" href="#botcore.BotBase.ping_services" title="b <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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -520,14 +524,44 @@ gateway event before giving up and thus not populating the cache for unavailable <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></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.interactions.html">interactions</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.regex.html">regex</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html">scheduling</a></li> +<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.interactions.html">interactions</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.DeleteMessageButton"><code class="docutils literal notranslate"><span class="pre">DeleteMessageButton</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.ViewWithUserAndRoleCheck"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck</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> @@ -539,8 +573,34 @@ gateway event before giving up and thus not populating the cache for unavailable <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink 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></li> -<li class="toctree-l1"><a class="reference internal" href="botcore.site_api.html">site_api</a></li> +<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> @@ -604,6 +664,26 @@ gateway event before giving up and thus not populating the cache for unavailable <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> @@ -622,6 +702,7 @@ gateway event before giving up and thus not populating the cache for unavailable <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.site_api.html b/v7.4.0/output/botcore.site_api.html index cd1161df..9c161adf 100644 --- a/v7.4.0/output/botcore.site_api.html +++ b/v7.4.0/output/botcore.site_api.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>site_api - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </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> @@ -325,7 +329,7 @@ <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"> + <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> @@ -344,7 +348,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>site_api_url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The URL of the site API.</p></li> <li><p><strong>site_api_token</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The token to use for authentication.</p></li> @@ -359,7 +363,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -370,17 +374,17 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The endpoint to send the request to.</p></li> <li><p><strong>raise_for_status</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – 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.8)"><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> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</p> </dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dt class="field-odd">Returns</dt> <dd class="field-odd"><p>The JSON response the API returns, or None if the response is 204 No Content.</p> </dd> </dl> @@ -391,7 +395,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> </dd> </dl> @@ -402,16 +406,16 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</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.8)"><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> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – Whether or not to raise an exception.</p></li> </ul> </dd> -<dt class="field-even">Raises<span class="colon">:</span></dt> +<dt class="field-even">Raises</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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -422,7 +426,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> </dd> </dl> @@ -433,7 +437,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> </dd> </dl> @@ -444,7 +448,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> </dd> </dl> @@ -455,7 +459,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>method</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The HTTP method to use.</p></li> <li><p><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The endpoint to send the request to.</p></li> @@ -463,13 +467,13 @@ <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.8)"><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> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> </dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dt class="field-odd">Returns</dt> <dd class="field-odd"><p>The JSON response the API returns.</p> </dd> -<dt class="field-even">Raises<span class="colon">:</span></dt> +<dt class="field-even">Raises</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> @@ -487,7 +491,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</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.8)"><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> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]) – The JSON response returned from the request, if any.</p></li> @@ -552,9 +556,44 @@ </footer> </div> - <aside class="toc-drawer no-toc"> + <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> @@ -563,6 +602,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.utils.caching.html b/v7.4.0/output/botcore.utils.caching.html index 8b4091e3..d88bb1a7 100644 --- a/v7.4.0/output/botcore.utils.caching.html +++ b/v7.4.0/output/botcore.utils.caching.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="channel" href="botcore.utils.channel.html" /><link rel="prev" title="Utils" href="botcore.utils.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>caching - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </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> @@ -325,7 +329,7 @@ <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"> + <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> @@ -346,13 +350,13 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__call__" title="Permalink to this definition">#</a></dt> <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>arg_offset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The offset for the position of the key argument.</p> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a></p> </dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dt class="field-odd">Returns</dt> <dd class="field-odd"><p>A decorator to wrap the target function.</p> </dd> </dl> @@ -363,7 +367,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialise a new <a class="reference internal" href="#botcore.utils.caching.AsyncCache" title="botcore.utils.caching.AsyncCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncCache</span></code></a> instance.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – How many items to store in the cache.</p> </dd> </dl> @@ -374,7 +378,7 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.clear" title="Permalink to this definition">#</a></dt> <dd><p>Clear cache instance.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -429,8 +433,32 @@ </footer> </div> - <aside class="toc-drawer no-toc"> + <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> @@ -440,6 +468,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.utils.channel.html b/v7.4.0/output/botcore.utils.channel.html index d76707a0..1a41f75f 100644 --- a/v7.4.0/output/botcore.utils.channel.html +++ b/v7.4.0/output/botcore.utils.channel.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="interactions" href="botcore.utils.interactions.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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>channel - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </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> @@ -325,7 +329,7 @@ <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"> + <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> @@ -339,13 +343,13 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>bot</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a>) – 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.1.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> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The channel to get/fetch.</p></li> </ul> </dd> -<dt class="field-even">Raises<span class="colon">:</span></dt> +<dt class="field-even">Raises</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.1.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.1.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> @@ -353,10 +357,10 @@ <li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.1.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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a></p> </dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> +<dt class="field-even">Returns</dt> <dd class="field-even"><p>The channel from the ID.</p> </dd> </dl> @@ -367,16 +371,16 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>channel</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a>) – The channel to check.</p></li> <li><p><strong>category_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The category to check for.</p></li> </ul> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></p> </dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dt class="field-odd">Returns</dt> <dd class="field-odd"><p>A bool depending on whether the channel is in the category.</p> </dd> </dl> @@ -429,8 +433,28 @@ </footer> </div> - <aside class="toc-drawer no-toc"> + <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> @@ -440,6 +464,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.utils.html b/v7.4.0/output/botcore.utils.html index 5a806c32..7c3ee93a 100644 --- a/v7.4.0/output/botcore.utils.html +++ b/v7.4.0/output/botcore.utils.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>Utils - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -206,6 +206,10 @@ </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> @@ -347,7 +351,7 @@ that will act as top-level groups rather than being aliases of the command’s g </dd> </dl> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -358,13 +362,13 @@ that will act as top-level groups rather than being aliases of the command’s g <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The module name to unqualify.</p> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p> </dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dt class="field-odd">Returns</dt> <dd class="field-odd"><p>The unqualified module name.</p> </dd> </dl> @@ -374,13 +378,67 @@ that will act as top-level groups rather than being aliases of the command’s g <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink 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></li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.interactions.html">interactions</a></li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.logging.html">logging</a></li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.members.html">members</a></li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.regex.html">regex</a></li> -<li class="toctree-l1"><a class="reference internal" href="botcore.utils.scheduling.html">scheduling</a></li> +<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.interactions.html">interactions</a><ul> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.DeleteMessageButton"><code class="docutils literal notranslate"><span class="pre">DeleteMessageButton</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.DeleteMessageButton.__init__"><code class="docutils literal notranslate"><span class="pre">DeleteMessageButton.__init__()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.DeleteMessageButton.callback"><code class="docutils literal notranslate"><span class="pre">DeleteMessageButton.callback()</span></code></a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.ViewWithUserAndRoleCheck"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck.__init__()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck.interaction_check()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck.on_timeout()</span></code></a></li> +</ul> +</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> @@ -444,6 +502,8 @@ that will act as top-level groups rather than being aliases of the command’s g <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> @@ -461,6 +521,7 @@ that will act as top-level groups rather than being aliases of the command’s g <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.utils.interactions.html b/v7.4.0/output/botcore.utils.interactions.html index 4113b6b7..241fab04 100644 --- a/v7.4.0/output/botcore.utils.interactions.html +++ b/v7.4.0/output/botcore.utils.interactions.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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="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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>interactions - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.interactions.html">v8.2.1</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.interactions.html">v8.2.0</a> </li> @@ -325,7 +329,7 @@ <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"> + <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> @@ -341,7 +345,7 @@ <p>This button itself carries out no interaction checks, these should be done by the parent view.</p> <p>See <a class="reference internal" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck" title="botcore.utils.interactions.ViewWithUserAndRoleCheck"><code class="xref py py-obj docutils literal notranslate"><span class="pre">botcore.utils.interactions.ViewWithUserAndRoleCheck</span></code></a> for a view that implements basic checks.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>style</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ButtonStyle"><code class="docutils literal notranslate"><span class="pre">ButtonStyle</span></code></a>) – The style of the button, set to <code class="docutils literal notranslate"><span class="pre">ButtonStyle.secondary</span></code> if not specified.</p></li> <li><p><strong>label</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The label of the button, set to “Delete” if not specified.</p></li> @@ -358,7 +362,7 @@ <em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">callback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/interactions.py#L96-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton.callback" title="Permalink to this definition">#</a></dt> <dd><p>Delete the original message on button click.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -372,7 +376,7 @@ <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.View" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">View</span></code></a></p> <p>A view that allows the original invoker and moderators to interact with it.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>allowed_users</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]) – A sequence of user’s ids who are allowed to interact with the view.</p></li> <li><p><strong>allowed_roles</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]) – A sequence of role ids that are allowed to interact with the view.</p></li> @@ -393,10 +397,10 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">interaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/interactions.py#L37-L64"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check" title="Permalink to this definition">#</a></dt> <dd><p>Ensure the user clicking the button is the view invoker, or a moderator.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>interaction</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.Interaction" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interaction</span></code></a>) – The interaction that occurred.</p> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></p> </dd> </dl> @@ -407,7 +411,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_timeout</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/603fc83bcfde790f184ddaf0ab2bd5364431d067/botcore/utils/interactions.py#L65-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout" title="Permalink to this definition">#</a></dt> <dd><p>Remove the view from <code class="docutils literal notranslate"><span class="pre">self.message</span></code> if set.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -462,9 +466,38 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod </footer> </div> - <aside class="toc-drawer no-toc"> + <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="#">interactions</a><ul> +<li><a class="reference internal" href="#botcore.utils.interactions.DeleteMessageButton"><code class="docutils literal notranslate"><span class="pre">DeleteMessageButton</span></code></a><ul> +<li><a class="reference internal" href="#botcore.utils.interactions.DeleteMessageButton.__init__"><code class="docutils literal notranslate"><span class="pre">DeleteMessageButton.__init__()</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.interactions.DeleteMessageButton.callback"><code class="docutils literal notranslate"><span class="pre">DeleteMessageButton.callback()</span></code></a></li> +</ul> +</li> +<li><a class="reference internal" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck</span></code></a><ul> +<li><a class="reference internal" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck.__init__()</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck.interaction_check()</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck.on_timeout()</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> + + </div> + </div> + </div> + </aside> </div> @@ -473,6 +506,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.utils.logging.html b/v7.4.0/output/botcore.utils.logging.html index 550ecd3d..0a7d5cb8 100644 --- a/v7.4.0/output/botcore.utils.logging.html +++ b/v7.4.0/output/botcore.utils.logging.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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="interactions" href="botcore.utils.interactions.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>logging - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </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> @@ -325,7 +329,7 @@ <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"> + <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> @@ -348,14 +352,14 @@ </pre></div> </div> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>msg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – 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> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -368,13 +372,13 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – The name given to the logger.</p> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><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></p> </dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dt class="field-odd">Returns</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> @@ -427,8 +431,31 @@ </footer> </div> - <aside class="toc-drawer no-toc"> + <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> @@ -438,6 +465,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.utils.members.html b/v7.4.0/output/botcore.utils.members.html index 872835a1..8db5a133 100644 --- a/v7.4.0/output/botcore.utils.members.html +++ b/v7.4.0/output/botcore.utils.members.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>members - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </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> @@ -325,7 +329,7 @@ <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"> + <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> @@ -339,10 +343,10 @@ <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><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.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a>]</p> </dd> -<dt class="field-even">Returns<span class="colon">:</span></dt> +<dt class="field-even">Returns</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.1.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.10)"><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> @@ -355,14 +359,14 @@ <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.1.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.1.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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>member</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a>) – The member that is being modified for logging purposes.</p></li> <li><p><strong>coro</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><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.1.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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>]) – 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.1.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.1.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> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>) – 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> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -415,8 +419,28 @@ </footer> </div> - <aside class="toc-drawer no-toc"> + <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> @@ -426,6 +450,7 @@ <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.utils.regex.html b/v7.4.0/output/botcore.utils.regex.html index 332ad1eb..6036c421 100644 --- a/v7.4.0/output/botcore.utils.regex.html +++ b/v7.4.0/output/botcore.utils.regex.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>regex - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </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> @@ -325,7 +329,7 @@ <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"> + <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> @@ -411,8 +415,29 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur </footer> </div> - <aside class="toc-drawer no-toc"> + <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> @@ -422,6 +447,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/output/botcore.utils.scheduling.html b/v7.4.0/output/botcore.utils.scheduling.html index 92bc6b1b..6c8a145a 100644 --- a/v7.4.0/output/botcore.utils.scheduling.html +++ b/v7.4.0/output/botcore.utils.scheduling.html @@ -2,10 +2,10 @@ <html class="no-js" lang="en"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> + <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>scheduling - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -138,7 +138,7 @@ <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"> + <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> @@ -206,6 +206,10 @@ </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> @@ -325,7 +329,7 @@ <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"> + <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> @@ -353,13 +357,13 @@ the same ID used to schedule it.</p> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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.10)"><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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – The task to look for.</p> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></p> </dd> -<dt class="field-odd">Returns<span class="colon">:</span></dt> +<dt class="field-odd">Returns</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if the task was found.</p> </dd> </dl> @@ -370,7 +374,7 @@ the same ID used to schedule it.</p> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – 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> @@ -381,10 +385,10 @@ the same ID used to schedule it.</p> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – The task’s unique ID.</p> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -395,7 +399,7 @@ the same ID used to schedule it.</p> <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/603fc83bcfde790f184ddaf0ab2bd5364431d067/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="Permalink 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> +<dt class="field-odd">Return type</dt> <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -408,13 +412,13 @@ the same ID used to schedule it.</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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – A unique ID to create the task with.</p></li> <li><p><strong>coroutine</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>) – The function to be called.</p></li> </ul> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -430,14 +434,14 @@ If <code class="docutils literal notranslate"><span class="pre">time</span></cod <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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>time</strong> (<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a>) – The time to start the task.</p></li> <li><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – A unique ID to create the task with.</p></li> <li><p><strong>coroutine</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>) – The function to be called.</p></li> </ul> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -450,14 +454,14 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>delay</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><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.10)"><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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>]) – How long to wait before starting the task.</p></li> <li><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – A unique ID to create the task with.</p></li> <li><p><strong>coroutine</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>) – The function to be called.</p></li> </ul> </dd> -<dt class="field-even">Return type<span class="colon">:</span></dt> +<dt class="field-even">Return type</dt> <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> </dd> </dl> @@ -472,7 +476,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <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> +<dt class="field-odd">Parameters</dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>coro</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.10)"><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.10)"><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.10)"><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.10)"><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>)]) – The function to call.</p></li> <li><p><strong>suppressed_exceptions</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.10)"><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.10)"><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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a>]]) – Exceptions to be handled by the task.</p></li> @@ -480,10 +484,10 @@ otherwise the running loop is used.</p> <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.10)"><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> +<dt class="field-even">Returns</dt> <dd class="field-even"><p>The wrapped task.</p> </dd> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dt class="field-odd">Return type</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.10)">asyncio.Task</a></p> </dd> </dl> @@ -536,8 +540,37 @@ otherwise the running loop is used.</p> </footer> </div> - <aside class="toc-drawer no-toc"> + <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> @@ -547,6 +580,7 @@ otherwise the running loop is used.</p> <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> + <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/scripts/furo.js"></script> <script src="../_static/changelog.js"></script> </body> diff --git a/v7.4.0/py-modindex.html b/v7.4.0/py-modindex.html index 7d8c01ad..163d2d15 100644 --- a/v7.4.0/py-modindex.html +++ b/v7.4.0/py-modindex.html @@ -4,7 +4,7 @@ <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/><title>Python Module Index - Bot Core v7.4.0</title> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/><title>Python Module Index - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -204,6 +204,10 @@ </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> @@ -454,6 +458,7 @@ <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <script src="_static/scripts/furo.js"></script> <script src="_static/changelog.js"></script> </body> diff --git a/v7.4.0/search.html b/v7.4.0/search.html index 74bb3376..ebf7df19 100644 --- a/v7.4.0/search.html +++ b/v7.4.0/search.html @@ -4,7 +4,7 @@ <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/><title>Search - Bot Core v7.4.0</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" /> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/><title>Search - Bot Core v7.4.0</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/logo.css" /> @@ -203,6 +203,10 @@ </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> @@ -378,6 +382,7 @@ <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <script src="_static/scripts/furo.js"></script> <script src="_static/changelog.js"></script> diff --git a/v7.4.0/searchindex.js b/v7.4.0/searchindex.js index 358d8c42..ffd23722 100644 --- a/v7.4.0/searchindex.js +++ b/v7.4.0/searchindex.js @@ -1 +1 @@ -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.interactions", "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.interactions.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", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "4": 0, "0": [0, 7, 9, 10], "17th": 0, "juli": 0, "2022": 0, "featur": [0, 2], "106": 0, "add": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "option": [0, 2, 3, 5, 7, 9, 10, 11], "messag": [0, 2, 9, 10, 13], "attr": 0, "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "viewwithuserandrolecheck": [0, 9], "On": 0, "view": [0, 9], "timeout": [0, 9], "thi": [0, 2, 6, 8, 9, 11, 12, 13], "ha": [0, 6], "its": [0, 2], "remov": [0, 2, 9], "set": [0, 2, 9], "3": 0, "1": [0, 10], "16th": 0, "bug": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 9], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "wrong": 0, "delet": [0, 5, 7, 9], "method": [0, 3, 5, 6, 10], "103": 0, "button": [0, 9], "attach": 0, "parent": [0, 9], "gener": [0, 2, 13], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "98": 0, "close": [0, 2, 5, 13], "botbas": [0, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 9, 11], "ping_servic": [0, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2, 9], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "now": [0, 13], "25th": 0, "69": 0, "get": [0, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 10, 12, 13], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 6], "namespac": [0, 13], "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, 10], "pagin": 0, "also": [0, 6, 9], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "api_cli": [0, 2], "__init__": [0, 2, 3, 5, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "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, 9, 11], "42": 0, "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, 10, 13], "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, 11, 13], "trace": [0, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "wait_until_guild_avail": 2, "list": 2, "mention": 2, "clientsess": [2, 5], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "add_cog": 2, "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "add_command": 2, "normal": 2, "root": [2, 6], "alias": [2, 6], "clear": [2, 7], "Not": 2, "re": [2, 13], "instanti": [2, 9, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "load_extens": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "log_to_dev_log": 2, "dev": 2, "on_guild_avail": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "on_guild_unavail": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "remove_command": 2, "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "setup_hook": 2, "startup": 2, "asyncstatscli": [2, 3], "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "startuperror": 2, "error": [2, 5, 6, 11], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "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, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": [5, 9], "request": [5, 12], "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "maybe_raise_for_statu": 5, "should_rais": 5, "responsecodeerror": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "post": 5, "put": 5, "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "__str__": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "relat": [7, 10], "asynccach": 7, "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "__call__": 7, "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "get_or_fetch_channel": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "is_in_categori": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "callback": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "ctx": 9, "similar": [9, 12], "after": [9, 13], "interaction_check": 9, "occur": 9, "on_timeout": 9, "customlogg": 10, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "get_logg": 10, "mypi": 10, "recognis": 10, "interactin": 11, "get_or_fetch_memb": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "discord_invit": 12, "pattern": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "formatted_code_regex": 12, "format": 12, "raw_code_regex": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "schedule_at": 13, "schedule_lat": 13, "uniqu": 13, "cancel": 13, "prematur": 13, "same": 13, "current": 13, "__contains__": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "cancel_al": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "union": 13, "long": 13, "create_task": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "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, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 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.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"], [9, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 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, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 56}})
\ No newline at end of file +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.interactions", "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.interactions.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", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "4": 0, "0": [0, 7, 9, 10], "17th": 0, "juli": 0, "2022": 0, "featur": [0, 2], "106": 0, "add": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "option": [0, 2, 3, 5, 7, 9, 10, 11], "messag": [0, 2, 9, 10, 13], "attr": 0, "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "viewwithuserandrolecheck": [0, 2, 6, 9], "On": 0, "view": [0, 9], "timeout": [0, 9], "thi": [0, 2, 6, 8, 9, 11, 12, 13], "ha": [0, 6], "its": [0, 2], "remov": [0, 2, 9], "set": [0, 2, 9], "3": 0, "1": [0, 10], "16th": 0, "bug": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 2, 6, 9], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "wrong": 0, "delet": [0, 2, 5, 7, 9], "method": [0, 3, 5, 6, 10], "103": 0, "button": [0, 9], "attach": 0, "parent": [0, 9], "gener": [0, 2, 13], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 9, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2, 9], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "now": [0, 13], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 10, 12, 13], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "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, 10], "pagin": 0, "also": [0, 6, 9], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "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, 9, 11], "42": 0, "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, 10, 13], "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, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 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, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 9, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 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, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "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, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": [5, 9], "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "on_timeout": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "ctx": 9, "similar": [9, 12], "after": [9, 13], "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "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, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 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.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"], [9, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 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, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"site_api": [[5, "module-botcore.site_api"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "Exts": [[4, "module-botcore.exts"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Submodules": [[2, "submodules"], [6, "submodules"]], "Changelog": [[0, "changelog"]], "async_stats": [[3, "module-botcore.async_stats"]], "Utils": [[6, "module-botcore.utils"]], "regex": [[12, "module-botcore.utils.regex"]], "scheduling": [[13, "module-botcore.utils.scheduling"]], "members": [[11, "module-botcore.utils.members"]], "channel": [[8, "module-botcore.utils.channel"]], "interactions": [[9, "module-botcore.utils.interactions"]], "logging": [[10, "module-botcore.utils.logging"]], "caching": [[7, "module-botcore.utils.caching"]]}, "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.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "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"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}})
\ No newline at end of file diff --git a/v7.4.0/versions.html b/v7.4.0/versions.html index 356526fc..ffad5366 100644 --- a/v7.4.0/versions.html +++ b/v7.4.0/versions.html @@ -4,7 +4,7 @@ <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"/><meta name="generator" content="sphinx-5.1.1, furo 2022.09.15"/> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> <title>Versions - Bot Core v7.4.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -205,6 +205,10 @@ </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> @@ -344,6 +348,12 @@ </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> @@ -492,6 +502,7 @@ <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <script src="_static/scripts/furo.js"></script> <script src="_static/changelog.js"></script> </body> |