diff options
Diffstat (limited to 'main')
53 files changed, 2122 insertions, 414 deletions
diff --git a/main/.buildinfo b/main/.buildinfo index 46f4ae0b..e54d1dd7 100644 --- a/main/.buildinfo +++ b/main/.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: 5b586833627bb5bb18e2537576c48b2f +config: 04fd2a89d8d33e81d591af7ce967b3f7 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/changelog.doctree b/main/.doctrees/changelog.doctree Binary files differindex 06b70a27..fa059237 100644 --- a/main/.doctrees/changelog.doctree +++ b/main/.doctrees/changelog.doctree diff --git a/main/.doctrees/development.doctree b/main/.doctrees/development.doctree Binary files differindex 84830b14..20d338be 100644 --- a/main/.doctrees/development.doctree +++ b/main/.doctrees/development.doctree diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle Binary files differindex 63b4e7fe..08d131cd 100644 --- a/main/.doctrees/environment.pickle +++ b/main/.doctrees/environment.pickle diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree Binary files differindex 972e3668..ac2f53ce 100644 --- a/main/.doctrees/index.doctree +++ b/main/.doctrees/index.doctree diff --git a/main/.doctrees/output/botcore.async_stats.doctree b/main/.doctrees/output/botcore.async_stats.doctree Binary files differindex 88f54c1a..722b8113 100644 --- a/main/.doctrees/output/botcore.async_stats.doctree +++ b/main/.doctrees/output/botcore.async_stats.doctree diff --git a/main/.doctrees/output/botcore.doctree b/main/.doctrees/output/botcore.doctree Binary files differindex 24b9447b..d37fcbf7 100644 --- a/main/.doctrees/output/botcore.doctree +++ b/main/.doctrees/output/botcore.doctree diff --git a/main/.doctrees/output/botcore.exts.doctree b/main/.doctrees/output/botcore.exts.doctree Binary files differindex 6483a6c7..f04862bd 100644 --- a/main/.doctrees/output/botcore.exts.doctree +++ b/main/.doctrees/output/botcore.exts.doctree diff --git a/main/.doctrees/output/botcore.site_api.doctree b/main/.doctrees/output/botcore.site_api.doctree Binary files differindex a1c81260..d492dc26 100644 --- a/main/.doctrees/output/botcore.site_api.doctree +++ b/main/.doctrees/output/botcore.site_api.doctree diff --git a/main/.doctrees/output/botcore.utils.caching.doctree b/main/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 42a8ecf1..8c2f863a 100644 --- a/main/.doctrees/output/botcore.utils.caching.doctree +++ b/main/.doctrees/output/botcore.utils.caching.doctree diff --git a/main/.doctrees/output/botcore.utils.channel.doctree b/main/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 516f9836..39f06578 100644 --- a/main/.doctrees/output/botcore.utils.channel.doctree +++ b/main/.doctrees/output/botcore.utils.channel.doctree diff --git a/main/.doctrees/output/botcore.utils.commands.doctree b/main/.doctrees/output/botcore.utils.commands.doctree Binary files differindex 21d5ec1e..14b6cf72 100644 --- a/main/.doctrees/output/botcore.utils.commands.doctree +++ b/main/.doctrees/output/botcore.utils.commands.doctree diff --git a/main/.doctrees/output/botcore.utils.cooldown.doctree b/main/.doctrees/output/botcore.utils.cooldown.doctree Binary files differnew file mode 100644 index 00000000..18edb2f9 --- /dev/null +++ b/main/.doctrees/output/botcore.utils.cooldown.doctree diff --git a/main/.doctrees/output/botcore.utils.doctree b/main/.doctrees/output/botcore.utils.doctree Binary files differindex 6ea3b8c0..ba173348 100644 --- a/main/.doctrees/output/botcore.utils.doctree +++ b/main/.doctrees/output/botcore.utils.doctree diff --git a/main/.doctrees/output/botcore.utils.function.doctree b/main/.doctrees/output/botcore.utils.function.doctree Binary files differnew file mode 100644 index 00000000..b16b93f4 --- /dev/null +++ b/main/.doctrees/output/botcore.utils.function.doctree diff --git a/main/.doctrees/output/botcore.utils.interactions.doctree b/main/.doctrees/output/botcore.utils.interactions.doctree Binary files differindex 762c5216..82019126 100644 --- a/main/.doctrees/output/botcore.utils.interactions.doctree +++ b/main/.doctrees/output/botcore.utils.interactions.doctree diff --git a/main/.doctrees/output/botcore.utils.logging.doctree b/main/.doctrees/output/botcore.utils.logging.doctree Binary files differindex 74bb2c1b..3838bbe1 100644 --- a/main/.doctrees/output/botcore.utils.logging.doctree +++ b/main/.doctrees/output/botcore.utils.logging.doctree diff --git a/main/.doctrees/output/botcore.utils.members.doctree b/main/.doctrees/output/botcore.utils.members.doctree Binary files differindex 5b94630a..0aa499c4 100644 --- a/main/.doctrees/output/botcore.utils.members.doctree +++ b/main/.doctrees/output/botcore.utils.members.doctree diff --git a/main/.doctrees/output/botcore.utils.regex.doctree b/main/.doctrees/output/botcore.utils.regex.doctree Binary files differindex bf2b00ae..caf0a96d 100644 --- a/main/.doctrees/output/botcore.utils.regex.doctree +++ b/main/.doctrees/output/botcore.utils.regex.doctree diff --git a/main/.doctrees/output/botcore.utils.scheduling.doctree b/main/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex d101d132..54f6af1b 100644 --- a/main/.doctrees/output/botcore.utils.scheduling.doctree +++ b/main/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/main/_sources/output/botcore.utils.cooldown.rst.txt b/main/_sources/output/botcore.utils.cooldown.rst.txt new file mode 100644 index 00000000..fea7e5e8 --- /dev/null +++ b/main/_sources/output/botcore.utils.cooldown.rst.txt @@ -0,0 +1,7 @@ +cooldown +============================= + +.. automodule:: botcore.utils.cooldown + :members: + :special-members: + :show-inheritance: diff --git a/main/_sources/output/botcore.utils.function.rst.txt b/main/_sources/output/botcore.utils.function.rst.txt new file mode 100644 index 00000000..e8b4fd4f --- /dev/null +++ b/main/_sources/output/botcore.utils.function.rst.txt @@ -0,0 +1,7 @@ +function +============================= + +.. automodule:: botcore.utils.function + :members: + :special-members: + :show-inheritance: diff --git a/main/_sources/output/botcore.utils.rst.txt b/main/_sources/output/botcore.utils.rst.txt index a954585c..a8ec4588 100644 --- a/main/_sources/output/botcore.utils.rst.txt +++ b/main/_sources/output/botcore.utils.rst.txt @@ -15,6 +15,8 @@ Submodules botcore.utils.caching botcore.utils.channel botcore.utils.commands + botcore.utils.cooldown + botcore.utils.function botcore.utils.interactions botcore.utils.logging botcore.utils.members diff --git a/main/_static/basic.css b/main/_static/basic.css index 4e9a9f1f..eeb0519a 100644 --- a/main/_static/basic.css +++ b/main/_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/main/_static/doctools.js b/main/_static/doctools.js index c3db08d1..527b876c 100644 --- a/main/_static/doctools.js +++ b/main/_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/main/_static/pygments.css b/main/_static/pygments.css index 75471509..053cfd3d 100644 --- a/main/_static/pygments.css +++ b/main/_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/main/_static/searchtools.js b/main/_static/searchtools.js index f2fb7d5c..e89e34d4 100644 --- a/main/_static/searchtools.js +++ b/main/_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/main/_static/sphinx_highlight.js b/main/_static/sphinx_highlight.js new file mode 100644 index 00000000..aae669d7 --- /dev/null +++ b/main/_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/main/changelog.html b/main/changelog.html index 266df3f4..aeb52311 100644 --- a/main/changelog.html +++ b/main/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="Local Development & Testing" href="development.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 Latest (8.2.1)</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> @@ -208,6 +210,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> @@ -599,6 +605,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/main/development.html b/main/development.html index 158c5abb..2e577336 100644 --- a/main/development.html +++ b/main/development.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="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>Local Development & Testing - Bot Core Latest (8.2.1)</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> @@ -208,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v8.2.1/development.html">v8.2.1</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v8.2.0/development.html">v8.2.0</a> </li> @@ -468,6 +474,7 @@ to help you test out certain features. Use them as needed.</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/main/genindex.html b/main/genindex.html index d4f4aff3..e494efe3 100644 --- a/main/genindex.html +++ b/main/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 Latest (8.2.1)</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 Latest (8.2.1)</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" /> @@ -167,6 +167,8 @@ <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> @@ -206,6 +208,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> @@ -353,6 +359,8 @@ </li> <li><a href="output/botcore.html#botcore.BotBase.__init__">(BotBase method)</a> </li> + <li><a href="output/botcore.utils.cooldown.html#botcore.utils.cooldown.CommandOnCooldown.__init__">(CommandOnCooldown method)</a> +</li> <li><a href="output/botcore.utils.interactions.html#botcore.utils.interactions.DeleteMessageButton.__init__">(DeleteMessageButton method)</a> </li> <li><a href="output/botcore.site_api.html#botcore.site_api.ResponseCodeError.__init__">(ResponseCodeError method)</a> @@ -398,6 +406,8 @@ <h2>B</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="output/botcore.utils.cooldown.html#botcore.utils.cooldown.block_duplicate_invocations">block_duplicate_invocations() (in module botcore.utils.cooldown)</a> +</li> <li><a href="output/botcore.html#botcore.BotBase">BotBase (class in botcore)</a> </li> <li> @@ -442,8 +452,6 @@ <li><a href="output/botcore.utils.caching.html#module-botcore.utils.caching">module</a> </li> </ul></li> - </ul></td> - <td style="width: 33%; vertical-align: top;"><ul> <li> botcore.utils.channel @@ -451,6 +459,8 @@ <li><a href="output/botcore.utils.channel.html#module-botcore.utils.channel">module</a> </li> </ul></li> + </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> <li> botcore.utils.commands @@ -459,6 +469,20 @@ </li> </ul></li> <li> + botcore.utils.cooldown + + <ul> + <li><a href="output/botcore.utils.cooldown.html#module-botcore.utils.cooldown">module</a> +</li> + </ul></li> + <li> + botcore.utils.function + + <ul> + <li><a href="output/botcore.utils.function.html#module-botcore.utils.function">module</a> +</li> + </ul></li> + <li> botcore.utils.interactions <ul> @@ -501,6 +525,8 @@ <h2>C</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="output/botcore.utils.cooldown.html#botcore.utils.cooldown.CommandOnCooldown.call_without_cooldown">call_without_cooldown() (CommandOnCooldown method)</a> +</li> <li><a href="output/botcore.utils.interactions.html#botcore.utils.interactions.DeleteMessageButton.callback">callback() (DeleteMessageButton method)</a> </li> <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler.cancel">cancel() (Scheduler method)</a> @@ -523,6 +549,10 @@ <li><a href="output/botcore.html#botcore.BotBase.close">(BotBase method)</a> </li> </ul></li> + <li><a href="output/botcore.utils.function.html#botcore.utils.function.command_wraps">command_wraps() (in module botcore.utils.function)</a> +</li> + <li><a href="output/botcore.utils.cooldown.html#botcore.utils.cooldown.CommandOnCooldown">CommandOnCooldown</a> +</li> <li><a href="output/botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket">create_socket() (AsyncStatsClient method)</a> </li> <li><a href="output/botcore.utils.scheduling.html#botcore.utils.scheduling.create_task">create_task() (in module botcore.utils.scheduling)</a> @@ -573,6 +603,8 @@ </li> <li><a href="output/botcore.utils.members.html#botcore.utils.members.get_or_fetch_member">get_or_fetch_member() (in module botcore.utils.members)</a> </li> + <li><a href="output/botcore.utils.function.html#botcore.utils.function.GlobalNameConflictError">GlobalNameConflictError</a> +</li> </ul></td> </tr></table> </section> @@ -641,6 +673,10 @@ </li> <li><a href="output/botcore.utils.commands.html#module-botcore.utils.commands">botcore.utils.commands</a> </li> + <li><a href="output/botcore.utils.cooldown.html#module-botcore.utils.cooldown">botcore.utils.cooldown</a> +</li> + <li><a href="output/botcore.utils.function.html#module-botcore.utils.function">botcore.utils.function</a> +</li> <li><a href="output/botcore.utils.interactions.html#module-botcore.utils.interactions">botcore.utils.interactions</a> </li> <li><a href="output/botcore.utils.logging.html#module-botcore.utils.logging">botcore.utils.logging</a> @@ -676,12 +712,14 @@ <h2>P</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.patch">patch() (APIClient method)</a> + <li><a href="output/botcore.utils.cooldown.html#botcore.utils.cooldown.P">P (in module botcore.utils.cooldown)</a> </li> - <li><a href="output/botcore.html#botcore.BotBase.ping_services">ping_services() (BotBase method)</a> + <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.patch">patch() (APIClient method)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="output/botcore.html#botcore.BotBase.ping_services">ping_services() (BotBase method)</a> +</li> <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.post">post() (APIClient method)</a> </li> <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.put">put() (APIClient method)</a> @@ -694,12 +732,14 @@ <h2>R</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%; vertical-align: top;"><ul> - <li><a href="output/botcore.utils.regex.html#botcore.utils.regex.RAW_CODE_REGEX">RAW_CODE_REGEX (in module botcore.utils.regex)</a> + <li><a href="output/botcore.utils.cooldown.html#botcore.utils.cooldown.R">R (in module botcore.utils.cooldown)</a> </li> - <li><a href="output/botcore.html#botcore.BotBase.remove_command">remove_command() (BotBase method)</a> + <li><a href="output/botcore.utils.regex.html#botcore.utils.regex.RAW_CODE_REGEX">RAW_CODE_REGEX (in module botcore.utils.regex)</a> </li> </ul></td> <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="output/botcore.html#botcore.BotBase.remove_command">remove_command() (BotBase method)</a> +</li> <li><a href="output/botcore.site_api.html#botcore.site_api.APIClient.request">request() (APIClient method)</a> </li> <li><a href="output/botcore.site_api.html#botcore.site_api.ResponseCodeError">ResponseCodeError</a> @@ -747,6 +787,10 @@ <li><a href="output/botcore.utils.html#botcore.utils.unqualify">unqualify() (in module botcore.utils)</a> </li> </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="output/botcore.utils.function.html#botcore.utils.function.update_wrapper_globals">update_wrapper_globals() (in module botcore.utils.function)</a> +</li> + </ul></td> </tr></table> </section> @@ -809,6 +853,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/main/index.html b/main/index.html index fb51e666..dc532fe1 100644 --- a/main/index.html +++ b/main/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 Latest (8.2.1)</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> @@ -208,6 +210,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> @@ -342,17 +348,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> @@ -419,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/main/index_redirect.html b/main/index_redirect.html index 7571c0f4..2fe06325 100644 --- a/main/index_redirect.html +++ b/main/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 Latest (8.2.1)</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/main/objects.inv b/main/objects.inv Binary files differindex 8d288c14..c8c1cbe0 100644 --- a/main/objects.inv +++ b/main/objects.inv diff --git a/main/output/botcore.async_stats.html b/main/output/botcore.async_stats.html index e84af677..4bb7b08d 100644 --- a/main/output/botcore.async_stats.html +++ b/main/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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -338,15 +344,15 @@ <p>An async transport method for statsd communication.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatsClientBase</span></code></a></p> <p>An async implementation of <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statsd.client.base.StatsClientBase</span></code></a> that supports async stat communication.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -360,10 +366,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.create_socket"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -418,8 +424,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> @@ -429,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/main/output/botcore.exts.html b/main/output/botcore.exts.html index 12672113..83220387 100644 --- a/main/output/botcore.exts.html +++ b/main/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 Latest (8.2.1)</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -394,6 +400,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/main/output/botcore.html b/main/output/botcore.html index bb7b9bec..620b3091 100644 --- a/main/output/botcore.html +++ b/main/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 Latest (8.2.1)</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -338,15 +344,15 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.BotBase"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L36-L289"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L36-L289"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></p> <p>A sub-class that implements many common features that Python Discord bots use.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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 used 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> @@ -362,10 +368,10 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.add_cog"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -373,10 +379,10 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.add_command"> -<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -384,10 +390,10 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.clear"> -<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -395,10 +401,10 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L258-L289"><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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L258-L289"><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> @@ -406,11 +412,11 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.load_extensions"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Permalink to this definition">#</a></dt> <dd><p>Load all the extensions within the given module and save them to <code class="docutils literal notranslate"><span class="pre">self.all_extensions</span></code>.</p> <p>This should be ran in a task on the event loop to avoid deadlocks caused by <code class="docutils literal notranslate"><span class="pre">wait_for</span></code> calls.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<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> @@ -418,10 +424,10 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.log_to_dev_log"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -429,12 +435,12 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.on_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Permalink to this definition">#</a></dt> <dd><p>Set the internal guild available event when self.guild_id becomes available.</p> <p>If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<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> @@ -442,10 +448,10 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.on_guild_unavailable"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -453,10 +459,10 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.ping_services"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -464,12 +470,12 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.remove_command"> -<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Permalink to this definition">#</a></dt> <dd><p>Remove a command/alias as normal and then remove its root aliases from the bot.</p> <p>Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<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> @@ -477,13 +483,13 @@ To remove them, either remove the entire command or manually edit <cite>bot.all_ <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.setup_hook"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L218-L253"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L218-L253"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Permalink to this definition">#</a></dt> <dd><p>An async init to startup generic services.</p> <p>Connects to statsd, and calls <a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket" title="botcore.async_stats.AsyncStatsClient.create_socket"><code class="xref py py-func docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket</span></code></a> and <a class="reference internal" href="#botcore.BotBase.ping_services" title="botcore.BotBase.ping_services"><code class="xref py py-func docutils literal notranslate"><span class="pre">ping_services()</span></code></a>.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<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> @@ -491,12 +497,12 @@ and <a class="reference internal" href="#botcore.BotBase.ping_services" title="b <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.wait_until_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Permalink to this definition">#</a></dt> <dd><p>Wait until the guild that matches the <code class="docutils literal notranslate"><span class="pre">guild_id</span></code> given at init is available (and the cache is ready).</p> <p>The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE gateway event before giving up and thus not populating the cache for unavailable guilds.</p> <dl class="field-list simple"> -<dt class="field-odd">Return type<span class="colon">:</span></dt> +<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> @@ -506,12 +512,12 @@ gateway event before giving up and thus not populating the cache for unavailable <dl class="py exception"> <dt class="sig sig-object py" id="botcore.StartupError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Exception class for startup errors.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.StartupError.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/_bot.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/_bot.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Permalink to this definition">#</a></dt> <dd></dd></dl> </dd></dl> @@ -522,15 +528,61 @@ 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.commands.html">commands</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html">interactions</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.logging.html">logging</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.members.html">members</a></li> -<li class="toctree-l3"><a class="reference internal" href="botcore.utils.regex.html">regex</a></li> -<li class="toctree-l3"><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.commands.html">commands</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.commands.html#botcore.utils.commands.clean_text_or_reply"><code class="docutils literal notranslate"><span class="pre">clean_text_or_reply()</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.CommandOnCooldown"><code class="docutils literal notranslate"><span class="pre">CommandOnCooldown</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.P"><code class="docutils literal notranslate"><span class="pre">P</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.R"><code class="docutils literal notranslate"><span class="pre">R</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.block_duplicate_invocations"><code class="docutils literal notranslate"><span class="pre">block_duplicate_invocations()</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.GlobalNameConflictError"><code class="docutils literal notranslate"><span class="pre">GlobalNameConflictError</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.command_wraps"><code class="docutils literal notranslate"><span class="pre">command_wraps()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.update_wrapper_globals"><code class="docutils literal notranslate"><span class="pre">update_wrapper_globals()</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> @@ -542,8 +594,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> @@ -607,6 +685,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> @@ -625,6 +723,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/main/output/botcore.site_api.html b/main/output/botcore.site_api.html index 91d7cf85..7efb6bf7 100644 --- a/main/output/botcore.site_api.html +++ b/main/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="Local Development & Testing" href="../development.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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -338,15 +344,15 @@ <p>An API wrapper around the Site API.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.site_api.APIClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/site_api.py#L42-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/site_api.py#L42-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>A wrapper for the Django Site API.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -358,10 +364,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -369,20 +375,20 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.delete"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -390,10 +396,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.get"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -401,19 +407,19 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.maybe_raise_for_status"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -421,10 +427,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.patch"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -432,10 +438,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.post"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -443,10 +449,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.put"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -454,10 +460,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.request"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -465,13 +471,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> @@ -481,15 +487,15 @@ <dl class="py exception"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a></p> <p>Raised in <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> when a non-OK HTTP response is received.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -501,7 +507,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__str__"> -<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Permalink to this definition">#</a></dt> <dd><p>Return a string representation of the error.</p> </dd></dl> @@ -554,9 +560,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> @@ -565,6 +606,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/main/output/botcore.utils.caching.html b/main/output/botcore.utils.caching.html index 122046a8..6e37c523 100644 --- a/main/output/botcore.utils.caching.html +++ b/main/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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -338,23 +344,23 @@ <p>Utilities related to custom caches.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>LRU cache implementation for coroutines.</p> <p>Once the cache exceeds the maximum size, keys are deleted in FIFO order.</p> <p>An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__call__"> -<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -362,10 +368,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -373,10 +379,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.clear"> -<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -431,8 +437,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> @@ -442,6 +472,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/main/output/botcore.utils.channel.html b/main/output/botcore.utils.channel.html index 73e0821b..097b7364 100644 --- a/main/output/botcore.utils.channel.html +++ b/main/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="commands" href="botcore.utils.commands.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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -338,16 +344,16 @@ <p>Useful helper functions for interacting with various discord channel objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.channel.get_or_fetch_channel"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -355,10 +361,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> @@ -366,19 +372,19 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.channel.is_in_category"> -<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -431,8 +437,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> @@ -442,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/main/output/botcore.utils.commands.html b/main/output/botcore.utils.commands.html index e2e724be..b43e36f2 100644 --- a/main/output/botcore.utils.commands.html +++ b/main/output/botcore.utils.commands.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/" /> -<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="channel" href="botcore.utils.channel.html" /> + <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="cooldown" href="botcore.utils.cooldown.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>commands - Bot Core Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.2.1/output/botcore.utils.commands.html">v8.2.1</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.2.0/output/botcore.utils.commands.html">v8.2.0</a> </li> @@ -327,7 +333,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> @@ -337,22 +343,22 @@ <span id="commands"></span><h1>commands<a class="headerlink" href="#module-botcore.utils.commands" title="Permalink to this heading">#</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.commands.clean_text_or_reply"> -<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">clean_text_or_reply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/commands.py#L7-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.commands.clean_text_or_reply" title="Permalink to this definition">#</a></dt> +<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">clean_text_or_reply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/commands.py#L7-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.commands.clean_text_or_reply" title="Permalink to this definition">#</a></dt> <dd><p>Cleans a text argument or replied message’s content.</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>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Context</span></code></a>) – The command’s context</p></li> <li><p><strong>text</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 provided text argument of the command (if given)</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 external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BadArgument" title="(in discord.py v2.1.0a)"><strong>discord.ext.commands.BadArgument</strong></a> – <cite>text</cite> wasn’t provided and there’s no reply message / reply message content.</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/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-even">Returns<span class="colon">:</span></dt> +<dt class="field-even">Returns</dt> <dd class="field-even"><p>The cleaned version of <cite>text</cite>, if given, else replied message.</p> </dd> </dl> @@ -365,12 +371,12 @@ <footer> <div class="related-pages"> - <a class="next-page" href="botcore.utils.interactions.html"> + <a class="next-page" href="botcore.utils.cooldown.html"> <div class="page-info"> <div class="context"> <span>Next</span> </div> - <div class="title">interactions</div> + <div class="title">cooldown</div> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> @@ -405,8 +411,27 @@ </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="#">commands</a><ul> +<li><a class="reference internal" href="#botcore.utils.commands.clean_text_or_reply"><code class="docutils literal notranslate"><span class="pre">clean_text_or_reply()</span></code></a></li> +</ul> +</li> +</ul> + + </div> + </div> + </div> </aside> @@ -416,6 +441,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/main/output/botcore.utils.cooldown.html b/main/output/botcore.utils.cooldown.html new file mode 100644 index 00000000..3b287e8f --- /dev/null +++ b/main/output/botcore.utils.cooldown.html @@ -0,0 +1,498 @@ +<!doctype html> +<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.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="function" href="botcore.utils.function.html" /><link rel="prev" title="commands" href="botcore.utils.commands.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.2.2, furo 2022.09.15"/> + <title>cooldown - Bot Core Latest (8.2.1)</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" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css" /> + <link rel="stylesheet" type="text/css" href="../_static/index.css" /> + + + + +<style> + body { + --color-code-background: #f8f8f8; + --color-code-foreground: black; + --color-api-name: var(--color-link); + + } + @media not print { + body[data-theme="dark"] { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + @media (prefers-color-scheme: dark) { + body:not([data-theme="light"]) { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + } + } +</style></head> + <body> + + <script> + document.body.dataset.theme = localStorage.getItem("theme") || "auto"; + </script> + + +<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> + <symbol id="svg-toc" viewBox="0 0 24 24"> + <title>Contents</title> + <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> + <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> + </svg> + </symbol> + <symbol id="svg-menu" viewBox="0 0 24 24"> + <title>Menu</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> + <line x1="3" y1="12" x2="21" y2="12"></line> + <line x1="3" y1="6" x2="21" y2="6"></line> + <line x1="3" y1="18" x2="21" y2="18"></line> + </svg> + </symbol> + <symbol id="svg-arrow-right" viewBox="0 0 24 24"> + <title>Expand</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> + <polyline points="9 18 15 12 9 6"></polyline> + </svg> + </symbol> + <symbol id="svg-sun" viewBox="0 0 24 24"> + <title>Light mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> + <circle cx="12" cy="12" r="5"></circle> + <line x1="12" y1="1" x2="12" y2="3"></line> + <line x1="12" y1="21" x2="12" y2="23"></line> + <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> + <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> + <line x1="1" y1="12" x2="3" y2="12"></line> + <line x1="21" y1="12" x2="23" y2="12"></line> + <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> + <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> + </svg> + </symbol> + <symbol id="svg-moon" viewBox="0 0 24 24"> + <title>Dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> + <path stroke="none" d="M0 0h24v24H0z" fill="none" /> + <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> + </svg> + </symbol> + <symbol id="svg-sun-half" viewBox="0 0 24 24"> + <title>Auto light/dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> + <path stroke="none" d="M0 0h24v24H0z" fill="none"/> + <circle cx="12" cy="12" r="9" /> + <path d="M13 12h5" /> + <path d="M13 15h4" /> + <path d="M13 18h1" /> + <path d="M13 9h4" /> + <path d="M13 6h1" /> + </svg> + </symbol> +</svg> + +<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> +<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> +<label class="overlay sidebar-overlay" for="__navigation"> + <div class="visually-hidden">Hide navigation sidebar</div> +</label> +<label class="overlay toc-overlay" for="__toc"> + <div class="visually-hidden">Hide table of contents sidebar</div> +</label> + + + +<div class="page"> + <header class="mobile-header"> + <div class="header-left"> + <label class="nav-overlay-icon" for="__navigation"> + <div class="visually-hidden">Toggle site navigation sidebar</div> + <i class="icon"><svg><use href="#svg-menu"></use></svg></i> + </label> + </div> + <div class="header-center"> + <a href="../index.html"><div class="brand">Bot Core Latest (8.2.1)</div></a> + </div> + <div class="header-right"> + <div class="theme-toggle-container theme-toggle-header"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-header-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + </header> + <aside class="sidebar-drawer"> + <div class="sidebar-container"> + + <div class="sidebar-sticky"><a class="sidebar-brand centered" href="../index.html"> + + <div class="sidebar-logo-container"> + <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> + </div> + + <span class="sidebar-brand-text">Bot Core Latest (8.2.1)</span> + +</a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> + <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> + <input type="hidden" name="check_keywords" value="yes"> + <input type="hidden" name="area" value="default"> +</form> +<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> + <p class="caption" role="heading"><span class="caption-text">Modules:</span></p> +<ul class="current"> +<li class="toctree-l1 current has-children"><a class="reference internal" href="botcore.html">Botcore</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="botcore.exts.html">Exts</a></li> +<li class="toctree-l2 current has-children"><a class="reference internal" href="botcore.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="botcore.async_stats.html">async_stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html">site_api</a></li> +</ul> +</li> +</ul> +<p class="caption" role="heading"><span class="caption-text">Other:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Local Development & Testing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> +</ul> + + + + + <ul> + <li class="toctree-l1 has-children "> + + <a class="reference internal" href="../versions.html">Versions</a> + <input class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox"> + <label for="toctree-checkbox-versions"> + <div class="visually-hidden">Toggle child pages in navigation</div> + <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i> + </label> + + + <ul> + + <li class="toctree-l2 current-page"> + <a class="version_link reference internal" href="botcore.utils.cooldown.html">main</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.2.1/index.html">v8.2.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.2.0/index.html">v8.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/index.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0-beta.3/index.html">v8.0.0-beta.3</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0-beta.2/index.html">v8.0.0-beta.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0-beta.1/index.html">v8.0.0-beta.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0/index.html">v8.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.5.0/index.html">v7.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0-beta1/index.html">v7.4.0-beta1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/index.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.3.1/index.html">v7.3.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.3.0/index.html">v7.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.2.2/index.html">v7.2.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.2.1/index.html">v7.2.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.2.0/index.html">v7.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.1.3/index.html">v7.1.3</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.1.2/index.html">v7.1.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.1.1/index.html">v7.1.1</a> + </li> + + + <script> + // Make sure we keep any hyperlinked resources when switching version + function updateHash() { + for (let tag of document.getElementsByClassName("version_link")) { + // Extract the original URL + let destination = tag.getAttribute("href"); + if (destination.indexOf("#") !== -1) { + destination = destination.slice(0, destination.indexOf("#")); + } + + // Update the url with the current hash + tag.setAttribute("href", destination + document.location.hash); + } + } + + updateHash(); + addEventListener("hashchange", _ => { updateHash() }); + </script> + </ul> + </li> + </ul> + +</div> +</div> + + </div> + + </div> + </aside> + <div class="main"> + <div class="content"> + <div class="article-container"> + <a href="#" class="back-to-top muted-link"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> + <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> + </svg> + <span>Back to top</span> + </a> + <div class="content-icon-container"> + <div class="theme-toggle-container theme-toggle-content"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-content-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + <article role="main"> + <section id="module-botcore.utils.cooldown"> +<span id="cooldown"></span><h1>cooldown<a class="headerlink" href="#module-botcore.utils.cooldown" title="Permalink to this heading">#</a></h1> +<p>Helpers for setting a cooldown on commands.</p> +<dl class="py exception"> +<dt class="sig sig-object py" id="botcore.utils.cooldown.CommandOnCooldown"> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommandOnCooldown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/cooldown.py#L37-L61"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.cooldown.CommandOnCooldown" title="Permalink to this definition">#</a></dt> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CommandError" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommandError</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generic" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Generic</span></code></a>[<a class="reference internal" href="#botcore.utils.cooldown.P" title="botcore.utils.cooldown.P"><code class="xref py py-obj docutils literal notranslate"><span class="pre">P</span></code></a>, <a class="reference internal" href="#botcore.utils.cooldown.R" title="botcore.utils.cooldown.R"><code class="xref py py-obj docutils literal notranslate"><span class="pre">R</span></code></a>]</p> +<p>Raised when a command is invoked while on cooldown.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="botcore.utils.cooldown.CommandOnCooldown.__init__"> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/cooldown.py#L40-L52"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.cooldown.CommandOnCooldown.__init__" title="Permalink to this definition">#</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="botcore.utils.cooldown.CommandOnCooldown.call_without_cooldown"> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">call_without_cooldown</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/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/cooldown.py#L53-L61"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.cooldown.CommandOnCooldown.call_without_cooldown" title="Permalink to this definition">#</a></dt> +<dd><p>Run the command this cooldown blocked.</p> +<dl class="field-list simple"> +<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.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">R</span></code>)</p> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>The command’s return value.</p> +</dd> +</dl> +</dd></dl> + +</dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="botcore.utils.cooldown.P"> +<span class="sig-name descname"><span class="pre">P</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">~P</span></em><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/cooldown.py#L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.cooldown.P" title="Permalink to this definition">#</a></dt> +<dd><p>The command’s signature.</p> +</dd></dl> + +<dl class="py data"> +<dt class="sig sig-object py" id="botcore.utils.cooldown.R"> +<span class="sig-name descname"><span class="pre">R</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/cooldown.py#L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.cooldown.R" title="Permalink to this definition">#</a></dt> +<dd><p>The command’s return value.</p> +<p>alias of TypeVar(‘R’)</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="botcore.utils.cooldown.block_duplicate_invocations"> +<span class="sig-name descname"><span class="pre">block_duplicate_invocations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cooldown_duration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">send_notice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args_preprocessor</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/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/cooldown.py#L175-L221"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.cooldown.block_duplicate_invocations" title="Permalink to this definition">#</a></dt> +<dd><p>Prevent duplicate invocations of a command with the same arguments in a channel for <code class="docutils literal notranslate"><span class="pre">cooldown_duration</span></code> seconds.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>cooldown_duration</strong> (<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>) – Length of the cooldown in seconds.</p></li> +<li><p><strong>send_notice</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>) – If <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>, notify the user about the cooldown with a reply.</p></li> +<li><p><strong>args_preprocessor</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/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>), <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a>]]]) – If specified, this function is called with the args and kwargs the function is called with, +its return value is then used to check for the cooldown instead of the raw arguments.</p></li> +</ul> +</dd> +<dt class="field-even">Return type</dt> +<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>), <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</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">R</span></code>)]], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>), <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</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">R</span></code>)]]]</p> +</dd> +<dt class="field-odd">Returns</dt> +<dd class="field-odd"><p>A decorator that adds a wrapper which applies the cooldowns.</p> +</dd> +</dl> +<div class="admonition warning"> +<p class="admonition-title">Warning</p> +<p>The created wrapper raises <a class="reference internal" href="#botcore.utils.cooldown.CommandOnCooldown" title="botcore.utils.cooldown.CommandOnCooldown"><code class="xref py py-exc docutils literal notranslate"><span class="pre">CommandOnCooldown</span></code></a> when the command is on cooldown.</p> +</div> +</dd></dl> + +</section> + + </article> + </div> + <footer> + + <div class="related-pages"> + <a class="next-page" href="botcore.utils.function.html"> + <div class="page-info"> + <div class="context"> + <span>Next</span> + </div> + <div class="title">function</div> + </div> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + </a> + <a class="prev-page" href="botcore.utils.commands.html"> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + <div class="page-info"> + <div class="context"> + <span>Previous</span> + </div> + + <div class="title">commands</div> + + </div> + </a> + </div> + <div class="bottom-of-page"> + <div class="left-details"> + <div class="copyright"> + Copyright © 2021, Python Discord + </div> + Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s + + <a href="https://github.com/pradyunsg/furo">Furo</a> + + </div> + <div class="right-details"> + <div class="icons"> + + </div> + </div> + </div> + + </footer> + </div> + <aside class="toc-drawer"> + + + <div class="toc-sticky toc-scroll"> + <div class="toc-title-container"> + <span class="toc-title"> + On this page + </span> + </div> + <div class="toc-tree-container"> + <div class="toc-tree"> + <ul> +<li><a class="reference internal" href="#">cooldown</a><ul> +<li><a class="reference internal" href="#botcore.utils.cooldown.CommandOnCooldown"><code class="docutils literal notranslate"><span class="pre">CommandOnCooldown</span></code></a><ul> +<li><a class="reference internal" href="#botcore.utils.cooldown.CommandOnCooldown.__init__"><code class="docutils literal notranslate"><span class="pre">CommandOnCooldown.__init__()</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.cooldown.CommandOnCooldown.call_without_cooldown"><code class="docutils literal notranslate"><span class="pre">CommandOnCooldown.call_without_cooldown()</span></code></a></li> +</ul> +</li> +<li><a class="reference internal" href="#botcore.utils.cooldown.P"><code class="docutils literal notranslate"><span class="pre">P</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.cooldown.R"><code class="docutils literal notranslate"><span class="pre">R</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.cooldown.block_duplicate_invocations"><code class="docutils literal notranslate"><span class="pre">block_duplicate_invocations()</span></code></a></li> +</ul> +</li> +</ul> + + </div> + </div> + </div> + + + </aside> + </div> +</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <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> +</html>
\ No newline at end of file diff --git a/main/output/botcore.utils.function.html b/main/output/botcore.utils.function.html new file mode 100644 index 00000000..b3acdf6a --- /dev/null +++ b/main/output/botcore.utils.function.html @@ -0,0 +1,489 @@ +<!doctype html> +<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.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="cooldown" href="botcore.utils.cooldown.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.2.2, furo 2022.09.15"/> + <title>function - Bot Core Latest (8.2.1)</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" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css" /> + <link rel="stylesheet" type="text/css" href="../_static/index.css" /> + + + + +<style> + body { + --color-code-background: #f8f8f8; + --color-code-foreground: black; + --color-api-name: var(--color-link); + + } + @media not print { + body[data-theme="dark"] { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + @media (prefers-color-scheme: dark) { + body:not([data-theme="light"]) { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + } + } +</style></head> + <body> + + <script> + document.body.dataset.theme = localStorage.getItem("theme") || "auto"; + </script> + + +<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> + <symbol id="svg-toc" viewBox="0 0 24 24"> + <title>Contents</title> + <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> + <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> + </svg> + </symbol> + <symbol id="svg-menu" viewBox="0 0 24 24"> + <title>Menu</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> + <line x1="3" y1="12" x2="21" y2="12"></line> + <line x1="3" y1="6" x2="21" y2="6"></line> + <line x1="3" y1="18" x2="21" y2="18"></line> + </svg> + </symbol> + <symbol id="svg-arrow-right" viewBox="0 0 24 24"> + <title>Expand</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> + <polyline points="9 18 15 12 9 6"></polyline> + </svg> + </symbol> + <symbol id="svg-sun" viewBox="0 0 24 24"> + <title>Light mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> + <circle cx="12" cy="12" r="5"></circle> + <line x1="12" y1="1" x2="12" y2="3"></line> + <line x1="12" y1="21" x2="12" y2="23"></line> + <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> + <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> + <line x1="1" y1="12" x2="3" y2="12"></line> + <line x1="21" y1="12" x2="23" y2="12"></line> + <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> + <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> + </svg> + </symbol> + <symbol id="svg-moon" viewBox="0 0 24 24"> + <title>Dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> + <path stroke="none" d="M0 0h24v24H0z" fill="none" /> + <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> + </svg> + </symbol> + <symbol id="svg-sun-half" viewBox="0 0 24 24"> + <title>Auto light/dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> + <path stroke="none" d="M0 0h24v24H0z" fill="none"/> + <circle cx="12" cy="12" r="9" /> + <path d="M13 12h5" /> + <path d="M13 15h4" /> + <path d="M13 18h1" /> + <path d="M13 9h4" /> + <path d="M13 6h1" /> + </svg> + </symbol> +</svg> + +<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> +<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> +<label class="overlay sidebar-overlay" for="__navigation"> + <div class="visually-hidden">Hide navigation sidebar</div> +</label> +<label class="overlay toc-overlay" for="__toc"> + <div class="visually-hidden">Hide table of contents sidebar</div> +</label> + + + +<div class="page"> + <header class="mobile-header"> + <div class="header-left"> + <label class="nav-overlay-icon" for="__navigation"> + <div class="visually-hidden">Toggle site navigation sidebar</div> + <i class="icon"><svg><use href="#svg-menu"></use></svg></i> + </label> + </div> + <div class="header-center"> + <a href="../index.html"><div class="brand">Bot Core Latest (8.2.1)</div></a> + </div> + <div class="header-right"> + <div class="theme-toggle-container theme-toggle-header"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-header-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + </header> + <aside class="sidebar-drawer"> + <div class="sidebar-container"> + + <div class="sidebar-sticky"><a class="sidebar-brand centered" href="../index.html"> + + <div class="sidebar-logo-container"> + <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> + </div> + + <span class="sidebar-brand-text">Bot Core Latest (8.2.1)</span> + +</a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> + <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> + <input type="hidden" name="check_keywords" value="yes"> + <input type="hidden" name="area" value="default"> +</form> +<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> + <p class="caption" role="heading"><span class="caption-text">Modules:</span></p> +<ul class="current"> +<li class="toctree-l1 current has-children"><a class="reference internal" href="botcore.html">Botcore</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="botcore.exts.html">Exts</a></li> +<li class="toctree-l2 current has-children"><a class="reference internal" href="botcore.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">function</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> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="botcore.async_stats.html">async_stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html">site_api</a></li> +</ul> +</li> +</ul> +<p class="caption" role="heading"><span class="caption-text">Other:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Local Development & Testing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> +</ul> + + + + + <ul> + <li class="toctree-l1 has-children "> + + <a class="reference internal" href="../versions.html">Versions</a> + <input class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox"> + <label for="toctree-checkbox-versions"> + <div class="visually-hidden">Toggle child pages in navigation</div> + <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i> + </label> + + + <ul> + + <li class="toctree-l2 current-page"> + <a class="version_link reference internal" href="botcore.utils.function.html">main</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.2.1/index.html">v8.2.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.2.0/index.html">v8.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/index.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0-beta.3/index.html">v8.0.0-beta.3</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0-beta.2/index.html">v8.0.0-beta.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0-beta.1/index.html">v8.0.0-beta.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.0.0/index.html">v8.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.5.0/index.html">v7.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0-beta1/index.html">v7.4.0-beta1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/index.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.3.1/index.html">v7.3.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.3.0/index.html">v7.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.2.2/index.html">v7.2.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.2.1/index.html">v7.2.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.2.0/index.html">v7.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.1.3/index.html">v7.1.3</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.1.2/index.html">v7.1.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.1.1/index.html">v7.1.1</a> + </li> + + + <script> + // Make sure we keep any hyperlinked resources when switching version + function updateHash() { + for (let tag of document.getElementsByClassName("version_link")) { + // Extract the original URL + let destination = tag.getAttribute("href"); + if (destination.indexOf("#") !== -1) { + destination = destination.slice(0, destination.indexOf("#")); + } + + // Update the url with the current hash + tag.setAttribute("href", destination + document.location.hash); + } + } + + updateHash(); + addEventListener("hashchange", _ => { updateHash() }); + </script> + </ul> + </li> + </ul> + +</div> +</div> + + </div> + + </div> + </aside> + <div class="main"> + <div class="content"> + <div class="article-container"> + <a href="#" class="back-to-top muted-link"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> + <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> + </svg> + <span>Back to top</span> + </a> + <div class="content-icon-container"> + <div class="theme-toggle-container theme-toggle-content"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-content-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + <article role="main"> + <section id="module-botcore.utils.function"> +<span id="function"></span><h1>function<a class="headerlink" href="#module-botcore.utils.function" title="Permalink to this heading">#</a></h1> +<p>Utils for manipulating functions.</p> +<dl class="py exception"> +<dt class="sig sig-object py" id="botcore.utils.function.GlobalNameConflictError"> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GlobalNameConflictError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/function.py#L18-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.function.GlobalNameConflictError" title="Permalink to this definition">#</a></dt> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> +<p>Raised on a conflict between the globals used to resolve annotations of a wrapped function and its wrapper.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="botcore.utils.function.command_wraps"> +<span class="sig-name descname"><span class="pre">command_wraps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wrapped</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assigned</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('__module__',</span> <span class="pre">'__name__',</span> <span class="pre">'__qualname__',</span> <span class="pre">'__doc__',</span> <span class="pre">'__annotations__')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('__dict__',)</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">ignored_conflict_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">frozenset({})</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/function.py#L81-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.function.command_wraps" title="Permalink to this definition">#</a></dt> +<dd><p>Update the decorated function to look like <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>, and update globals for discord.py forwardref evaluation.</p> +<p>See <a class="reference internal" href="#botcore.utils.function.update_wrapper_globals" title="botcore.utils.function.update_wrapper_globals"><code class="xref py py-func docutils literal notranslate"><span class="pre">update_wrapper_globals()</span></code></a> for more details on how the globals are updated.</p> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>wrapped</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>), <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">_R</span></code>)]) – The function to wrap with.</p></li> +<li><p><strong>assigned</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.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/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – Sequence of attribute names that are directly assigned from <code class="docutils literal notranslate"><span class="pre">wrapped</span></code> to <code class="docutils literal notranslate"><span class="pre">wrapper</span></code>.</p></li> +<li><p><strong>updated</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.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/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – Sequence of attribute names that are <code class="docutils literal notranslate"><span class="pre">.update``d</span> <span class="pre">on</span> <span class="pre">``wrapper</span></code> from the attributes on <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>.</p></li> +<li><p><strong>ignored_conflict_names</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Set" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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>]) – A set of names to ignore if a conflict between them is found.</p></li> +</ul> +</dd> +<dt class="field-even">Return type</dt> +<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>), <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">_R</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>), <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">_R</span></code>)]]</p> +</dd> +<dt class="field-odd">Returns</dt> +<dd class="field-odd"><p>A decorator that behaves like <a class="reference external" href="https://docs.python.org/3/library/functools.html#functools.wraps" title="(in Python v3.10)"><code class="xref py py-func docutils literal notranslate"><span class="pre">functools.wraps()</span></code></a>, +with the wrapper replaced with the function <a class="reference internal" href="#botcore.utils.function.update_wrapper_globals" title="botcore.utils.function.update_wrapper_globals"><code class="xref py py-func docutils literal notranslate"><span class="pre">update_wrapper_globals()</span></code></a> returned.</p> +</dd> +</dl> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="botcore.utils.function.update_wrapper_globals"> +<span class="sig-name descname"><span class="pre">update_wrapper_globals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wrapper</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wrapped</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">ignored_conflict_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">frozenset({})</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/function.py#L22-L79"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.function.update_wrapper_globals" title="Permalink to this definition">#</a></dt> +<dd><p>Create a copy of <code class="docutils literal notranslate"><span class="pre">wrapper</span></code>, the copy’s globals are updated with <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>'s globals.</p> +<p>For forwardrefs in command annotations, discord.py uses the <code class="docutils literal notranslate"><span class="pre">__global__</span></code> attribute of the function +to resolve their values. This breaks for decorators that replace the function because they have +their own globals.</p> +<div class="admonition warning"> +<p class="admonition-title">Warning</p> +<p>This function captures the state of <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>'s module’s globals when it’s called; +changes won’t be reflected in the new function’s globals.</p> +</div> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>wrapper</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>), <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">_R</span></code>)]) – The function to wrap.</p></li> +<li><p><strong>wrapped</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>), <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">_R</span></code>)]) – The function to wrap with.</p></li> +<li><p><strong>ignored_conflict_names</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Set" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</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>]) – A set of names to ignore if a conflict between them is found.</p></li> +</ul> +</dd> +<dt class="field-even">Raises</dt> +<dd class="field-even"><p><a class="reference internal" href="#botcore.utils.function.GlobalNameConflictError" title="botcore.utils.function.GlobalNameConflictError"><strong>GlobalNameConflictError</strong></a> – If <code class="docutils literal notranslate"><span class="pre">wrapper</span></code> and <code class="docutils literal notranslate"><span class="pre">wrapped</span></code> share a global name that’s also used in <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>'s typehints, + and is not in <code class="docutils literal notranslate"><span class="pre">ignored_conflict_names</span></code>.</p> +</dd> +<dt class="field-odd">Return type</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>), <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">_R</span></code>)]</p> +</dd> +</dl> +</dd></dl> + +</section> + + </article> + </div> + <footer> + + <div class="related-pages"> + <a class="next-page" href="botcore.utils.interactions.html"> + <div class="page-info"> + <div class="context"> + <span>Next</span> + </div> + <div class="title">interactions</div> + </div> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + </a> + <a class="prev-page" href="botcore.utils.cooldown.html"> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + <div class="page-info"> + <div class="context"> + <span>Previous</span> + </div> + + <div class="title">cooldown</div> + + </div> + </a> + </div> + <div class="bottom-of-page"> + <div class="left-details"> + <div class="copyright"> + Copyright © 2021, Python Discord + </div> + Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s + + <a href="https://github.com/pradyunsg/furo">Furo</a> + + </div> + <div class="right-details"> + <div class="icons"> + + </div> + </div> + </div> + + </footer> + </div> + <aside class="toc-drawer"> + + + <div class="toc-sticky toc-scroll"> + <div class="toc-title-container"> + <span class="toc-title"> + On this page + </span> + </div> + <div class="toc-tree-container"> + <div class="toc-tree"> + <ul> +<li><a class="reference internal" href="#">function</a><ul> +<li><a class="reference internal" href="#botcore.utils.function.GlobalNameConflictError"><code class="docutils literal notranslate"><span class="pre">GlobalNameConflictError</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.function.command_wraps"><code class="docutils literal notranslate"><span class="pre">command_wraps()</span></code></a></li> +<li><a class="reference internal" href="#botcore.utils.function.update_wrapper_globals"><code class="docutils literal notranslate"><span class="pre">update_wrapper_globals()</span></code></a></li> +</ul> +</li> +</ul> + + </div> + </div> + </div> + + + </aside> + </div> +</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <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> +</html>
\ No newline at end of file diff --git a/main/output/botcore.utils.html b/main/output/botcore.utils.html index d8d5a03e..3c6afc2c 100644 --- a/main/output/botcore.utils.html +++ b/main/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 Latest (8.2.1)</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -338,7 +344,7 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.apply_monkey_patches"> -<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/__init__.py#L19-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> <dd><p>Applies all common monkey patches for our bots.</p> <dl> <dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.1.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.1.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names @@ -349,7 +355,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> @@ -357,16 +363,16 @@ that will act as top-level groups rather than being aliases of the command’s g <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.unqualify"> -<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -376,14 +382,88 @@ 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.commands.html">commands</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.commands.html">commands</a><ul> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.commands.html#botcore.utils.commands.clean_text_or_reply"><code class="docutils literal notranslate"><span class="pre">clean_text_or_reply()</span></code></a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a><ul> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.CommandOnCooldown"><code class="docutils literal notranslate"><span class="pre">CommandOnCooldown</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.CommandOnCooldown.__init__"><code class="docutils literal notranslate"><span class="pre">CommandOnCooldown.__init__()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.CommandOnCooldown.call_without_cooldown"><code class="docutils literal notranslate"><span class="pre">CommandOnCooldown.call_without_cooldown()</span></code></a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.P"><code class="docutils literal notranslate"><span class="pre">P</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.R"><code class="docutils literal notranslate"><span class="pre">R</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.block_duplicate_invocations"><code class="docutils literal notranslate"><span class="pre">block_duplicate_invocations()</span></code></a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="botcore.utils.function.html">function</a><ul> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.GlobalNameConflictError"><code class="docutils literal notranslate"><span class="pre">GlobalNameConflictError</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.command_wraps"><code class="docutils literal notranslate"><span class="pre">command_wraps()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.update_wrapper_globals"><code class="docutils literal notranslate"><span class="pre">update_wrapper_globals()</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> @@ -447,6 +527,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> @@ -464,6 +546,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/main/output/botcore.utils.interactions.html b/main/output/botcore.utils.interactions.html index f3b6848a..53c3c515 100644 --- a/main/output/botcore.utils.interactions.html +++ b/main/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/" /> -<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="commands" href="botcore.utils.commands.html" /> + <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="function" href="botcore.utils.function.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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">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> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -337,13 +343,13 @@ <span id="interactions"></span><h1>interactions<a class="headerlink" href="#module-botcore.utils.interactions" title="Permalink to this heading">#</a></h1> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.interactions.DeleteMessageButton"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DeleteMessageButton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><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/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/interactions.py#L73-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DeleteMessageButton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><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/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/interactions.py#L73-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.Button" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Button</span></code></a></p> <p>A button that can be added to a view to delete the message containing the view on click.</p> <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> @@ -352,15 +358,15 @@ </dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.DeleteMessageButton.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><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/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/interactions.py#L87-L95"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><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/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/interactions.py#L87-L95"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton.__init__" title="Permalink to this definition">#</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.DeleteMessageButton.callback"> -<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/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -370,11 +376,11 @@ <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.interactions.ViewWithUserAndRoleCheck"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ViewWithUserAndRoleCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/interactions.py#L11-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ViewWithUserAndRoleCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/interactions.py#L11-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck" title="Permalink to this definition">#</a></dt> <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> @@ -387,18 +393,18 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod </dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/interactions.py#L24-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/interactions.py#L24-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__" title="Permalink to this definition">#</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"> -<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/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -406,10 +412,10 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"> -<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/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -433,14 +439,14 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> - <a class="prev-page" href="botcore.utils.commands.html"> + <a class="prev-page" href="botcore.utils.function.html"> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> <div class="page-info"> <div class="context"> <span>Previous</span> </div> - <div class="title">commands</div> + <div class="title">function</div> </div> </a> @@ -464,9 +470,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> @@ -475,6 +510,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/main/output/botcore.utils.logging.html b/main/output/botcore.utils.logging.html index 6fa7bab9..60f27a06 100644 --- a/main/output/botcore.utils.logging.html +++ b/main/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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html">interactions</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">logging</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.members.html">members</a></li> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -338,26 +344,26 @@ <p>Common logging related functions.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logger</span></code></a></p> <p>Custom implementation of the <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Logger</span></code></a> class with an added <a class="reference internal" href="#botcore.utils.logging.CustomLogger.trace" title="botcore.utils.logging.CustomLogger.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a> method.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger.trace"> -<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> <dd><p>Log the given message with the severity <code class="docutils literal notranslate"><span class="pre">"TRACE"</span></code>.</p> <p>To pass exception information, use the keyword argument exc_info with a true value:</p> <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">"Houston, we have an </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"interesting problem"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> </pre></div> </div> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<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> @@ -367,16 +373,16 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.logging.get_logger"> -<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -429,8 +435,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> @@ -440,6 +469,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/main/output/botcore.utils.members.html b/main/output/botcore.utils.members.html index 654a03db..8dc49817 100644 --- a/main/output/botcore.utils.members.html +++ b/main/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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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 current current-page"><a class="current reference internal" href="#">members</a></li> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -338,13 +344,13 @@ <p>Useful helper functions for interactin with <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.1.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.members.get_or_fetch_member"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -352,19 +358,19 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.members.handle_role_change"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/members.py#L31-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/members.py#L31-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Permalink to this definition">#</a></dt> <dd><p>Await the given <code class="docutils literal notranslate"><span class="pre">coro</span></code> with <code class="docutils literal notranslate"><span class="pre">role</span></code> as the sole argument.</p> <p>Handle errors that we expect to be raised from <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.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> @@ -417,8 +423,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> @@ -428,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/main/output/botcore.utils.regex.html b/main/output/botcore.utils.regex.html index aeeec985..349b858d 100644 --- a/main/output/botcore.utils.regex.html +++ b/main/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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -338,7 +344,7 @@ <p>Common regular expressions.</p> <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.DISCORD_INVITE"> -<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/regex.py#L5-L17"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/regex.py#L5-L17"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt> <dd><p>Regex for Discord server invites.</p> <div class="admonition warning"> <p class="admonition-title">Warning</p> @@ -352,7 +358,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.FORMATTED_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/regex.py#L29-L37"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/regex.py#L29-L37"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt> <dd><p>Regex for formatted code, using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -360,7 +366,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.RAW_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/regex.py#L44-L49"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/regex.py#L44-L49"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt> <dd><p>Regex for raw code, <em>not</em> using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -413,8 +419,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> @@ -424,6 +451,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/main/output/botcore.utils.scheduling.html b/main/output/botcore.utils.scheduling.html index bed3f40b..898c8a33 100644 --- a/main/output/botcore.utils.scheduling.html +++ b/main/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 Latest (8.2.1)</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> @@ -169,6 +169,8 @@ <li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</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> @@ -208,6 +210,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> @@ -327,7 +333,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> @@ -338,7 +344,7 @@ <p>Generic python scheduler.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/scheduling.py#L14-L210"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/scheduling.py#L14-L210"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>Schedule the execution of coroutines and keep track of them.</p> <p>When instantiating a <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>, a name must be provided. This name is used to distinguish the @@ -352,16 +358,16 @@ the same ID used to schedule it.</p> <p>Any exception raised in a scheduled task is logged when the task is done.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__contains__"> -<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -369,10 +375,10 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -380,13 +386,13 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel"> -<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -394,10 +400,10 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel_all"> -<span class="sig-name descname"><span class="pre">cancel_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/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> +<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/c7a6ddd00eb371759d837aa75fa397c6d5771401/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> @@ -405,18 +411,18 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule"> -<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/scheduling.py#L56-L82"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/scheduling.py#L56-L82"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Permalink to this definition">#</a></dt> <dd><p>Schedule the execution of a <code class="docutils literal notranslate"><span class="pre">coroutine</span></code>.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<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> @@ -424,7 +430,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_at"> -<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/scheduling.py#L83-L106"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/scheduling.py#L83-L106"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Permalink to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed at the given <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p> <p>If <code class="docutils literal notranslate"><span class="pre">time</span></code> is timezone aware, then use that timezone to calculate now() when subtracting. If <code class="docutils literal notranslate"><span class="pre">time</span></code> is naïve, then use UTC.</p> @@ -432,14 +438,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> @@ -447,19 +453,19 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_later"> -<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/scheduling.py#L107-L125"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/scheduling.py#L107-L125"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Permalink to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed after <code class="docutils literal notranslate"><span class="pre">delay</span></code> seconds.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<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> @@ -469,12 +475,12 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.scheduling.create_task"> -<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/ac156ecc63e0cd0ea54d58020efe8df3c6e39c86/botcore/utils/scheduling.py#L215-L243"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c7a6ddd00eb371759d837aa75fa397c6d5771401/botcore/utils/scheduling.py#L215-L243"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> <dd><p>Wrapper for creating an <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.Task</span></code></a> which logs exceptions raised in the task.</p> <p>If the <code class="docutils literal notranslate"><span class="pre">event_loop</span></code> kwarg is provided, the task is created from that event loop, otherwise the running loop is used.</p> <dl class="field-list simple"> -<dt class="field-odd">Parameters<span class="colon">:</span></dt> +<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>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#Ellipsis" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code></a>]) – Exceptions to be handled by the task.</p></li> @@ -482,10 +488,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> @@ -538,8 +544,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> @@ -549,6 +584,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/main/py-modindex.html b/main/py-modindex.html index 0162944b..0064cac7 100644 --- a/main/py-modindex.html +++ b/main/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 Latest (8.2.1)</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 Latest (8.2.1)</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" /> @@ -167,6 +167,8 @@ <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> @@ -206,6 +208,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> @@ -395,6 +401,18 @@ <tr class="cg-1"> <td></td> <td>    + <a href="output/botcore.utils.cooldown.html#module-botcore.utils.cooldown"><code class="xref">botcore.utils.cooldown</code></a></td><td> + <em></em></td> + </tr> + <tr class="cg-1"> + <td></td> + <td>    + <a href="output/botcore.utils.function.html#module-botcore.utils.function"><code class="xref">botcore.utils.function</code></a></td><td> + <em></em></td> + </tr> + <tr class="cg-1"> + <td></td> + <td>    <a href="output/botcore.utils.interactions.html#module-botcore.utils.interactions"><code class="xref">botcore.utils.interactions</code></a></td><td> <em></em></td> </tr> @@ -462,6 +480,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/main/search.html b/main/search.html index 3dd4dfed..2576009b 100644 --- a/main/search.html +++ b/main/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 Latest (8.2.1)</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 Latest (8.2.1)</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" /> @@ -166,6 +166,8 @@ <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> @@ -205,6 +207,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> @@ -380,6 +386,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/main/searchindex.js b/main/searchindex.js index 39a1d897..f568ca85 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "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.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.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.commands.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", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "2": [0, 3, 11], "1": [0, 12], "18th": 0, "septemb": 0, "2022": 0, "bug": 0, "138": 0, "bump": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0": [0, 8, 11, 12], "august": 0, "support": [0, 4, 7, 15], "125": 0, "stabl": 0, "releas": 0, "16th": 0, "124": 0, "updat": 0, "botcor": [0, 1, 2, 11], "util": [0, 1, 2, 3, 8, 11, 12], "regex": [0, 3, 7], "discord_invit": [0, 14], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "match": [0, 3], "lead": 0, "http": [0, 6, 14], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "www": 0, "27th": 0, "juli": 0, "break": 0, "110": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "104": 0, "fix": 0, "deletemessagebutton": [0, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "9th": 0, "98": 0, "close": [0, 3, 6, 15], "botbas": [0, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "63": 0, "api_cli": [0, 3], "__init__": [0, 3, 4, 6, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "bot_token": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "wait_until_guild_avail": 3, "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "add_cog": 3, "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "add_command": 3, "normal": 3, "alias": [3, 7], "clear": [3, 8], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "load_extens": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "log_to_dev_log": 3, "on_guild_avail": 3, "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "on_guild_unavail": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "remove_command": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "setup_hook": 3, "startup": 3, "asyncstatscli": [3, 4], "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "startuperror": 3, "error": [3, 6, 7, 13], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "request": [6, 14], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "maybe_raise_for_statu": 6, "should_rais": 6, "responsecodeerror": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "post": 6, "put": 6, "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "__str__": 6, "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "relat": [8, 12], "asynccach": 8, "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "__call__": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "get_or_fetch_channel": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "is_in_categori": 9, "category_id": 9, "categori": 9, "textchannel": 9, "clean_text_or_repli": 10, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "callback": 11, "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "interaction_check": 11, "occur": 11, "on_timeout": 11, "customlogg": 12, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "get_logg": 12, "mypi": 12, "recognis": 12, "interactin": 13, "get_or_fetch_memb": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "formatted_code_regex": 14, "format": 14, "raw_code_regex": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "schedule_at": 15, "schedule_lat": 15, "uniqu": 15, "cancel": 15, "prematur": 15, "same": 15, "current": 15, "__contains__": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "cancel_al": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "create_task": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [3, 2, 1, "", "load_extensions"], [3, 2, 1, "", "log_to_dev_log"], [3, 2, 1, "", "on_guild_available"], [3, 2, 1, "", "on_guild_unavailable"], [3, 2, 1, "", "ping_services"], [3, 2, 1, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "close"], [6, 2, 1, "", "delete"], [6, 2, 1, "", "get"], [6, 2, 1, "", "maybe_raise_for_status"], [6, 2, 1, "", "patch"], [6, 2, 1, "", "post"], [6, 2, 1, "", "put"], [6, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 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, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "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", "development", "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.commands", "output/botcore.utils.cooldown", "output/botcore.utils.function", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.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.commands.rst", "output/botcore.utils.cooldown.rst", "output/botcore.utils.function.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", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "cooldown", "function", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "2": [0, 3, 13], "1": [0, 14], "18th": 0, "septemb": 0, "2022": 0, "bug": 0, "138": 0, "bump": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 12, 15, 16], "py": [0, 12], "0": [0, 8, 13, 14], "august": 0, "support": [0, 4, 7, 17], "125": 0, "stabl": 0, "releas": 0, "16th": 0, "124": 0, "updat": [0, 12], "botcor": [0, 1, 2, 13], "util": [0, 1, 2, 3, 8, 12, 13, 14], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 16], "option": [0, 3, 4, 6, 8, 10, 11, 13, 14, 15], "match": [0, 3], "lead": 0, "http": [0, 6, 16], "": [0, 1, 7, 8, 10, 11, 12, 13, 14, 16, 17], "www": 0, "27th": 0, "juli": 0, "break": [0, 12], "110": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15], "rediscach": 0, "v1": 0, "rc2": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "add": [0, 3, 11], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 12, 17], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 17], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": [0, 11], "23rd": 0, "featur": [0, 1, 3], "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 13, 14, 17], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 14, 17], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 13], "On": 0, "view": [0, 13], "timeout": [0, 13], "thi": [0, 1, 3, 7, 9, 11, 12, 13, 15, 16, 17], "ha": [0, 7], "its": [0, 3, 11, 12], "remov": [0, 3, 13], "set": [0, 1, 3, 11, 12, 13], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 13], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 11, 12, 14, 15, 16, 17], "wrong": 0, "delet": [0, 3, 6, 8, 13], "method": [0, 4, 6, 7, 14], "103": 0, "button": [0, 13], "attach": 0, "parent": [0, 13], "gener": [0, 3, 11, 17], "onli": [0, 3], "allow": [0, 1, 3, 13], "specifi": [0, 11, 13], "user": [0, 11, 13], "role": [0, 1, 3, 13, 15], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 17], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 17], "creat": [0, 3, 4, 8, 11, 12, 17], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13, 15], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 14, 15, 17], "self": [0, 3, 13], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 15], "96": 0, "attempt": [0, 3, 9, 15], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 11, 12, 17], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 14, 15, 17], "none": [0, 3, 4, 6, 7, 8, 10, 11, 13, 14, 15, 17], "28th": 0, "93": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 11, 17], "new": [0, 1, 4, 6, 8, 12, 17], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 14], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 17], "out": [0, 1, 13], "10th": 0, "75": 0, "invit": [0, 16], "longer": [0, 13], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "url": [0, 3, 6], "safe": 0, "result": [0, 17], "refer": 0, "handl": [0, 15, 17], "captur": [0, 12, 16], "all": [0, 1, 3, 4, 7, 17], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 16], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 15], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 13, 14, 17], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 13], "actual": 0, "now": [0, 1, 17], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 15], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": [0, 12], "main": 0, "don": [0, 17], "t": [0, 10, 12, 17], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 12, 17], "start": [0, 3, 17], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": [0, 12], "task": [0, 3, 17], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 17], "manipul": [0, 12], "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1, 12], "help": [0, 1], "command": [0, 1, 3, 7, 9, 11, 12], "behaviour": 0, "broke": 0, "custom": [0, 8, 14], "pagin": 0, "also": [0, 7, 12, 13], "basic": [0, 13], "forum": 0, "channel": [0, 3, 7, 11], "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 13, 17], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 14, 17], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 17], "event": [0, 3, 4, 17], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 13, 17], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 13, 14, 17], "abstract": 0, "lot": 0, "logic": 0, "share": [0, 12], "between": [0, 1, 12], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 15, 17], "trace": [0, 7, 14], "import": 0, "can": [0, 1, 13, 17], "function": [0, 3, 7, 8, 9, 11, 14, 15, 17], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 15], "wrapper": [0, 6, 11, 12, 17], "from": [0, 1, 3, 4, 6, 7, 9, 12, 13, 15, 17], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 14, 16], "cach": [0, 3, 7, 9, 15], "logger": [0, 14], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 13, 14], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 16], "block": [0, 11, 16], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 14], "your": 1, "ar": [1, 3, 8, 12, 13, 16], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": [1, 12], "pre": 1, "exist": [1, 17], "provid": [1, 8, 10, 17], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 12, 13], "below": 1, "more": [1, 12], "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 12, 17], "you": [1, 9, 16], "ll": [1, 17], "write": 1, "might": 1, "mean": 1, "modifi": [1, 15], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 17], "vari": 1, "re": [1, 3, 17], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 11, 17], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 13, 17], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7, 12], "free": 1, "howev": 1, "like": [1, 12], "m": 1, "docker": 1, "compos": 1, "d": [1, 12], "configur": 1, "variabl": 1, "program": 1, "env": 1, "bot_token": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11, 13], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 13], "A": [1, 3, 6, 7, 8, 9, 11, 12, 13, 17], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 13, 17], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 17], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 14], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 11, 14], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 13, 14, 17], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "implement": [3, 4, 8, 13, 14], "initialis": [3, 8], "int": [3, 4, 8, 9, 13, 17], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 12, 13, 14, 17], "server": [3, 16], "If": [3, 6, 11, 12, 13, 17], "given": [3, 4, 7, 9, 10, 14, 15, 17], "oper": [3, 17], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 13, 17], "instead": [3, 11, 17], "connector": 3, "resolv": [3, 12], "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 17], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 11, 12, 17], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 13, 16], "thei": [3, 12], "name": [3, 7, 12, 14, 17], "alia": [3, 7, 11], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 17], "until": [3, 16], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": [3, 12], "second": [3, 11, 13, 17], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 11, 12, 14, 17], "error": [3, 6, 7, 15], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "cooldown": [3, 7], "commandoncooldown": [3, 7, 11], "p": [3, 7, 11], "r": [3, 7, 11], "block_duplicate_invoc": [3, 7, 11], "globalnameconflicterror": [3, 7, 12], "command_wrap": [3, 7, 12], "update_wrapper_glob": [3, 7, 12], "customlogg": [3, 7, 14], "get_logg": [3, 7, 14], "get_or_fetch_memb": [3, 7, 15], "formatted_code_regex": [3, 7, 16], "raw_code_regex": [3, 7, 16], "create_task": [3, 7, 17], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 16], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 17], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 11, 15, 17], "django": 6, "initi": [6, 17], "authent": 6, "keyword": [6, 7, 14], "argument": [6, 7, 8, 10, 11, 14, 15], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 11, 14, 17], "send": [6, 13], "json": 6, "respons": 6, "bool": [6, 9, 11, 13, 17], "whether": [6, 9], "rais": [6, 9, 10, 11, 12, 15, 17], "ok": 6, "ani": [6, 16, 17], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 13, 17], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8, 11], "group": [7, 16], "root_alias": 7, "two": 7, "sequenc": [7, 12, 13], "act": 7, "top": 7, "level": [7, 14], "rather": 7, "than": 7, "being": [7, 15], "It": 7, "store": [7, 8], "attribut": [7, 12], "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "call_without_cooldown": [7, 11], "callback": [7, 13], "interaction_check": [7, 13], "on_timeout": [7, 13], "__contains__": [7, 17], "cancel": [7, 17], "cancel_al": [7, 17], "schedule_at": [7, 17], "schedule_lat": [7, 17], "relat": [8, 14], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 15, 17], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 17], "offset": 8, "arg_offset": 8, "decor": [8, 11, 12], "posit": 8, "callabl": [8, 11, 12, 15], "wrap": [8, 12, 17], "target": 8, "item": 8, "helper": [9, 11, 15], "variou": 9, "channel_id": 9, "fetch": [9, 15], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12, 14], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 13], "repli": [10, 11], "context": 10, "badargu": 10, "wasn": 10, "els": 10, "commanderror": 11, "while": 11, "typevar": [11, 12, 17], "valu": [11, 12, 14], "signatur": 11, "cooldown_dur": 11, "send_notic": 11, "fals": 11, "args_preprocessor": 11, "prevent": [11, 17], "duplic": 11, "invoc": 11, "same": [11, 17], "float": [11, 13, 17], "length": 11, "notifi": 11, "about": 11, "paramspec": [11, 12], "iter": 11, "raw": [11, 16], "conflict": 12, "global": 12, "annot": 12, "assign": 12, "__module__": 12, "__name__": 12, "__qualname__": 12, "__doc__": 12, "__annotations__": 12, "__dict__": 12, "ignored_conflict_nam": 12, "frozenset": 12, "look": [12, 17], "forwardref": 12, "evalu": 12, "detail": 12, "_p": 12, "_r": 12, "found": [12, 15, 17], "behav": 12, "functool": 12, "replac": 12, "For": 12, "__global__": 12, "state": 12, "won": 12, "reflect": 12, "typehint": 12, "style": 13, "buttonstyl": 13, "secondari": 13, "label": 13, "click": 13, "itself": 13, "carri": 13, "done": [13, 17], "origin": 13, "allowed_us": 13, "180": 13, "moder": 13, "who": 13, "last": 13, "ui": 13, "accept": 13, "input": 13, "similar": [13, 16], "after": [13, 17], "occur": 13, "msg": 14, "sever": 14, "exc_info": 14, "houston": 14, "we": [14, 15], "interest": 14, "problem": 14, "mypi": 14, "recognis": 14, "interactin": 15, "member_id": 15, "failur": 15, "indic": 15, "could": 15, "coro": [15, 17], "sole": 15, "expect": 15, "add_rol": 15, "remove_rol": 15, "purpos": 15, "intend": 15, "regular": 16, "express": 16, "pattern": 16, "pleas": 16, "sanitis": 16, "output": 16, "someth": 16, "urllib": 16, "pars": 16, "quot": 16, "format": 16, "execut": 17, "keep": 17, "track": 17, "must": 17, "distinguish": 17, "suggest": 17, "immedi": 17, "futur": 17, "uniqu": 17, "prematur": 17, "current": 17, "task_id": 17, "hashabl": 17, "unschedul": 17, "identifi": 17, "warn": 17, "doesn": 17, "known": 17, "alreadi": 17, "unawait": 17, "elsewher": 17, "timezon": 17, "awar": 17, "calcul": 17, "subtract": 17, "na\u00efv": 17, "utc": 17, "past": 17, "datetim": 17, "delai": 17, "union": 17, "long": 17, "suppressed_except": 17, "event_loop": 17, "otherwis": 17, "task_return": 17, "tupl": 17}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [3, 2, 1, "", "load_extensions"], [3, 2, 1, "", "log_to_dev_log"], [3, 2, 1, "", "on_guild_available"], [3, 2, 1, "", "on_guild_unavailable"], [3, 2, 1, "", "ping_services"], [3, 2, 1, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "close"], [6, 2, 1, "", "delete"], [6, 2, 1, "", "get"], [6, 2, 1, "", "maybe_raise_for_status"], [6, 2, 1, "", "patch"], [6, 2, 1, "", "post"], [6, 2, 1, "", "put"], [6, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "cooldown"], [12, 0, 0, "-", "function"], [13, 0, 0, "-", "interactions"], [14, 0, 0, "-", "logging"], [15, 0, 0, "-", "members"], [16, 0, 0, "-", "regex"], [17, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.cooldown": [[11, 3, 1, "", "CommandOnCooldown"], [11, 5, 1, "", "P"], [11, 5, 1, "", "R"], [11, 4, 1, "", "block_duplicate_invocations"]], "botcore.utils.cooldown.CommandOnCooldown": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "call_without_cooldown"]], "botcore.utils.function": [[12, 3, 1, "", "GlobalNameConflictError"], [12, 4, 1, "", "command_wraps"], [12, 4, 1, "", "update_wrapper_globals"]], "botcore.utils.interactions": [[13, 1, 1, "", "DeleteMessageButton"], [13, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[13, 2, 1, "", "__init__"], [13, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[13, 2, 1, "", "__init__"], [13, 2, 1, "", "interaction_check"], [13, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[14, 1, 1, "", "CustomLogger"], [14, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[14, 2, 1, "", "trace"]], "botcore.utils.members": [[15, 4, 1, "", "get_or_fetch_member"], [15, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[16, 5, 1, "", "DISCORD_INVITE"], [16, 5, 1, "", "FORMATTED_CODE_REGEX"], [16, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[17, 1, 1, "", "Scheduler"], [17, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[17, 2, 1, "", "__contains__"], [17, 2, 1, "", "__init__"], [17, 2, 1, "", "cancel"], [17, 2, 1, "", "cancel_all"], [17, 2, 1, "", "schedule"], [17, 2, 1, "", "schedule_at"], [17, 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, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "cooldown": 11, "function": 12, "interact": 13, "log": 14, "member": 15, "regex": 16, "schedul": 17}, "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": {"Changelog": [[0, "changelog"]], "caching": [[8, "module-botcore.utils.caching"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "site_api": [[6, "module-botcore.site_api"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Exts": [[5, "module-botcore.exts"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "async_stats": [[4, "module-botcore.async_stats"]], "function": [[12, "module-botcore.utils.function"]], "logging": [[14, "module-botcore.utils.logging"]], "commands": [[10, "module-botcore.utils.commands"]], "channel": [[9, "module-botcore.utils.channel"]], "members": [[15, "module-botcore.utils.members"]], "scheduling": [[17, "module-botcore.utils.scheduling"]], "regex": [[16, "module-botcore.utils.regex"]], "cooldown": [[11, "module-botcore.utils.cooldown"]], "interactions": [[13, "module-botcore.utils.interactions"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.cooldown"], [12, "module-botcore.utils.function"], [13, "module-botcore.utils.interactions"], [14, "module-botcore.utils.logging"], [15, "module-botcore.utils.members"], [16, "module-botcore.utils.regex"], [17, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "commandoncooldown": [[11, "botcore.utils.cooldown.CommandOnCooldown"]], "p (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.P"]], "r (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.R"]], "__init__() (commandoncooldown method)": [[11, "botcore.utils.cooldown.CommandOnCooldown.__init__"]], "block_duplicate_invocations() (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.block_duplicate_invocations"]], "botcore.utils.cooldown": [[11, "module-botcore.utils.cooldown"]], "call_without_cooldown() (commandoncooldown method)": [[11, "botcore.utils.cooldown.CommandOnCooldown.call_without_cooldown"]], "globalnameconflicterror": [[12, "botcore.utils.function.GlobalNameConflictError"]], "botcore.utils.function": [[12, "module-botcore.utils.function"]], "command_wraps() (in module botcore.utils.function)": [[12, "botcore.utils.function.command_wraps"]], "update_wrapper_globals() (in module botcore.utils.function)": [[12, "botcore.utils.function.update_wrapper_globals"]], "deletemessagebutton (class in botcore.utils.interactions)": [[13, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[13, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[13, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[13, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[14, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[14, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[14, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[14, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[15, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[15, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[15, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[16, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[16, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[16, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[16, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[17, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[17, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[17, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule_later"]]}})
\ No newline at end of file diff --git a/main/versions.html b/main/versions.html index 962dbf5f..686faad2 100644 --- a/main/versions.html +++ b/main/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 Latest (8.2.1)</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> @@ -168,6 +168,8 @@ <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.logging.html">logging</a></li> <li class="toctree-l3"><a class="reference internal" href="output/botcore.utils.members.html">members</a></li> @@ -207,6 +209,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> @@ -346,6 +352,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> @@ -494,6 +506,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> |