diff options
author | 2025-02-18 19:41:52 +0000 | |
---|---|---|
committer | 2025-02-18 19:41:52 +0000 | |
commit | bea01f55a87a9f5c523ed9419419187a70798cf4 (patch) | |
tree | e8ce134198672dd0a22c3a07b6b2216919b7d0fd /main | |
parent | Deploying to docs from @ python-discord/bot-core@cbe2bae7bd4826c804fd690cc695... (diff) |
Deploying to docs from @ python-discord/bot-core@16835478af6b842d776d634e53aab8ee31bd350c 🚀
Diffstat (limited to 'main')
37 files changed, 661 insertions, 656 deletions
diff --git a/main/.buildinfo b/main/.buildinfo index 5e04e5c9..bf6e5351 100644 --- a/main/.buildinfo +++ b/main/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done. -config: fc55262172b08281c602f7b4e71fbca1 +config: 29ba1a8a2c14a75e423c9b496728969c tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js index 7a765326..ee0355cb 100644 --- a/main/_static/documentation_options.js +++ b/main/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '11.5.1', + VERSION: '11.6.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/main/_static/pygments.css b/main/_static/pygments.css index 02b4b128..f71bfbfc 100644 --- a/main/_static/pygments.css +++ b/main/_static/pygments.css @@ -5,83 +5,83 @@ .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } .highlight .hll { background-color: #ffffcc } .highlight { background: #f8f8f8; } -.highlight .c { color: #8f5902; font-style: italic } /* Comment */ -.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ -.highlight .g { color: #000000 } /* Generic */ -.highlight .k { color: #204a87; font-weight: bold } /* Keyword */ -.highlight .l { color: #000000 } /* Literal */ -.highlight .n { color: #000000 } /* Name */ -.highlight .o { color: #ce5c00; font-weight: bold } /* Operator */ -.highlight .x { color: #000000 } /* Other */ -.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ -.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */ -.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #a40000 } /* Generic.Deleted */ -.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ -.highlight .ges { color: #000000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .c { color: #8F5902; font-style: italic } /* Comment */ +.highlight .err { color: #A40000; border: 1px solid #EF2929 } /* Error */ +.highlight .g { color: #000 } /* Generic */ +.highlight .k { color: #204A87; font-weight: bold } /* Keyword */ +.highlight .l { color: #000 } /* Literal */ +.highlight .n { color: #000 } /* Name */ +.highlight .o { color: #CE5C00; font-weight: bold } /* Operator */ +.highlight .x { color: #000 } /* Other */ +.highlight .p { color: #000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8F5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8F5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8F5902; font-style: italic } /* Comment.Preproc */ +.highlight .cpf { color: #8F5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8F5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8F5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A40000 } /* Generic.Deleted */ +.highlight .ge { color: #000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #EF2929 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #000000; font-style: italic } /* Generic.Output */ -.highlight .gp { color: #8f5902 } /* Generic.Prompt */ -.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .go { color: #000; font-style: italic } /* Generic.Output */ +.highlight .gp { color: #8F5902 } /* Generic.Prompt */ +.highlight .gs { color: #000; font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ -.highlight .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */ -.highlight .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #204a87; font-weight: bold } /* Keyword.Type */ -.highlight .ld { color: #000000 } /* Literal.Date */ -.highlight .m { color: #0000cf; font-weight: bold } /* Literal.Number */ -.highlight .s { color: #4e9a06 } /* Literal.String */ -.highlight .na { color: #c4a000 } /* Name.Attribute */ -.highlight .nb { color: #204a87 } /* Name.Builtin */ -.highlight .nc { color: #000000 } /* Name.Class */ -.highlight .no { color: #000000 } /* Name.Constant */ -.highlight .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */ -.highlight .ni { color: #ce5c00 } /* Name.Entity */ -.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #000000 } /* Name.Function */ -.highlight .nl { color: #f57900 } /* Name.Label */ -.highlight .nn { color: #000000 } /* Name.Namespace */ -.highlight .nx { color: #000000 } /* Name.Other */ -.highlight .py { color: #000000 } /* Name.Property */ -.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #000000 } /* Name.Variable */ -.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ -.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ -.highlight .w { color: #f8f8f8 } /* Text.Whitespace */ -.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ -.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ -.highlight .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */ -.highlight .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */ -.highlight .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */ -.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ -.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ -.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ -.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ -.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ -.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ -.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ -.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ -.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ -.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ -.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ -.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ -.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #000000 } /* Name.Function.Magic */ -.highlight .vc { color: #000000 } /* Name.Variable.Class */ -.highlight .vg { color: #000000 } /* Name.Variable.Global */ -.highlight .vi { color: #000000 } /* Name.Variable.Instance */ -.highlight .vm { color: #000000 } /* Name.Variable.Magic */ -.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */ +.highlight .gt { color: #A40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #204A87; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #204A87; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #204A87; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #204A87; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #204A87; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #204A87; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000 } /* Literal.Date */ +.highlight .m { color: #0000CF; font-weight: bold } /* Literal.Number */ +.highlight .s { color: #4E9A06 } /* Literal.String */ +.highlight .na { color: #C4A000 } /* Name.Attribute */ +.highlight .nb { color: #204A87 } /* Name.Builtin */ +.highlight .nc { color: #000 } /* Name.Class */ +.highlight .no { color: #000 } /* Name.Constant */ +.highlight .nd { color: #5C35CC; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #CE5C00 } /* Name.Entity */ +.highlight .ne { color: #C00; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000 } /* Name.Function */ +.highlight .nl { color: #F57900 } /* Name.Label */ +.highlight .nn { color: #000 } /* Name.Namespace */ +.highlight .nx { color: #000 } /* Name.Other */ +.highlight .py { color: #000 } /* Name.Property */ +.highlight .nt { color: #204A87; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000 } /* Name.Variable */ +.highlight .ow { color: #204A87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #F8F8F8 } /* Text.Whitespace */ +.highlight .mb { color: #0000CF; font-weight: bold } /* Literal.Number.Bin */ +.highlight .mf { color: #0000CF; font-weight: bold } /* Literal.Number.Float */ +.highlight .mh { color: #0000CF; font-weight: bold } /* Literal.Number.Hex */ +.highlight .mi { color: #0000CF; font-weight: bold } /* Literal.Number.Integer */ +.highlight .mo { color: #0000CF; font-weight: bold } /* Literal.Number.Oct */ +.highlight .sa { color: #4E9A06 } /* Literal.String.Affix */ +.highlight .sb { color: #4E9A06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4E9A06 } /* Literal.String.Char */ +.highlight .dl { color: #4E9A06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8F5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4E9A06 } /* Literal.String.Double */ +.highlight .se { color: #4E9A06 } /* Literal.String.Escape */ +.highlight .sh { color: #4E9A06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4E9A06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4E9A06 } /* Literal.String.Other */ +.highlight .sr { color: #4E9A06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4E9A06 } /* Literal.String.Single */ +.highlight .ss { color: #4E9A06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465A4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000 } /* Name.Function.Magic */ +.highlight .vc { color: #000 } /* Name.Variable.Class */ +.highlight .vg { color: #000 } /* Name.Variable.Global */ +.highlight .vi { color: #000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000 } /* Name.Variable.Magic */ +.highlight .il { color: #0000CF; font-weight: bold } /* Literal.Number.Integer.Long */ @media not print { body[data-theme="dark"] .highlight pre { line-height: 125%; } body[data-theme="dark"] .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } @@ -89,85 +89,85 @@ body[data-theme="dark"] .highlight span.linenos { color: #aaaaaa; background-col body[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } body[data-theme="dark"] .highlight .hll { background-color: #404040 } -body[data-theme="dark"] .highlight { background: #202020; color: #d0d0d0 } -body[data-theme="dark"] .highlight .c { color: #ababab; font-style: italic } /* Comment */ -body[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -body[data-theme="dark"] .highlight .esc { color: #d0d0d0 } /* Escape */ -body[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */ -body[data-theme="dark"] .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ -body[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */ -body[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */ -body[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */ -body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */ -body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */ -body[data-theme="dark"] .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ -body[data-theme="dark"] .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ -body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ -body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ -body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ -body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ -body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ -body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ +body[data-theme="dark"] .highlight { background: #202020; color: #D0D0D0 } +body[data-theme="dark"] .highlight .c { color: #ABABAB; font-style: italic } /* Comment */ +body[data-theme="dark"] .highlight .err { color: #A61717; background-color: #E3D2D2 } /* Error */ +body[data-theme="dark"] .highlight .esc { color: #D0D0D0 } /* Escape */ +body[data-theme="dark"] .highlight .g { color: #D0D0D0 } /* Generic */ +body[data-theme="dark"] .highlight .k { color: #6EBF26; font-weight: bold } /* Keyword */ +body[data-theme="dark"] .highlight .l { color: #D0D0D0 } /* Literal */ +body[data-theme="dark"] .highlight .n { color: #D0D0D0 } /* Name */ +body[data-theme="dark"] .highlight .o { color: #D0D0D0 } /* Operator */ +body[data-theme="dark"] .highlight .x { color: #D0D0D0 } /* Other */ +body[data-theme="dark"] .highlight .p { color: #D0D0D0 } /* Punctuation */ +body[data-theme="dark"] .highlight .ch { color: #ABABAB; font-style: italic } /* Comment.Hashbang */ +body[data-theme="dark"] .highlight .cm { color: #ABABAB; font-style: italic } /* Comment.Multiline */ +body[data-theme="dark"] .highlight .cp { color: #FF3A3A; font-weight: bold } /* Comment.Preproc */ +body[data-theme="dark"] .highlight .cpf { color: #ABABAB; font-style: italic } /* Comment.PreprocFile */ +body[data-theme="dark"] .highlight .c1 { color: #ABABAB; font-style: italic } /* Comment.Single */ +body[data-theme="dark"] .highlight .cs { color: #E50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ +body[data-theme="dark"] .highlight .gd { color: #FF3A3A } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .ge { color: #D0D0D0; font-style: italic } /* Generic.Emph */ +body[data-theme="dark"] .highlight .ges { color: #D0D0D0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +body[data-theme="dark"] .highlight .gr { color: #FF3A3A } /* Generic.Error */ +body[data-theme="dark"] .highlight .gh { color: #FFF; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ -body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ -body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ -body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ -body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ -body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ -body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ -body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ -body[data-theme="dark"] .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ -body[data-theme="dark"] .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ -body[data-theme="dark"] .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ -body[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */ -body[data-theme="dark"] .highlight .m { color: #51b2fd } /* Literal.Number */ -body[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */ -body[data-theme="dark"] .highlight .na { color: #bbbbbb } /* Name.Attribute */ -body[data-theme="dark"] .highlight .nb { color: #2fbccd } /* Name.Builtin */ -body[data-theme="dark"] .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ -body[data-theme="dark"] .highlight .no { color: #40ffff } /* Name.Constant */ -body[data-theme="dark"] .highlight .nd { color: #ffa500 } /* Name.Decorator */ -body[data-theme="dark"] .highlight .ni { color: #d0d0d0 } /* Name.Entity */ -body[data-theme="dark"] .highlight .ne { color: #bbbbbb } /* Name.Exception */ -body[data-theme="dark"] .highlight .nf { color: #71adff } /* Name.Function */ -body[data-theme="dark"] .highlight .nl { color: #d0d0d0 } /* Name.Label */ -body[data-theme="dark"] .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ -body[data-theme="dark"] .highlight .nx { color: #d0d0d0 } /* Name.Other */ -body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ -body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ -body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ -body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ -body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ -body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ -body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ -body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ -body[data-theme="dark"] .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ -body[data-theme="dark"] .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ -body[data-theme="dark"] .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ -body[data-theme="dark"] .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ -body[data-theme="dark"] .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ -body[data-theme="dark"] .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ -body[data-theme="dark"] .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ -body[data-theme="dark"] .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ -body[data-theme="dark"] .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ -body[data-theme="dark"] .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ -body[data-theme="dark"] .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ -body[data-theme="dark"] .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ -body[data-theme="dark"] .highlight .sx { color: #ffa500 } /* Literal.String.Other */ -body[data-theme="dark"] .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ -body[data-theme="dark"] .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ -body[data-theme="dark"] .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ -body[data-theme="dark"] .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ -body[data-theme="dark"] .highlight .fm { color: #71adff } /* Name.Function.Magic */ -body[data-theme="dark"] .highlight .vc { color: #40ffff } /* Name.Variable.Class */ -body[data-theme="dark"] .highlight .vg { color: #40ffff } /* Name.Variable.Global */ -body[data-theme="dark"] .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ -body[data-theme="dark"] .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ -body[data-theme="dark"] .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ +body[data-theme="dark"] .highlight .go { color: #CCC } /* Generic.Output */ +body[data-theme="dark"] .highlight .gp { color: #AAA } /* Generic.Prompt */ +body[data-theme="dark"] .highlight .gs { color: #D0D0D0; font-weight: bold } /* Generic.Strong */ +body[data-theme="dark"] .highlight .gu { color: #FFF; text-decoration: underline } /* Generic.Subheading */ +body[data-theme="dark"] .highlight .gt { color: #FF3A3A } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .kc { color: #6EBF26; font-weight: bold } /* Keyword.Constant */ +body[data-theme="dark"] .highlight .kd { color: #6EBF26; font-weight: bold } /* Keyword.Declaration */ +body[data-theme="dark"] .highlight .kn { color: #6EBF26; font-weight: bold } /* Keyword.Namespace */ +body[data-theme="dark"] .highlight .kp { color: #6EBF26 } /* Keyword.Pseudo */ +body[data-theme="dark"] .highlight .kr { color: #6EBF26; font-weight: bold } /* Keyword.Reserved */ +body[data-theme="dark"] .highlight .kt { color: #6EBF26; font-weight: bold } /* Keyword.Type */ +body[data-theme="dark"] .highlight .ld { color: #D0D0D0 } /* Literal.Date */ +body[data-theme="dark"] .highlight .m { color: #51B2FD } /* Literal.Number */ +body[data-theme="dark"] .highlight .s { color: #ED9D13 } /* Literal.String */ +body[data-theme="dark"] .highlight .na { color: #BBB } /* Name.Attribute */ +body[data-theme="dark"] .highlight .nb { color: #2FBCCD } /* Name.Builtin */ +body[data-theme="dark"] .highlight .nc { color: #71ADFF; text-decoration: underline } /* Name.Class */ +body[data-theme="dark"] .highlight .no { color: #40FFFF } /* Name.Constant */ +body[data-theme="dark"] .highlight .nd { color: #FFA500 } /* Name.Decorator */ +body[data-theme="dark"] .highlight .ni { color: #D0D0D0 } /* Name.Entity */ +body[data-theme="dark"] .highlight .ne { color: #BBB } /* Name.Exception */ +body[data-theme="dark"] .highlight .nf { color: #71ADFF } /* Name.Function */ +body[data-theme="dark"] .highlight .nl { color: #D0D0D0 } /* Name.Label */ +body[data-theme="dark"] .highlight .nn { color: #71ADFF; text-decoration: underline } /* Name.Namespace */ +body[data-theme="dark"] .highlight .nx { color: #D0D0D0 } /* Name.Other */ +body[data-theme="dark"] .highlight .py { color: #D0D0D0 } /* Name.Property */ +body[data-theme="dark"] .highlight .nt { color: #6EBF26; font-weight: bold } /* Name.Tag */ +body[data-theme="dark"] .highlight .nv { color: #40FFFF } /* Name.Variable */ +body[data-theme="dark"] .highlight .ow { color: #6EBF26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #D0D0D0 } /* Punctuation.Marker */ +body[data-theme="dark"] .highlight .w { color: #666 } /* Text.Whitespace */ +body[data-theme="dark"] .highlight .mb { color: #51B2FD } /* Literal.Number.Bin */ +body[data-theme="dark"] .highlight .mf { color: #51B2FD } /* Literal.Number.Float */ +body[data-theme="dark"] .highlight .mh { color: #51B2FD } /* Literal.Number.Hex */ +body[data-theme="dark"] .highlight .mi { color: #51B2FD } /* Literal.Number.Integer */ +body[data-theme="dark"] .highlight .mo { color: #51B2FD } /* Literal.Number.Oct */ +body[data-theme="dark"] .highlight .sa { color: #ED9D13 } /* Literal.String.Affix */ +body[data-theme="dark"] .highlight .sb { color: #ED9D13 } /* Literal.String.Backtick */ +body[data-theme="dark"] .highlight .sc { color: #ED9D13 } /* Literal.String.Char */ +body[data-theme="dark"] .highlight .dl { color: #ED9D13 } /* Literal.String.Delimiter */ +body[data-theme="dark"] .highlight .sd { color: #ED9D13 } /* Literal.String.Doc */ +body[data-theme="dark"] .highlight .s2 { color: #ED9D13 } /* Literal.String.Double */ +body[data-theme="dark"] .highlight .se { color: #ED9D13 } /* Literal.String.Escape */ +body[data-theme="dark"] .highlight .sh { color: #ED9D13 } /* Literal.String.Heredoc */ +body[data-theme="dark"] .highlight .si { color: #ED9D13 } /* Literal.String.Interpol */ +body[data-theme="dark"] .highlight .sx { color: #FFA500 } /* Literal.String.Other */ +body[data-theme="dark"] .highlight .sr { color: #ED9D13 } /* Literal.String.Regex */ +body[data-theme="dark"] .highlight .s1 { color: #ED9D13 } /* Literal.String.Single */ +body[data-theme="dark"] .highlight .ss { color: #ED9D13 } /* Literal.String.Symbol */ +body[data-theme="dark"] .highlight .bp { color: #2FBCCD } /* Name.Builtin.Pseudo */ +body[data-theme="dark"] .highlight .fm { color: #71ADFF } /* Name.Function.Magic */ +body[data-theme="dark"] .highlight .vc { color: #40FFFF } /* Name.Variable.Class */ +body[data-theme="dark"] .highlight .vg { color: #40FFFF } /* Name.Variable.Global */ +body[data-theme="dark"] .highlight .vi { color: #40FFFF } /* Name.Variable.Instance */ +body[data-theme="dark"] .highlight .vm { color: #40FFFF } /* Name.Variable.Magic */ +body[data-theme="dark"] .highlight .il { color: #51B2FD } /* Literal.Number.Integer.Long */ @media (prefers-color-scheme: dark) { body:not([data-theme="light"]) .highlight pre { line-height: 125%; } body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } @@ -175,84 +175,84 @@ body:not([data-theme="light"]) .highlight span.linenos { color: #aaaaaa; backgro body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } body:not([data-theme="light"]) .highlight .hll { background-color: #404040 } -body:not([data-theme="light"]) .highlight { background: #202020; color: #d0d0d0 } -body:not([data-theme="light"]) .highlight .c { color: #ababab; font-style: italic } /* Comment */ -body:not([data-theme="light"]) .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ -body:not([data-theme="light"]) .highlight .esc { color: #d0d0d0 } /* Escape */ -body:not([data-theme="light"]) .highlight .g { color: #d0d0d0 } /* Generic */ -body:not([data-theme="light"]) .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ -body:not([data-theme="light"]) .highlight .l { color: #d0d0d0 } /* Literal */ -body:not([data-theme="light"]) .highlight .n { color: #d0d0d0 } /* Name */ -body:not([data-theme="light"]) .highlight .o { color: #d0d0d0 } /* Operator */ -body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */ -body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */ -body:not([data-theme="light"]) .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ -body:not([data-theme="light"]) .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ -body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ -body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ -body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ -body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ -body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ -body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ +body:not([data-theme="light"]) .highlight { background: #202020; color: #D0D0D0 } +body:not([data-theme="light"]) .highlight .c { color: #ABABAB; font-style: italic } /* Comment */ +body:not([data-theme="light"]) .highlight .err { color: #A61717; background-color: #E3D2D2 } /* Error */ +body:not([data-theme="light"]) .highlight .esc { color: #D0D0D0 } /* Escape */ +body:not([data-theme="light"]) .highlight .g { color: #D0D0D0 } /* Generic */ +body:not([data-theme="light"]) .highlight .k { color: #6EBF26; font-weight: bold } /* Keyword */ +body:not([data-theme="light"]) .highlight .l { color: #D0D0D0 } /* Literal */ +body:not([data-theme="light"]) .highlight .n { color: #D0D0D0 } /* Name */ +body:not([data-theme="light"]) .highlight .o { color: #D0D0D0 } /* Operator */ +body:not([data-theme="light"]) .highlight .x { color: #D0D0D0 } /* Other */ +body:not([data-theme="light"]) .highlight .p { color: #D0D0D0 } /* Punctuation */ +body:not([data-theme="light"]) .highlight .ch { color: #ABABAB; font-style: italic } /* Comment.Hashbang */ +body:not([data-theme="light"]) .highlight .cm { color: #ABABAB; font-style: italic } /* Comment.Multiline */ +body:not([data-theme="light"]) .highlight .cp { color: #FF3A3A; font-weight: bold } /* Comment.Preproc */ +body:not([data-theme="light"]) .highlight .cpf { color: #ABABAB; font-style: italic } /* Comment.PreprocFile */ +body:not([data-theme="light"]) .highlight .c1 { color: #ABABAB; font-style: italic } /* Comment.Single */ +body:not([data-theme="light"]) .highlight .cs { color: #E50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ +body:not([data-theme="light"]) .highlight .gd { color: #FF3A3A } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .ge { color: #D0D0D0; font-style: italic } /* Generic.Emph */ +body:not([data-theme="light"]) .highlight .ges { color: #D0D0D0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +body:not([data-theme="light"]) .highlight .gr { color: #FF3A3A } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gh { color: #FFF; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ -body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ -body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ -body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ -body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ -body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ -body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ -body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ -body:not([data-theme="light"]) .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ -body:not([data-theme="light"]) .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ -body:not([data-theme="light"]) .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ -body:not([data-theme="light"]) .highlight .ld { color: #d0d0d0 } /* Literal.Date */ -body:not([data-theme="light"]) .highlight .m { color: #51b2fd } /* Literal.Number */ -body:not([data-theme="light"]) .highlight .s { color: #ed9d13 } /* Literal.String */ -body:not([data-theme="light"]) .highlight .na { color: #bbbbbb } /* Name.Attribute */ -body:not([data-theme="light"]) .highlight .nb { color: #2fbccd } /* Name.Builtin */ -body:not([data-theme="light"]) .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ -body:not([data-theme="light"]) .highlight .no { color: #40ffff } /* Name.Constant */ -body:not([data-theme="light"]) .highlight .nd { color: #ffa500 } /* Name.Decorator */ -body:not([data-theme="light"]) .highlight .ni { color: #d0d0d0 } /* Name.Entity */ -body:not([data-theme="light"]) .highlight .ne { color: #bbbbbb } /* Name.Exception */ -body:not([data-theme="light"]) .highlight .nf { color: #71adff } /* Name.Function */ -body:not([data-theme="light"]) .highlight .nl { color: #d0d0d0 } /* Name.Label */ -body:not([data-theme="light"]) .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ -body:not([data-theme="light"]) .highlight .nx { color: #d0d0d0 } /* Name.Other */ -body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Property */ -body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ -body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ -body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ -body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ -body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ -body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ -body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ -body:not([data-theme="light"]) .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ -body:not([data-theme="light"]) .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ -body:not([data-theme="light"]) .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ -body:not([data-theme="light"]) .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ -body:not([data-theme="light"]) .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ -body:not([data-theme="light"]) .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ -body:not([data-theme="light"]) .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ -body:not([data-theme="light"]) .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ -body:not([data-theme="light"]) .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ -body:not([data-theme="light"]) .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ -body:not([data-theme="light"]) .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ -body:not([data-theme="light"]) .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ -body:not([data-theme="light"]) .highlight .sx { color: #ffa500 } /* Literal.String.Other */ -body:not([data-theme="light"]) .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ -body:not([data-theme="light"]) .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ -body:not([data-theme="light"]) .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ -body:not([data-theme="light"]) .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ -body:not([data-theme="light"]) .highlight .fm { color: #71adff } /* Name.Function.Magic */ -body:not([data-theme="light"]) .highlight .vc { color: #40ffff } /* Name.Variable.Class */ -body:not([data-theme="light"]) .highlight .vg { color: #40ffff } /* Name.Variable.Global */ -body:not([data-theme="light"]) .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ -body:not([data-theme="light"]) .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ -body:not([data-theme="light"]) .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ +body:not([data-theme="light"]) .highlight .go { color: #CCC } /* Generic.Output */ +body:not([data-theme="light"]) .highlight .gp { color: #AAA } /* Generic.Prompt */ +body:not([data-theme="light"]) .highlight .gs { color: #D0D0D0; font-weight: bold } /* Generic.Strong */ +body:not([data-theme="light"]) .highlight .gu { color: #FFF; text-decoration: underline } /* Generic.Subheading */ +body:not([data-theme="light"]) .highlight .gt { color: #FF3A3A } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .kc { color: #6EBF26; font-weight: bold } /* Keyword.Constant */ +body:not([data-theme="light"]) .highlight .kd { color: #6EBF26; font-weight: bold } /* Keyword.Declaration */ +body:not([data-theme="light"]) .highlight .kn { color: #6EBF26; font-weight: bold } /* Keyword.Namespace */ +body:not([data-theme="light"]) .highlight .kp { color: #6EBF26 } /* Keyword.Pseudo */ +body:not([data-theme="light"]) .highlight .kr { color: #6EBF26; font-weight: bold } /* Keyword.Reserved */ +body:not([data-theme="light"]) .highlight .kt { color: #6EBF26; font-weight: bold } /* Keyword.Type */ +body:not([data-theme="light"]) .highlight .ld { color: #D0D0D0 } /* Literal.Date */ +body:not([data-theme="light"]) .highlight .m { color: #51B2FD } /* Literal.Number */ +body:not([data-theme="light"]) .highlight .s { color: #ED9D13 } /* Literal.String */ +body:not([data-theme="light"]) .highlight .na { color: #BBB } /* Name.Attribute */ +body:not([data-theme="light"]) .highlight .nb { color: #2FBCCD } /* Name.Builtin */ +body:not([data-theme="light"]) .highlight .nc { color: #71ADFF; text-decoration: underline } /* Name.Class */ +body:not([data-theme="light"]) .highlight .no { color: #40FFFF } /* Name.Constant */ +body:not([data-theme="light"]) .highlight .nd { color: #FFA500 } /* Name.Decorator */ +body:not([data-theme="light"]) .highlight .ni { color: #D0D0D0 } /* Name.Entity */ +body:not([data-theme="light"]) .highlight .ne { color: #BBB } /* Name.Exception */ +body:not([data-theme="light"]) .highlight .nf { color: #71ADFF } /* Name.Function */ +body:not([data-theme="light"]) .highlight .nl { color: #D0D0D0 } /* Name.Label */ +body:not([data-theme="light"]) .highlight .nn { color: #71ADFF; text-decoration: underline } /* Name.Namespace */ +body:not([data-theme="light"]) .highlight .nx { color: #D0D0D0 } /* Name.Other */ +body:not([data-theme="light"]) .highlight .py { color: #D0D0D0 } /* Name.Property */ +body:not([data-theme="light"]) .highlight .nt { color: #6EBF26; font-weight: bold } /* Name.Tag */ +body:not([data-theme="light"]) .highlight .nv { color: #40FFFF } /* Name.Variable */ +body:not([data-theme="light"]) .highlight .ow { color: #6EBF26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #D0D0D0 } /* Punctuation.Marker */ +body:not([data-theme="light"]) .highlight .w { color: #666 } /* Text.Whitespace */ +body:not([data-theme="light"]) .highlight .mb { color: #51B2FD } /* Literal.Number.Bin */ +body:not([data-theme="light"]) .highlight .mf { color: #51B2FD } /* Literal.Number.Float */ +body:not([data-theme="light"]) .highlight .mh { color: #51B2FD } /* Literal.Number.Hex */ +body:not([data-theme="light"]) .highlight .mi { color: #51B2FD } /* Literal.Number.Integer */ +body:not([data-theme="light"]) .highlight .mo { color: #51B2FD } /* Literal.Number.Oct */ +body:not([data-theme="light"]) .highlight .sa { color: #ED9D13 } /* Literal.String.Affix */ +body:not([data-theme="light"]) .highlight .sb { color: #ED9D13 } /* Literal.String.Backtick */ +body:not([data-theme="light"]) .highlight .sc { color: #ED9D13 } /* Literal.String.Char */ +body:not([data-theme="light"]) .highlight .dl { color: #ED9D13 } /* Literal.String.Delimiter */ +body:not([data-theme="light"]) .highlight .sd { color: #ED9D13 } /* Literal.String.Doc */ +body:not([data-theme="light"]) .highlight .s2 { color: #ED9D13 } /* Literal.String.Double */ +body:not([data-theme="light"]) .highlight .se { color: #ED9D13 } /* Literal.String.Escape */ +body:not([data-theme="light"]) .highlight .sh { color: #ED9D13 } /* Literal.String.Heredoc */ +body:not([data-theme="light"]) .highlight .si { color: #ED9D13 } /* Literal.String.Interpol */ +body:not([data-theme="light"]) .highlight .sx { color: #FFA500 } /* Literal.String.Other */ +body:not([data-theme="light"]) .highlight .sr { color: #ED9D13 } /* Literal.String.Regex */ +body:not([data-theme="light"]) .highlight .s1 { color: #ED9D13 } /* Literal.String.Single */ +body:not([data-theme="light"]) .highlight .ss { color: #ED9D13 } /* Literal.String.Symbol */ +body:not([data-theme="light"]) .highlight .bp { color: #2FBCCD } /* Name.Builtin.Pseudo */ +body:not([data-theme="light"]) .highlight .fm { color: #71ADFF } /* Name.Function.Magic */ +body:not([data-theme="light"]) .highlight .vc { color: #40FFFF } /* Name.Variable.Class */ +body:not([data-theme="light"]) .highlight .vg { color: #40FFFF } /* Name.Variable.Global */ +body:not([data-theme="light"]) .highlight .vi { color: #40FFFF } /* Name.Variable.Instance */ +body:not([data-theme="light"]) .highlight .vm { color: #40FFFF } /* Name.Variable.Magic */ +body:not([data-theme="light"]) .highlight .il { color: #51B2FD } /* Literal.Number.Integer.Long */ } }
\ No newline at end of file diff --git a/main/changelog.html b/main/changelog.html index 070ea2bb..9bf8c779 100644 --- a/main/changelog.html +++ b/main/changelog.html @@ -6,13 +6,13 @@ <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"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>Changelog - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> + <title>Changelog - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -465,6 +465,11 @@ <article role="main" id="furo-main-content"> <section id="changelog"> <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading">¶</a></h1> +<section id="Next 11.x bugfix release"> +<h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/vmaster">Next 11.x bugfix release</a></h2><ul class="simple"> +<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/302">#302</a><span>:</span> Bump Discord.py to <a class="reference external" href="https://discordpy.readthedocs.io/en/stable/whats_new.html#v2-5-0"><code class="docutils literal notranslate"><span class="pre">2.5.0</span></code></a>.</p></li> +</ul> +</section> <section id="11.5.1"> <h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v11.5.1">11.5.1</a> <span style="font-size: 75%;">23rd November 2024</span></h2><ul class="simple"> <li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/295">#295</a><span>:</span> Update <a class="reference internal" href="output/pydis_core.utils.regex.html#pydis_core.utils.regex.DISCORD_INVITE" title="pydis_core.utils.regex.DISCORD_INVITE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.regex.DISCORD_INVITE</span></code></a> to not be overly strict.</p></li> @@ -492,7 +497,7 @@ </section> <section id="11.2.0"> <h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v11.2.0">11.2.0</a> <span style="font-size: 75%;">22nd June 2024</span></h2><ul class="simple"> -<li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/244">#244</a><span>:</span> Bump Discord.py to <a class="reference external" href="https://github.com/Rapptz/discord.py/releases/tag/v2.4.0"><code class="docutils literal notranslate"><span class="pre">2.4.0</span></code></a>.</p></li> +<li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/244">#244</a><span>:</span> Bump Discord.py to <a class="reference external" href="https://discordpy.readthedocs.io/en/stable/whats_new.html#v2-4-0"><code class="docutils literal notranslate"><span class="pre">2.4.0</span></code></a>.</p></li> </ul> </section> <section id="11.1.0"> @@ -502,7 +507,7 @@ </section> <section id="11.0.1"> <h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v11.0.1">11.0.1</a> <span style="font-size: 75%;">20th March 2024</span></h2><ul class="simple"> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/209">#209</a><span>:</span> Extract original error from <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CommandInvokeError" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.errors.CommandInvokeError</span></code></a> before handling it.</p></li> +<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/209">#209</a><span>:</span> Extract original error from <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CommandInvokeError" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.errors.CommandInvokeError</span></code></a> before handling it.</p></li> </ul> </section> <section id="11.0.0"> @@ -561,14 +566,14 @@ </section> <section id="10.1.0"> <h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v10.1.0">10.1.0</a> <span style="font-size: 75%;">25th July 2023</span></h2><ul class="simple"> -<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/190">#190</a><span>:</span> Overwrite <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot.process_commands" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot.process_commands</span></code></a> to ensure no commands are processed until all extensions are loaded. This only works for clients using <a class="reference internal" href="output/pydis_core.html#pydis_core.BotBase.load_extensions" title="pydis_core.BotBase.load_extensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.BotBase.load_extensions</span></code></a>.</p></li> +<li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/190">#190</a><span>:</span> Overwrite <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot.process_commands" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot.process_commands</span></code></a> to ensure no commands are processed until all extensions are loaded. This only works for clients using <a class="reference internal" href="output/pydis_core.html#pydis_core.BotBase.load_extensions" title="pydis_core.BotBase.load_extensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.BotBase.load_extensions</span></code></a>.</p></li> </ul> </section> <section id="10.0.0"> <h2 style="margin-bottom: 0.3em;"><a class="reference external" href="https://github.com/python-discord/bot-core/releases/tag/v10.0.0">10.0.0</a> <span style="font-size: 75%;">14th July 2023</span></h2><ul class="simple"> <li><p>[<span style="color: #F50F10;">Breaking</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/188">#188</a><span>:</span> Support sending multiple files at once to paste service. All calls to <a class="reference internal" href="output/pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.send_to_paste_service" title="pydis_core.utils.paste_service.send_to_paste_service"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.paste_service.send_to_paste_service</span></code></a> must now provide a list of <a class="reference internal" href="output/pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile" title="pydis_core.utils.paste_service.PasteFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.paste_service.PasteFile</span></code></a>.</p></li> <li><p>[<span style="color: #40A056;">Feature</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/184">#184</a><span>:</span> Remove the message stored in the <code class="docutils literal notranslate"><span class="pre">message</span></code> attr of <a class="reference internal" href="output/pydis_core.utils.interactions.html#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="pydis_core.utils.interactions.ViewWithUserAndRoleCheck"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.interactions.ViewWithUserAndRoleCheck</span></code></a> when the interaction is stopped, in additional to the exist logic for timeout.</p></li> -<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/187">#187</a><span>:</span> Fix <a class="reference internal" href="output/pydis_core.utils.channel.html#pydis_core.utils.channel.get_or_fetch_channel" title="pydis_core.utils.channel.get_or_fetch_channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.channel.get_or_fetch_channel</span></code></a>’s return type to include <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.PrivateChannel" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.abc.PrivateChannel</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Thread" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Thread</span></code></a>.</p></li> +<li><p>[<span style="color: #A04040;">Bug</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/187">#187</a><span>:</span> Fix <a class="reference internal" href="output/pydis_core.utils.channel.html#pydis_core.utils.channel.get_or_fetch_channel" title="pydis_core.utils.channel.get_or_fetch_channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.channel.get_or_fetch_channel</span></code></a>’s return type to include <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.PrivateChannel" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.abc.PrivateChannel</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Thread" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Thread</span></code></a>.</p></li> <li><p>[<span style="color: #4070A0;">Support</span>]<span> </span><a class="reference external" href="https://github.com/python-discord/bot-core/issues/184">#184</a><span>:</span> Bump Discord.py to <a class="reference external" href="https://github.com/Rapptz/discord.py/releases/tag/v2.3.1"><code class="docutils literal notranslate"><span class="pre">2.3.1</span></code></a>.</p></li> </ul> </section> @@ -914,7 +919,7 @@ </aside> </div> -</div><script src="_static/documentation_options.js?v=07a056c7"></script> +</div><script src="_static/documentation_options.js?v=31a70c35"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/development.html b/main/development.html index f22e7492..2aab2433 100644 --- a/main/development.html +++ b/main/development.html @@ -6,13 +6,13 @@ <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/pydis_core.site_api.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>Local Development & Testing - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> + <title>Local Development & Testing - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -591,7 +591,7 @@ to help you test out certain features. Use them as needed.</p> </aside> </div> -</div><script src="_static/documentation_options.js?v=07a056c7"></script> +</div><script src="_static/documentation_options.js?v=31a70c35"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/genindex.html b/main/genindex.html index ca3c538a..8eec5160 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -4,13 +4,13 @@ <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --><title>Index - Pydis Core Latest (11.5.1)</title> -<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --><title>Index - Pydis Core Latest (11.6.0)</title> +<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> @@ -168,7 +168,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -195,7 +195,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -1331,7 +1331,7 @@ </aside> </div> -</div><script src="_static/documentation_options.js?v=07a056c7"></script> +</div><script src="_static/documentation_options.js?v=31a70c35"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/index.html b/main/index.html index 290cfb7a..f2df32e8 100644 --- a/main/index.html +++ b/main/index.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Pydis Core" href="output/pydis_core.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> + <title>Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="#"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="#"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -609,7 +609,7 @@ </aside> </div> -</div><script src="_static/documentation_options.js?v=07a056c7"></script> +</div><script src="_static/documentation_options.js?v=31a70c35"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/index_redirect.html b/main/index_redirect.html index 28bbf2d3..eccb653b 100644 --- a/main/index_redirect.html +++ b/main/index_redirect.html @@ -9,13 +9,13 @@ <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> + <title>Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> @@ -54,7 +54,7 @@ Please click here if you were not redirected to the latest build. </a></h2> </div> -<script src="_static/documentation_options.js?v=07a056c7"></script> +<script src="_static/documentation_options.js?v=31a70c35"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/objects.inv b/main/objects.inv Binary files differindex c7046ccb..5516e07e 100644 --- a/main/objects.inv +++ b/main/objects.inv diff --git a/main/output/pydis_core.async_stats.html b/main/output/pydis_core.async_stats.html index e6f9a5e1..3808af95 100644 --- a/main/output/pydis_core.async_stats.html +++ b/main/output/pydis_core.async_stats.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="site_api" href="pydis_core.site_api.html" /><link rel="prev" title="scheduling" href="pydis_core.utils.scheduling.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>async_stats - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>async_stats - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,12 +468,12 @@ <p>An async transport method for statsd communication.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/async_stats.py#L11-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/async_stats.py#L11-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatsClientBase</span></code></a></p> <p>An async implementation of <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statsd.client.base.StatsClientBase</span></code></a> that supports async stat communication.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/async_stats.py#L14-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient.__init__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/async_stats.py#L14-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient.__init__" title="Link to this definition">¶</a></dt> <dd><p>Create a new <a class="reference internal" href="#pydis_core.async_stats.AsyncStatsClient" title="pydis_core.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> @@ -490,7 +490,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/async_stats.py#L39-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient.create_socket" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/async_stats.py#L39-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient.create_socket" title="Link to this definition">¶</a></dt> <dd><p>Use <a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.13)"><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> @@ -575,7 +575,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.exts.html b/main/output/pydis_core.exts.html index 8a892149..9de81286 100644 --- a/main/output/pydis_core.exts.html +++ b/main/output/pydis_core.exts.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Utils" href="pydis_core.utils.html" /><link rel="prev" title="Pydis Core" href="pydis_core.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>Exts - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>Exts - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -517,7 +517,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.html b/main/output/pydis_core.html index 068b05a6..4ed37b58 100644 --- a/main/output/pydis_core.html +++ b/main/output/pydis_core.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Exts" href="pydis_core.exts.html" /><link rel="prev" title="Bot Core Project Documentation" href="../index.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>Pydis Core - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>Pydis Core - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,12 +468,12 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></p> +<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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase" title="Link to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.6.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 attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.guild_id"> -<span class="sig-name descname"><span class="pre">guild_id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.guild_id" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">guild_id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.guild_id" title="Link to this definition">¶</a></dt> <dd><p>ID of the guild that the bot belongs to.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -484,7 +484,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.http_session"> -<span class="sig-name descname"><span class="pre">http_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.http_session" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">http_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.http_session" title="Link to this definition">¶</a></dt> <dd><p>The http session used for sending out HTTP requests.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -495,7 +495,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.api_client"> -<span class="sig-name descname"><span class="pre">api_client</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.api_client" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">api_client</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.api_client" title="Link to this definition">¶</a></dt> <dd><p>The API client used for communications with the site service.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -506,7 +506,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.statsd_url"> -<span class="sig-name descname"><span class="pre">statsd_url</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.statsd_url" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">statsd_url</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.statsd_url" title="Link to this definition">¶</a></dt> <dd><p>The url that statsd sends metrics to.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -517,7 +517,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.redis_session"> -<span class="sig-name descname"><span class="pre">redis_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.redis_session" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">redis_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.redis_session" title="Link to this definition">¶</a></dt> <dd><p>The redis session used to communicate with the Redis instance.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -528,7 +528,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.stats"> -<span class="sig-name descname"><span class="pre">stats</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.stats" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">stats</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.stats" title="Link to this definition">¶</a></dt> <dd><p>The statsd client that sends metrics.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -539,7 +539,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.all_extensions"> -<span class="sig-name descname"><span class="pre">all_extensions</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.all_extensions" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">all_extensions</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.all_extensions" title="Link to this definition">¶</a></dt> <dd><p>All extensions that were found within the <code class="docutils literal notranslate"><span class="pre">module</span></code> passed to <code class="docutils literal notranslate"><span class="pre">self.load_extensions</span></code>. Use <code class="docutils literal notranslate"><span class="pre">self.extensions</span></code> to get the loaded extensions.</p> <dl class="field-list simple"> @@ -551,7 +551,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L70-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.__init__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L70-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.__init__" title="Link to this definition">¶</a></dt> <dd><p>Initialise the base bot instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -570,7 +570,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L212-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_cog" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L212-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_cog" title="Link to this definition">¶</a></dt> <dd><p>Add the given <code class="docutils literal notranslate"><span class="pre">cog</span></code> to the bot and log the operation.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -581,7 +581,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L217-L221"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_command" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L217-L221"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_command" title="Link to this definition">¶</a></dt> <dd><p>Add <code class="docutils literal notranslate"><span class="pre">command</span></code> as normal and then add its root aliases to the bot.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -592,7 +592,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L237-L240"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.clear" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L237-L240"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.clear" title="Link to this definition">¶</a></dt> <dd><p>Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -603,7 +603,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L326-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.close" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L326-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.close" title="Link to this definition">¶</a></dt> <dd><p>Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -614,7 +614,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sync_app_commands</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L180-L190"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.load_extensions" title="Link 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>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sync_app_commands</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L180-L190"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.load_extensions" title="Link to this definition">¶</a></dt> <dd><p>Load all the extensions within the given <code class="docutils literal notranslate"><span class="pre">module</span></code> and save them to <code class="docutils literal notranslate"><span class="pre">self.all_extensions</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -628,7 +628,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L265-L267"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.log_to_dev_log" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L265-L267"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.log_to_dev_log" title="Link to this definition">¶</a></dt> <dd><p>Log the given message to #dev-log.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -639,7 +639,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L248-L264"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_available" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L248-L264"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_available" title="Link to this definition">¶</a></dt> <dd><p>Set the internal guild available event when self.guild_id becomes available.</p> <p>If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</p> @@ -652,7 +652,7 @@ 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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L241-L247"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_unavailable" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L241-L247"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_unavailable" title="Link to this definition">¶</a></dt> <dd><p>Clear the internal guild available event when self.guild_id becomes unavailable.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -663,7 +663,7 @@ 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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L323-L325"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.ping_services" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L323-L325"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.ping_services" title="Link to this definition">¶</a></dt> <dd><p>Ping all required services on setup to ensure they are up before starting.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -674,7 +674,7 @@ 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="pydis_core.BotBase.process_commands"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_commands</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L277-L286"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.process_commands" title="Link 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">process_commands</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L277-L286"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.process_commands" title="Link to this definition">¶</a></dt> <dd><p>Overwrite default Discord.py behaviour to process commands only after ensuring extensions are loaded.</p> <p>This extension check is only relevant for clients that make use of <a class="reference internal" href="#pydis_core.BotBase.load_extensions" title="pydis_core.BotBase.load_extensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.BotBase.load_extensions</span></code></a>.</p> <dl class="field-list simple"> @@ -686,7 +686,7 @@ 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="pydis_core.BotBase.register_command_error_manager"> -<span class="sig-name descname"><span class="pre">register_command_error_manager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L124-L133"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.register_command_error_manager" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">register_command_error_manager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L124-L133"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.register_command_error_manager" title="Link to this definition">¶</a></dt> <dd><p>Bind an instance of the command error manager to both the bot and the command tree.</p> <p>The reason this doesn’t happen in the constructor is because error handlers might need an instance of the bot. So registration needs to happen once the bot instance has been created.</p> @@ -699,20 +699,20 @@ So registration needs to happen once the bot instance has been created.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L222-L236"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.remove_command" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L222-L236"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.remove_command" title="Link to this definition">¶</a></dt> <dd><p>Remove a command/alias as normal and then remove its root aliases from the bot.</p> <p>Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L287-L322"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.setup_hook" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L287-L322"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.setup_hook" title="Link to this definition">¶</a></dt> <dd><p>An async init to startup generic services.</p> <p>Connects to statsd, and calls <a class="reference internal" href="pydis_core.async_stats.html#pydis_core.async_stats.AsyncStatsClient.create_socket" title="pydis_core.async_stats.AsyncStatsClient.create_socket"><code class="xref py py-func docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket</span></code></a> @@ -726,7 +726,7 @@ and <a class="reference internal" href="#pydis_core.BotBase.ping_services" title <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L268-L276"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.wait_until_guild_available" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L268-L276"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.wait_until_guild_available" title="Link to this definition">¶</a></dt> <dd><p>Wait until the guild that matches the <code class="docutils literal notranslate"><span class="pre">guild_id</span></code> given at init is available (and the cache is ready).</p> <p>The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE gateway event before giving up and thus not populating the cache for unavailable guilds.</p> @@ -741,15 +741,15 @@ gateway event before giving up and thus not populating the cache for unavailable <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.EmptyPaginatorEmbedError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.EmptyPaginatorEmbedError" title="Link 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">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.EmptyPaginatorEmbedError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when attempting to paginate with empty contents.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.LinePaginator"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><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">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Paginator" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Paginator</span></code></a></p> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><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">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator" title="Link to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Paginator" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Paginator</span></code></a></p> <p>A class that aids in paginating code blocks for Discord messages.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -765,14 +765,14 @@ gateway event before giving up and thus not populating the cache for unavailable </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.__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">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.__init__" title="Link 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">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.__init__" title="Link to this definition">¶</a></dt> <dd><p>This function overrides the Paginator.__init__ from inside discord.ext.commands.</p> <p>It overrides in order to allow us to configure the maximum number of lines per page.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.add_line"> -<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.add_line" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.add_line" title="Link to this definition">¶</a></dt> <dd><p>Adds a line to the current page.</p> <p>If a line on a page exceeds <cite>max_size</cite> characters, then <cite>max_size</cite> will go up to <cite>scale_to_size</cite> for a single line before creating a new page for the overflow words. If it @@ -800,7 +800,7 @@ page at a reasonable size.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.paginate"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</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">prefix</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">suffix</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">max_lines</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</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="n"><span class="pre">restrict_to_user</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</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">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="n"><span class="pre">exception_on_empty_embed</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">reply</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">allowed_roles</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.paginate" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</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">prefix</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">suffix</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">max_lines</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</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="n"><span class="pre">restrict_to_user</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</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">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="n"><span class="pre">exception_on_empty_embed</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">reply</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">allowed_roles</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.paginate" title="Link to this definition">¶</a></dt> <dd><p>Use a paginator and set of reactions to provide pagination over a set of lines.</p> <p>The reactions are used to switch page, or to finish with pagination.</p> <p>When used, this will send a message using <cite>ctx.send()</cite> and apply a set of reactions to it. These reactions may @@ -813,15 +813,15 @@ to any user with a moderation role.</p> <dd class="field-odd"><ul class="simple"> <li><p><strong>pagination_emojis</strong> (<a class="reference internal" href="#pydis_core.PaginationEmojis" title="pydis_core.PaginationEmojis"><em>PaginationEmojis</em></a>) – The emojis used to navigate pages.</p></li> <li><p><strong>lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em>) – A list of lines to be added to the paginated content.</p></li> -<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.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the pagination is needed.</p></li> -<li><p><strong>embed</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Embed" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Embed</span></code></a>) – The embed that holds the content, it serves as the page.</p></li> +<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.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the pagination is needed.</p></li> +<li><p><strong>embed</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Embed" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Embed</span></code></a>) – The embed that holds the content, it serves as the page.</p></li> <li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> <li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> <li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> <li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> <li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> <li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether an empty line should be added to each provided line.</p></li> -<li><p><strong>restrict_to_user</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.User</span></code></a>) – The user to whom interaction with the pages should be restricted.</p></li> +<li><p><strong>restrict_to_user</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.User</span></code></a>) – The user to whom interaction with the pages should be restricted.</p></li> <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The timeout after which users cannot change pages anymore.</p></li> <li><p><strong>footer_text</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Text to be added as a footer for each page.</p></li> <li><p><strong>url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The url to be set for the pagination embed.</p></li> @@ -831,7 +831,7 @@ to any user with a moderation role.</p> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> <p>Example: @@ -844,7 +844,7 @@ to any user with a moderation role.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.PaginationEmojis" title="Link 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">PaginationEmojis</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.PaginationEmojis" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>The emojis that will be used for pagination.</p> <dl class="py attribute"> @@ -873,7 +873,7 @@ to any user with a moderation role.</p> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_core_schema__"> -<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PaginationEmojis'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis:93876414324032',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'delete':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'<:trashcan:637136429717389331>',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'first':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏮',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'last':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏭',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'left':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⬅',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'right':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'➡',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PaginationEmojis',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PaginationEmojis'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis:94648214564144',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'delete':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'<:trashcan:637136429717389331>',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'first':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏮',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'last':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏭',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'left':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⬅',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'right':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'➡',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PaginationEmojis',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> <dd><p>The core schema of the model.</p> </dd></dl> @@ -936,13 +936,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_serializer__"> -<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055614e541d40,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"left":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28d797f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1ec0cf80,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"delete":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed29160eb0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1ec0d0c0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"last":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28dd2170,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1ec0d070,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"first":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28df47f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1ec0cfd0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"right":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28d797b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1ec0d020,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">5,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_serializer__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000561501352d30,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"last":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90dccd30,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8cfa1570,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"first":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90deb2f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8cfa14d0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"right":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90d7c1f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8cfa1520,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"delete":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a91108eb0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8cfa15c0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"left":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90d7c230,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8cfa1480,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">5,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_serializer__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaSerializer</cite> used to dump instances of the model.</p> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_validator__"> -<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PaginationEmojis",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"first",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"first",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed244f2670,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"first",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed244f3270,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28df47f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1ec0cfd0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed246fcbe0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"left",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"left",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed260d8070,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"left",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1e33d870,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28d797f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1ec0cf80,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed246fcbe0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"right",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"right",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed1e33e1b0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"right",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1e33d770,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28d797b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1ec0d020,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed246fcbe0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"last",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"last",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed1e33ff70,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"last",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1e33f2b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28dd2170,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1ec0d070,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed246fcbe0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"delete",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"delete",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed1e33dcb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"delete",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1e33d970,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed29160eb0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1ec0d0c0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed246fcbe0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PaginationEmojis",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055614e541d40,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fed246fcbe0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_validator__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PaginationEmojis",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"first",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"first",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8d80d430,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"first",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d80c370,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90deb2f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8cfa14d0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8d9f0bd0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"left",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"left",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8d6613f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"left",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a902a1330,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90d7c230,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8cfa1480,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8d9f0bd0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"right",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"right",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8c2733b0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"right",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8c2721f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90d7c1f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8cfa1520,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8d9f0bd0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"last",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"last",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8c273fb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"last",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8c2739f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90dccd30,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8cfa1570,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8d9f0bd0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"delete",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"delete",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8c271af0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"delete",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8c271eb0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a91108eb0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8cfa15c0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8d9f0bd0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PaginationEmojis",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000561501352d30,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f4a8d9f0bd0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_validator__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaValidator</cite> used to validate instances of the model.</p> </dd></dl> @@ -962,12 +962,12 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L29-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L29-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/_bot.py#L32-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError.__init__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/_bot.py#L32-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> @@ -1252,7 +1252,7 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.site_api.html b/main/output/pydis_core.site_api.html index 2862d426..4cd1180c 100644 --- a/main/output/pydis_core.site_api.html +++ b/main/output/pydis_core.site_api.html @@ -6,13 +6,13 @@ <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="pydis_core.async_stats.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>site_api - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>site_api - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,12 +468,12 @@ <p>An API wrapper around the Site API.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L41-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L41-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L47-L70"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.__init__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L47-L70"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.__init__" title="Link to this definition">¶</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#pydis_core.site_api.APIClient" title="pydis_core.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> @@ -488,7 +488,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L74-L77"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.close" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L74-L77"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.close" title="Link to this definition">¶</a></dt> <dd><p>Close the aiohttp session.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -499,7 +499,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L139-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.delete" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L139-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.delete" title="Link to this definition">¶</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with DELETE passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -510,7 +510,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L123-L126"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.get" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L123-L126"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.get" title="Link to this definition">¶</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.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> @@ -521,7 +521,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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="o"><span class="pre">*</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L78-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.maybe_raise_for_status" title="Link 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="o"><span class="pre">*</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L78-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.maybe_raise_for_status" title="Link to this definition">¶</a></dt> <dd><p>Raise <a class="reference internal" href="#pydis_core.site_api.ResponseCodeError" title="pydis_core.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> @@ -541,7 +541,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L127-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.patch" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L127-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.patch" title="Link to this definition">¶</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.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> @@ -552,7 +552,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L131-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.post" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L131-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.post" title="Link to this definition">¶</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.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> @@ -563,7 +563,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L135-L138"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.put" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L135-L138"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.put" title="Link to this definition">¶</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.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> @@ -574,7 +574,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L99-L122"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.request" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L99-L122"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.request" title="Link to this definition">¶</a></dt> <dd><p>Send an HTTP request to the site API and return the JSON response.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -601,12 +601,12 @@ <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L13-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L13-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><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="#pydis_core.site_api.APIClient.request" title="pydis_core.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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L16-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError.__init__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L16-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError.__init__" title="Link to this definition">¶</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#pydis_core.site_api.ResponseCodeError" title="pydis_core.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> @@ -621,7 +621,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/site_api.py#L35-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError.__str__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/site_api.py#L35-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError.__str__" title="Link to this definition">¶</a></dt> <dd><p>Return a string representation of the error.</p> </dd></dl> @@ -713,7 +713,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.caching.html b/main/output/pydis_core.utils.caching.html index 161fc69b..eec28d90 100644 --- a/main/output/pydis_core.utils.caching.html +++ b/main/output/pydis_core.utils.caching.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="channel" href="pydis_core.utils.channel.html" /><link rel="prev" title="manager" href="pydis_core.utils.error_handling.commands.manager.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>caching - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>caching - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,14 +468,14 @@ <p>Utilities related to custom caches.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__call__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__call__" title="Link to this definition">¶</a></dt> <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -492,7 +492,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__init__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__init__" title="Link to this definition">¶</a></dt> <dd><p>Initialise a new <a class="reference internal" href="#pydis_core.utils.caching.AsyncCache" title="pydis_core.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> @@ -503,7 +503,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.clear" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.clear" title="Link to this definition">¶</a></dt> <dd><p>Clear cache instance.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -589,7 +589,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.channel.html b/main/output/pydis_core.utils.channel.html index 229326dd..b52dbee1 100644 --- a/main/output/pydis_core.utils.channel.html +++ b/main/output/pydis_core.utils.channel.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="checks" href="pydis_core.utils.checks.html" /><link rel="prev" title="caching" href="pydis_core.utils.caching.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>channel - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>channel - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,25 +468,25 @@ <p>Useful helper functions for interacting with various discord channel objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/channel.py#L25-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.get_or_fetch_channel" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/channel.py#L25-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.get_or_fetch_channel" title="Link to this definition">¶</a></dt> <dd><p>Attempt to get or fetch the given <code class="docutils literal notranslate"><span class="pre">channel_id</span></code> from the bots cache, and return it.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>bot</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></span>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.5.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>bot</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></span>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code></a> instance to use for getting/fetching.</p></li> <li><p><strong>channel_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The channel to get/fetch.</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><ul class="simple"> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.5.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.5.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.5.0a)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.5.0a)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.6.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.6.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.6.0a)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.6.0a)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li> </ul> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a> | <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.PrivateChannel" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrivateChannel</span></code></a> | <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Thread" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Thread</span></code></a></span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a> | <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.PrivateChannel" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrivateChannel</span></code></a> | <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Thread" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Thread</span></code></a></span></p> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>The channel from the ID.</p> @@ -496,12 +496,12 @@ <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.is_in_category" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.is_in_category" title="Link to this definition">¶</a></dt> <dd><p>Return whether the given <code class="docutils literal notranslate"><span class="pre">channel</span></code> in the the category with the id <code class="docutils literal notranslate"><span class="pre">category_id</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a></span>) – The channel to check.</p></li> +<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a></span>) – The channel to check.</p></li> <li><p><strong>category_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The category to check for.</p></li> </ul> </dd> @@ -585,7 +585,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.checks.html b/main/output/pydis_core.utils.checks.html index c0f1030f..0ef7ec17 100644 --- a/main/output/pydis_core.utils.checks.html +++ b/main/output/pydis_core.utils.checks.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="commands" href="pydis_core.utils.commands.html" /><link rel="prev" title="channel" href="pydis_core.utils.channel.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>checks - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>checks - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,26 +467,26 @@ <span id="checks"></span><h1>checks<a class="headerlink" href="#module-pydis_core.utils.checks" title="Link to this heading">¶</a></h1> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.checks.ContextCheckFailure"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ContextCheckFailure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/checks.py#L20-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.ContextCheckFailure" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CheckFailure" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckFailure</span></code></a></p> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ContextCheckFailure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/checks.py#L20-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.ContextCheckFailure" title="Link to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CheckFailure" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckFailure</span></code></a></p> <p>Raised when a context-specific check fails.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.checks.ContextCheckFailure.__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">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/checks.py#L23-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.ContextCheckFailure.__init__" title="Link 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">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/checks.py#L23-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.ContextCheckFailure.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.checks.InWhitelistCheckFailure"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InWhitelistCheckFailure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/checks.py#L36-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.InWhitelistCheckFailure" title="Link 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">InWhitelistCheckFailure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/checks.py#L36-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.InWhitelistCheckFailure" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#pydis_core.utils.checks.ContextCheckFailure" title="pydis_core.utils.checks.ContextCheckFailure"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContextCheckFailure</span></code></a></p> <p>Raised when the <cite>in_whitelist</cite> check fails.</p> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.checks.cooldown_with_role_bypass"> -<span class="sig-name descname"><span class="pre">cooldown_with_role_bypass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">per</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type_</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('default',</span> <span class="pre">0)</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">bypass_roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/checks.py#L100-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.cooldown_with_role_bypass" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">cooldown_with_role_bypass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">per</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type_</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('default',</span> <span class="pre">0)</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">bypass_roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/checks.py#L100-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.cooldown_with_role_bypass" title="Link to this definition">¶</a></dt> <dd><p>Decorate a command to have a cooldown, which can be bypassed by users with specified roles.</p> <p>Note: This replaces the <cite>Command.before_invoke</cite> callback, which <em>might</em> introduce problems in the future.</p> <dl class="field-list simple"> @@ -494,7 +494,7 @@ <dd class="field-odd"><ul class="simple"> <li><p><strong>rate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Number of times a command can be used before triggering a cooldown.</p></li> <li><p><strong>per</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – The duration (in seconds) for how long the cooldown lasts.</p></li> -<li><p><strong>type</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BucketType" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.BucketType</span></code></a>) – The type of cooldown (per user, per channel, per guild, etc.).</p></li> +<li><p><strong>type</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BucketType" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.BucketType</span></code></a>) – The type of cooldown (per user, per channel, per guild, etc.).</p></li> <li><p><strong>bypass_roles</strong> (<em>Iterable</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – An iterable of role IDs that bypass the cooldown.</p></li> </ul> </dd> @@ -512,13 +512,13 @@ <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.checks.has_any_role_check"> -<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">has_any_role_check</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="o"><span class="pre">*</span></span><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/checks.py#L163-L193"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.has_any_role_check" title="Link 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">has_any_role_check</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="o"><span class="pre">*</span></span><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/checks.py#L163-L193"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.has_any_role_check" title="Link to this definition">¶</a></dt> <dd><p>Verify if the context’s author has any of the specified roles.</p> <p>This check will always fail if the context is a DM, since DMs don’t have roles.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>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.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> +<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.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> <li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> </ul> </dd> @@ -533,13 +533,13 @@ <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.checks.has_no_roles_check"> -<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">has_no_roles_check</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="o"><span class="pre">*</span></span><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/checks.py#L195-L222"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.has_no_roles_check" title="Link 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">has_no_roles_check</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="o"><span class="pre">*</span></span><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/checks.py#L195-L222"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.has_no_roles_check" title="Link to this definition">¶</a></dt> <dd><p>Verify if the context’s author doesn’t have any of the specified roles.</p> <p>This check will always fail if the context is a DM, since DMs don’t have roles.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>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.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> +<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.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> <li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> </ul> </dd> @@ -554,12 +554,12 @@ <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.checks.in_whitelist_check"> -<span class="sig-name descname"><span class="pre">in_whitelist_check</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">redirect</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channels</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">categories</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">roles</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fail_silently</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/checks.py#L40-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.in_whitelist_check" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">in_whitelist_check</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">redirect</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channels</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">categories</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">roles</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fail_silently</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/checks.py#L40-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.in_whitelist_check" title="Link to this definition">¶</a></dt> <dd><p>Check if a command was issued in a context that is whitelisted by channel, category, or roles.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>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.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the command is being invoked.</p></li> +<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.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the command is being invoked.</p></li> <li><p><strong>redirect</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em> | </em><em>None</em>) – The channel ID to redirect the user to, if any.</p></li> <li><p><strong>channels</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Whitelisted channel IDs. Defaults to ().</p></li> <li><p><strong>categories</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Whitelisted category IDs. Defaults to ().</p></li> @@ -657,7 +657,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.commands.html b/main/output/pydis_core.utils.commands.html index 95f2c312..ffef233d 100644 --- a/main/output/pydis_core.utils.commands.html +++ b/main/output/pydis_core.utils.commands.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="cooldown" href="pydis_core.utils.cooldown.html" /><link rel="prev" title="checks" href="pydis_core.utils.checks.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>commands - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>commands - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,17 +467,17 @@ <span id="commands"></span><h1>commands<a class="headerlink" href="#module-pydis_core.utils.commands" title="Link to this heading">¶</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/commands.py#L6-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.commands.clean_text_or_reply" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/commands.py#L6-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.commands.clean_text_or_reply" title="Link 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> <dd class="field-odd"><ul class="simple"> -<li><p><strong>ctx</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Context</span></code></a></span>) – The command’s context</p></li> +<li><p><strong>ctx</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Context</span></code></a></span>) – The command’s context</p></li> <li><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The provided text argument of the command (if given)</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></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.5.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 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.6.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> <dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p> @@ -558,7 +558,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.cooldown.html b/main/output/pydis_core.utils.cooldown.html index 237fc99c..8f544174 100644 --- a/main/output/pydis_core.utils.cooldown.html +++ b/main/output/pydis_core.utils.cooldown.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="function" href="pydis_core.utils.function.html" /><link rel="prev" title="commands" href="pydis_core.utils.commands.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>cooldown - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>cooldown - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,17 +468,17 @@ <p>Helpers for setting a cooldown on commands.</p> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/cooldown.py#L36-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CommandError" title="(in discord.py v2.5.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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Generic</span></code></a>[<a class="reference internal" href="#pydis_core.utils.cooldown.P" title="pydis_core.utils.cooldown.P"><code class="xref py py-obj docutils literal notranslate"><span class="pre">P</span></code></a>, <a class="reference internal" href="#pydis_core.utils.cooldown.R" title="pydis_core.utils.cooldown.R"><code class="xref py py-obj docutils literal notranslate"><span class="pre">R</span></code></a>]</p> +<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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/cooldown.py#L36-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown" title="Link to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CommandError" title="(in discord.py v2.6.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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Generic</span></code></a>[<a class="reference internal" href="#pydis_core.utils.cooldown.P" title="pydis_core.utils.cooldown.P"><code class="xref py py-obj docutils literal notranslate"><span class="pre">P</span></code></a>, <a class="reference internal" href="#pydis_core.utils.cooldown.R" title="pydis_core.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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/cooldown.py#L39-L51"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown.__init__" title="Link 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">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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/cooldown.py#L39-L51"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/cooldown.py#L52-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown" title="Link 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">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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/cooldown.py#L52-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown" title="Link 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<span class="colon">:</span></dt> @@ -494,20 +494,20 @@ <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/cooldown.py#L30"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.P" title="Link to this definition">¶</a></dt> +<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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/cooldown.py#L30"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.P" title="Link to this definition">¶</a></dt> <dd><p>The command’s signature.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.cooldown.R"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">R</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/cooldown.py#L32"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.R" title="Link 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">R</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/cooldown.py#L32"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.R" title="Link 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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/cooldown.py#L174-L220"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.block_duplicate_invocations" title="Link to this definition">¶</a></dt> +<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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/cooldown.py#L174-L220"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.block_duplicate_invocations" title="Link 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<span class="colon">:</span></dt> @@ -608,7 +608,7 @@ its return value is then used to check for the cooldown instead of the raw argum </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.error_handling.commands.abc.html b/main/output/pydis_core.utils.error_handling.commands.abc.html index 0fb93c0c..694fed55 100644 --- a/main/output/pydis_core.utils.error_handling.commands.abc.html +++ b/main/output/pydis_core.utils.error_handling.commands.abc.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="manager" href="pydis_core.utils.error_handling.commands.manager.html" /><link rel="prev" title="commands package" href="pydis_core.utils.error_handling.commands.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>abc - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>abc - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,12 +467,12 @@ <span id="abc"></span><h1>abc<a class="headerlink" href="#module-pydis_core.utils.error_handling.commands.abc" title="Link to this heading">¶</a></h1> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AbstractCommandErrorHandler</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/abc.py#L8-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler" title="Link 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">AbstractCommandErrorHandler</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/abc.py#L8-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></a></p> <p>An abstract command error handler.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_app_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/abc.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_app_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/abc.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error" title="Link to this definition">¶</a></dt> <dd><p>Handle error raised in the context of app commands.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -483,7 +483,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_text_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/abc.py#L21-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_text_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/abc.py#L21-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error" title="Link to this definition">¶</a></dt> <dd><p>Handle error raised in the context of text commands.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -494,7 +494,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/abc.py#L11-L15"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/abc.py#L11-L15"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error" title="Link to this definition">¶</a></dt> <dd><p>A predicate that determines whether the error should be handled.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -580,7 +580,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.error_handling.commands.html b/main/output/pydis_core.utils.error_handling.commands.html index cae7ef46..cb1e62ec 100644 --- a/main/output/pydis_core.utils.error_handling.commands.html +++ b/main/output/pydis_core.utils.error_handling.commands.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="abc" href="pydis_core.utils.error_handling.commands.abc.html" /><link rel="prev" title="error_handling package" href="pydis_core.utils.error_handling.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>commands package - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>commands package - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,12 +467,12 @@ <span id="commands-package"></span><h1>commands package<a class="headerlink" href="#module-pydis_core.utils.error_handling.commands" title="Link to this heading">¶</a></h1> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AbstractCommandErrorHandler</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/abc.py#L8-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler" title="Link 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">AbstractCommandErrorHandler</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/abc.py#L8-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></a></p> <p>An abstract command error handler.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_app_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/abc.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_app_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/abc.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error" title="Link to this definition">¶</a></dt> <dd><p>Handle error raised in the context of app commands.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -483,7 +483,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_text_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/abc.py#L21-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_text_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/abc.py#L21-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error" title="Link to this definition">¶</a></dt> <dd><p>Handle error raised in the context of text commands.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -494,7 +494,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error"> -<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/abc.py#L11-L15"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/abc.py#L11-L15"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error" title="Link to this definition">¶</a></dt> <dd><p>A predicate that determines whether the error should be handled.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -507,17 +507,17 @@ <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.CommandErrorManager"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommandErrorManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/manager.py#L13-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager" title="Link 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">CommandErrorManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/manager.py#L13-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>A class that registers error handlers and handles all command related errors.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.CommandErrorManager.__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">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/manager.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.__init__" title="Link 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">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/manager.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context_or_interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/manager.py#L21-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error" title="Link 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">handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context_or_interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/manager.py#L21-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error" title="Link to this definition">¶</a></dt> <dd><p>Handle a Discord exception.</p> <p>Iterate through available handlers by registration order, and choose the first one capable of handling the error as determined by <cite>should_handle_error</cite>; there is no priority system.</p> @@ -530,7 +530,7 @@ the error as determined by <cite>should_handle_error</cite>; there is no priorit <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler"> -<span class="sig-name descname"><span class="pre">register_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/manager.py#L39-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">register_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/manager.py#L39-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler" title="Link to this definition">¶</a></dt> <dd><p>Register a command error handler.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -648,7 +648,7 @@ the error as determined by <cite>should_handle_error</cite>; there is no priorit </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.error_handling.commands.manager.html b/main/output/pydis_core.utils.error_handling.commands.manager.html index 5e4a07ce..c09b4f06 100644 --- a/main/output/pydis_core.utils.error_handling.commands.manager.html +++ b/main/output/pydis_core.utils.error_handling.commands.manager.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="caching" href="pydis_core.utils.caching.html" /><link rel="prev" title="abc" href="pydis_core.utils.error_handling.commands.abc.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>manager - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>manager - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,17 +467,17 @@ <span id="manager"></span><h1>manager<a class="headerlink" href="#module-pydis_core.utils.error_handling.commands.manager" title="Link to this heading">¶</a></h1> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.manager.CommandErrorManager"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommandErrorManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/manager.py#L13-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager" title="Link 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">CommandErrorManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/manager.py#L13-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>A class that registers error handlers and handles all command related errors.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__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">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/manager.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__" title="Link 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">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/manager.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context_or_interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/manager.py#L21-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error" title="Link 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">handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context_or_interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/manager.py#L21-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error" title="Link to this definition">¶</a></dt> <dd><p>Handle a Discord exception.</p> <p>Iterate through available handlers by registration order, and choose the first one capable of handling the error as determined by <cite>should_handle_error</cite>; there is no priority system.</p> @@ -490,7 +490,7 @@ the error as determined by <cite>should_handle_error</cite>; there is no priorit <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler"> -<span class="sig-name descname"><span class="pre">register_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/commands/manager.py#L39-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">register_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/commands/manager.py#L39-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler" title="Link to this definition">¶</a></dt> <dd><p>Register a command error handler.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -576,7 +576,7 @@ the error as determined by <cite>should_handle_error</cite>; there is no priorit </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.error_handling.html b/main/output/pydis_core.utils.error_handling.html index 528abace..ba183459 100644 --- a/main/output/pydis_core.utils.error_handling.html +++ b/main/output/pydis_core.utils.error_handling.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="commands package" href="pydis_core.utils.error_handling.commands.html" /><link rel="prev" title="Utils" href="pydis_core.utils.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>error_handling package - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>error_handling package - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,13 +467,13 @@ <span id="error-handling-package"></span><h1>error_handling package<a class="headerlink" href="#module-pydis_core.utils.error_handling" title="Link to this heading">¶</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.handle_forbidden_from_block"> -<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_forbidden_from_block</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/error_handling/__init__.py#L8-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.handle_forbidden_from_block" title="Link 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_forbidden_from_block</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/error_handling/__init__.py#L8-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.handle_forbidden_from_block" title="Link to this definition">¶</a></dt> <dd><p>Handles <code class="docutils literal notranslate"><span class="pre">discord.Forbidden</span></code> 90001 errors, or re-raises if <code class="docutils literal notranslate"><span class="pre">error</span></code> isn’t a 90001 error.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>error</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forbidden</span></code></a></span>) – The raised <code class="docutils literal notranslate"><span class="pre">discord.Forbidden</span></code> to check.</p></li> -<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to reply to and include in logs, if error is 90001 and message is provided.</p></li> +<li><p><strong>error</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forbidden</span></code></a></span>) – The raised <code class="docutils literal notranslate"><span class="pre">discord.Forbidden</span></code> to check.</p></li> +<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to reply to and include in logs, if error is 90001 and message is provided.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> @@ -586,7 +586,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.function.html b/main/output/pydis_core.utils.function.html index 78353c90..8464eed4 100644 --- a/main/output/pydis_core.utils.function.html +++ b/main/output/pydis_core.utils.function.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="interactions" href="pydis_core.utils.interactions.html" /><link rel="prev" title="cooldown" href="pydis_core.utils.cooldown.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>function - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>function - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,14 +468,14 @@ <p>Utils for manipulating functions.</p> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/function.py#L31-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.GlobalNameConflictError" title="Link 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">GlobalNameConflictError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/function.py#L31-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.GlobalNameConflictError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/function.py#L173-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.command_wraps" title="Link to this definition">¶</a></dt> +<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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/function.py#L173-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.command_wraps" title="Link 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="#pydis_core.utils.function.update_wrapper_globals" title="pydis_core.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"> @@ -499,7 +499,7 @@ with the wrapper replaced with the function <a class="reference internal" href=" <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.function.get_arg_value"> -<span class="sig-name descname"><span class="pre">get_arg_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arguments</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/function.py#L35-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_arg_value" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">get_arg_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arguments</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/function.py#L35-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_arg_value" title="Link to this definition">¶</a></dt> <dd><p>Return a value from <cite>arguments</cite> based on a name or position.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -522,7 +522,7 @@ with the wrapper replaced with the function <a class="reference internal" href=" <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.function.get_arg_value_wrapper"> -<span class="sig-name descname"><span class="pre">get_arg_value_wrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">decorator_func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/function.py#L68-L92"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_arg_value_wrapper" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">get_arg_value_wrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">decorator_func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/function.py#L68-L92"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_arg_value_wrapper" title="Link to this definition">¶</a></dt> <dd><p>Call <cite>decorator_func</cite> with the value of the arg at the given name/position.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -544,7 +544,7 @@ parameter names to argument values of the function it’s decorating.</p></li> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.function.get_bound_args"> -<span class="sig-name descname"><span class="pre">get_bound_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/function.py#L94-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_bound_args" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">get_bound_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/function.py#L94-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_bound_args" title="Link to this definition">¶</a></dt> <dd><p>Bind <cite>args</cite> and <cite>kwargs</cite> to <cite>func</cite> and return a mapping of parameter names to argument values.</p> <p>Default parameter values are also set.</p> <dl class="field-list simple"> @@ -566,7 +566,7 @@ parameter names to argument values of the function it’s decorating.</p></li> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/function.py#L114-L171"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.update_wrapper_globals" title="Link to this definition">¶</a></dt> +<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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/function.py#L114-L171"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.update_wrapper_globals" title="Link 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 @@ -669,7 +669,7 @@ changes won’t be reflected in the new function’s globals.</p> </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.html b/main/output/pydis_core.utils.html index cf240c31..ed69c455 100644 --- a/main/output/pydis_core.utils.html +++ b/main/output/pydis_core.utils.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="error_handling package" href="pydis_core.utils.error_handling.html" /><link rel="prev" title="Exts" href="pydis_core.exts.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>Utils - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>Utils - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,7 +468,7 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/__init__.py#L28-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.apply_monkey_patches" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/__init__.py#L28-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.apply_monkey_patches" title="Link to this definition">¶</a></dt> <dd><p>Applies all common monkey patches for our bots.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -476,7 +476,7 @@ </dd> </dl> <dl> -<dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.5.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.5.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 +<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.6.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.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names that will act as top-level groups rather than being aliases of the command’s group.</p> <p>It’s stored as an attribute also named <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code></p> </dd> @@ -487,7 +487,7 @@ 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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.unqualify" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.unqualify" title="Link to this definition">¶</a></dt> <dd><p>Return an unqualified name given a qualified module/package <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -805,7 +805,7 @@ that will act as top-level groups rather than being aliases of the command’s g </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.interactions.html b/main/output/pydis_core.utils.interactions.html index f62080ba..5a5d907a 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="lock" href="pydis_core.utils.lock.html" /><link rel="prev" title="function" href="pydis_core.utils.function.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>interactions - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>interactions - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,8 +467,8 @@ <span id="interactions"></span><h1>interactions<a class="headerlink" href="#module-pydis_core.utils.interactions" title="Link to this heading">¶</a></h1> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L111-L137"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton" title="Link 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.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Button</span></code></a></p> +<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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L111-L137"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton" title="Link 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.6.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="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="pydis_core.utils.interactions.ViewWithUserAndRoleCheck"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.interactions.ViewWithUserAndRoleCheck</span></code></a> for a view that implements basic checks.</p> @@ -482,12 +482,12 @@ </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L125-L133"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton.__init__" title="Link 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">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L125-L133"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L134-L137"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton.callback" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L134-L137"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton.callback" title="Link 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> @@ -500,8 +500,8 @@ <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L50-L109"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="Link 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.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">View</span></code></a></p> +<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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L50-L109"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="Link 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.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">View</span></code></a></p> <p>A view that allows only allows the specified users, or users with the specified roles, to interact with it.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -510,23 +510,23 @@ <li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of role ids that are allowed to interact with the view.</p></li> <li><p><strong>timeout</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – Timeout in seconds from last interaction with the UI before no longer accepting input. If <code class="docutils literal notranslate"><span class="pre">None</span></code> then there is no timeout.</p></li> -<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to remove the view from on timeout. This can also be set with +<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to remove the view from on timeout. This can also be set with <code class="docutils literal notranslate"><span class="pre">view.message</span> <span class="pre">=</span> <span class="pre">await</span> <span class="pre">ctx.send(</span> <span class="pre">...</span> <span class="pre">)`</span></code> , or similar, after the view is instantiated.</p></li> </ul> </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L63-L75"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__init__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L63-L75"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L76-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L76-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check" title="Link 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> -<dd class="field-odd"><p><strong>interaction</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.Interaction" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interaction</span></code></a></span>) – The interaction that occurred.</p> +<dd class="field-odd"><p><strong>interaction</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.Interaction" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interaction</span></code></a></span>) – The interaction that occurred.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> @@ -536,7 +536,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L105-L109"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L105-L109"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout" title="Link 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> @@ -547,7 +547,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop"> -<span class="sig-name descname"><span class="pre">stop</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L99-L104"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">stop</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L99-L104"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop" title="Link to this definition">¶</a></dt> <dd><p>Stop listening for interactions, and 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> @@ -560,12 +560,12 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.user_has_access"> -<span class="sig-name descname"><span class="pre">user_has_access</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</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">allowed_users</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">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/interactions.py#L12-L30"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.user_has_access" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">user_has_access</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</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">allowed_users</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">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/interactions.py#L12-L30"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.user_has_access" title="Link to this definition">¶</a></dt> <dd><p>Return whether the user is in the allowed_users list, or has a role from allowed_roles.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>user</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a> | <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The user to check</p></li> +<li><p><strong>user</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a> | <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The user to check</p></li> <li><p><strong>allowed_users</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of user ids that are allowed access</p></li> <li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of role ids that are allowed access</p></li> </ul> @@ -658,7 +658,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.lock.html b/main/output/pydis_core.utils.lock.html index df7adea8..04919a36 100644 --- a/main/output/pydis_core.utils.lock.html +++ b/main/output/pydis_core.utils.lock.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="logging" href="pydis_core.utils.logging.html" /><link rel="prev" title="interactions" href="pydis_core.utils.interactions.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>lock - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>lock - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,12 +467,12 @@ <span id="lock"></span><h1>lock<a class="headerlink" href="#module-pydis_core.utils.lock" title="Link to this heading">¶</a></h1> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.lock.LockedResourceError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LockedResourceError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError" title="Link 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">LockedResourceError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></a></p> <p>Exception raised when an operation is attempted on a locked resource.</p> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.lock.LockedResourceError.type"> -<span class="sig-name descname"><span class="pre">type</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.type" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">type</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.type" title="Link to this definition">¶</a></dt> <dd><p>Name of the locked resource’s type</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -483,7 +483,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.lock.LockedResourceError.id"> -<span class="sig-name descname"><span class="pre">id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.id" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.id" title="Link to this definition">¶</a></dt> <dd><p>ID of the locked resource</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -494,38 +494,38 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.LockedResourceError.__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">resource_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L31-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.__init__" title="Link 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">resource_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L31-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SharedEvent</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L41-L68"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent" title="Link 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">SharedEvent</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L41-L68"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>Context manager managing an internal event exposed through the wait coro.</p> <p>While any code is executing in this context manager, the underlying event will not be set; when all of the holders finish the event will be set.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent.__enter__"> -<span class="sig-name descname"><span class="pre">__enter__</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L54-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__enter__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__enter__</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L54-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__enter__" title="Link to this definition">¶</a></dt> <dd><p>Increment the count of the active holders and clear the internal event.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent.__exit__"> -<span class="sig-name descname"><span class="pre">__exit__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_exc_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_exc_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_exc_tb</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L59-L64"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__exit__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__exit__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_exc_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_exc_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_exc_tb</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L59-L64"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__exit__" title="Link to this definition">¶</a></dt> <dd><p>Decrement the count of the active holders; if 0 is reached set the internal event.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent.__init__"> -<span class="sig-name descname"><span class="pre">__init__</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L49-L53"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__init__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__init__</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L49-L53"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent.wait"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L65-L68"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.wait" title="Link 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</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L65-L68"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.wait" title="Link to this definition">¶</a></dt> <dd><p>Wait for all active holders to exit.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -538,7 +538,7 @@ when all of the holders finish the event will be set.</p> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.lock.lock"> -<span class="sig-name descname"><span class="pre">lock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</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_error</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">wait</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L70-L137"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.lock" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">lock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</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_error</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">wait</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L70-L137"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.lock" title="Link to this definition">¶</a></dt> <dd><p>Turn the decorated coroutine function into a mutually exclusive operation on a <cite>resource_id</cite>.</p> <p>If decorating a command, this decorator must go before (below) the <cite>command</cite> decorator.</p> <dl class="field-list simple"> @@ -565,7 +565,7 @@ and return None.</p></li> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.lock.lock_arg"> -<span class="sig-name descname"><span class="pre">lock_arg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</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></em>, <em class="sig-param"><span class="n"><span class="pre">raise_error</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">wait</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/lock.py#L139-L157"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.lock_arg" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">lock_arg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</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></em>, <em class="sig-param"><span class="n"><span class="pre">raise_error</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">wait</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/lock.py#L139-L157"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.lock_arg" title="Link to this definition">¶</a></dt> <dd><p>Apply the <cite>lock</cite> decorator using the value of the arg at the given name/position as the ID.</p> <p>See <cite>lock</cite> docs for more information.</p> <dl class="field-list simple"> @@ -662,7 +662,7 @@ and return None.</p></li> </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.logging.html b/main/output/pydis_core.utils.logging.html index ad027a59..086464cc 100644 --- a/main/output/pydis_core.utils.logging.html +++ b/main/output/pydis_core.utils.logging.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="members" href="pydis_core.utils.members.html" /><link rel="prev" title="lock" href="pydis_core.utils.lock.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>logging - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>logging - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,12 +468,12 @@ <p>Common logging related functions.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/logging.py#L20-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.CustomLogger" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/logging.py#L20-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.CustomLogger" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.13)"><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.13)"><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="#pydis_core.utils.logging.CustomLogger.trace" title="pydis_core.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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/logging.py#L23-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.CustomLogger.trace" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/logging.py#L23-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.CustomLogger.trace" title="Link to this definition">¶</a></dt> <dd><p>Log the given message with the severity <code class="docutils literal notranslate"><span class="pre">"TRACE"</span></code>.</p> <p>To pass exception information, use the keyword argument exc_info with a true value:</p> <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">"Houston, we have an </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"interesting problem"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> @@ -497,7 +497,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/logging.py#L41-L52"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.get_logger" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/logging.py#L41-L52"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.get_logger" title="Link to this definition">¶</a></dt> <dd><p>Utility to make mypy recognise that logger is of type <a class="reference internal" href="#pydis_core.utils.logging.CustomLogger" title="pydis_core.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> @@ -514,7 +514,7 @@ <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.utils.logging.log_format"> -<span class="sig-name descname"><span class="pre">log_format</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/logging.py#L12"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.log_format" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">log_format</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/logging.py#L12"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.log_format" title="Link to this definition">¶</a></dt> <dd><p>A <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Formatter" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Formatter</span></code></a> that can be used to standardise logging across all projects using pydis_core.</p> <dl class="field-list simple"> </dl> @@ -595,7 +595,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.members.html b/main/output/pydis_core.utils.members.html index 391fe96d..2641fb74 100644 --- a/main/output/pydis_core.utils.members.html +++ b/main/output/pydis_core.utils.members.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="messages" href="pydis_core.utils.messages.html" /><link rel="prev" title="logging" href="pydis_core.utils.logging.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>members - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>members - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -465,33 +465,33 @@ <article role="main" id="furo-main-content"> <section id="module-pydis_core.utils.members"> <span id="members"></span><h1>members<a class="headerlink" href="#module-pydis_core.utils.members" title="Link to this heading">¶</a></h1> -<p>Useful helper functions for interactin with <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> objects.</p> +<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.6.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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/members.py#L12-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.get_or_fetch_member" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/members.py#L12-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.get_or_fetch_member" title="Link to this definition">¶</a></dt> <dd><p>Attempt to get a member from cache; on failure fetch from the API.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.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.13)"><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 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.6.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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> to indicate the member could not be found.</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/members.py#L33-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.handle_role_change" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/members.py#L33-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.handle_role_change" title="Link to this definition">¶</a></dt> <dd><p>Await the given <code class="docutils literal notranslate"><span class="pre">coro</span></code> with <code class="docutils literal notranslate"><span class="pre">role</span></code> as the sole argument.</p> <p>Handle errors that we expect to be raised from -<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.5.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.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p> +<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.6.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.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>member</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The member that is being modified for logging purposes.</p></li> -<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><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.5.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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>]</span>) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.5.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.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> -<li><p><strong>role</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a></span>) – The role to be passed to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</p></li> +<li><p><strong>member</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The member that is being modified for logging purposes.</p></li> +<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><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.6.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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>]</span>) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.6.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.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> +<li><p><strong>role</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a></span>) – The role to be passed to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> @@ -571,7 +571,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.messages.html b/main/output/pydis_core.utils.messages.html index 44446288..8dd47f6b 100644 --- a/main/output/pydis_core.utils.messages.html +++ b/main/output/pydis_core.utils.messages.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="pagination" href="pydis_core.utils.pagination.html" /><link rel="prev" title="members" href="pydis_core.utils.members.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>messages - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>messages - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,7 +467,7 @@ <span id="messages"></span><h1>messages<a class="headerlink" href="#module-pydis_core.utils.messages" title="Link to this heading">¶</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.messages.reaction_check"> -<span class="sig-name descname"><span class="pre">reaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</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">message_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_emoji</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><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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/messages.py#L11-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.messages.reaction_check" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">reaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</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">message_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_emoji</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><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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/messages.py#L11-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.messages.reaction_check" title="Link to this definition">¶</a></dt> <dd><p>Check if a reaction’s emoji and author are allowed and the message is <cite>message_id</cite>.</p> <p>If the user is not allowed, remove the reaction. Ignore reactions made by the bot. If <cite>allow_mods</cite> is True, allow users with moderator roles even if they’re not in <cite>allowed_users</cite>.</p> @@ -548,7 +548,7 @@ If <cite>allow_mods</cite> is True, allow users with moderator roles even if the </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.pagination.html b/main/output/pydis_core.utils.pagination.html index f9b65111..9aad6605 100644 --- a/main/output/pydis_core.utils.pagination.html +++ b/main/output/pydis_core.utils.pagination.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="paste_service" href="pydis_core.utils.paste_service.html" /><link rel="prev" title="messages" href="pydis_core.utils.messages.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>pagination - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>pagination - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,15 +467,15 @@ <span id="pagination"></span><h1>pagination<a class="headerlink" href="#module-pydis_core.utils.pagination" title="Link to this heading">¶</a></h1> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.EmptyPaginatorEmbedError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.EmptyPaginatorEmbedError" title="Link 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">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.EmptyPaginatorEmbedError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when attempting to paginate with empty contents.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><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">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Paginator" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Paginator</span></code></a></p> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><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">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator" title="Link to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Paginator" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Paginator</span></code></a></p> <p>A class that aids in paginating code blocks for Discord messages.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -491,14 +491,14 @@ </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.__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">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.__init__" title="Link 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">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.__init__" title="Link to this definition">¶</a></dt> <dd><p>This function overrides the Paginator.__init__ from inside discord.ext.commands.</p> <p>It overrides in order to allow us to configure the maximum number of lines per page.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.add_line"> -<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.add_line" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.add_line" title="Link to this definition">¶</a></dt> <dd><p>Adds a line to the current page.</p> <p>If a line on a page exceeds <cite>max_size</cite> characters, then <cite>max_size</cite> will go up to <cite>scale_to_size</cite> for a single line before creating a new page for the overflow words. If it @@ -526,7 +526,7 @@ page at a reasonable size.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.paginate"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</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">prefix</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">suffix</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">max_lines</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</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="n"><span class="pre">restrict_to_user</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</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">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="n"><span class="pre">exception_on_empty_embed</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">reply</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">allowed_roles</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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.paginate" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</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">prefix</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">suffix</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">max_lines</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</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="n"><span class="pre">restrict_to_user</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</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">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="n"><span class="pre">exception_on_empty_embed</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">reply</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">allowed_roles</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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.paginate" title="Link to this definition">¶</a></dt> <dd><p>Use a paginator and set of reactions to provide pagination over a set of lines.</p> <p>The reactions are used to switch page, or to finish with pagination.</p> <p>When used, this will send a message using <cite>ctx.send()</cite> and apply a set of reactions to it. These reactions may @@ -539,15 +539,15 @@ to any user with a moderation role.</p> <dd class="field-odd"><ul class="simple"> <li><p><strong>pagination_emojis</strong> (<a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis" title="pydis_core.utils.pagination.PaginationEmojis"><em>PaginationEmojis</em></a>) – The emojis used to navigate pages.</p></li> <li><p><strong>lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em>) – A list of lines to be added to the paginated content.</p></li> -<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.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the pagination is needed.</p></li> -<li><p><strong>embed</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Embed" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Embed</span></code></a>) – The embed that holds the content, it serves as the page.</p></li> +<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.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the pagination is needed.</p></li> +<li><p><strong>embed</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Embed" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Embed</span></code></a>) – The embed that holds the content, it serves as the page.</p></li> <li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> <li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> <li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> <li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> <li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> <li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether an empty line should be added to each provided line.</p></li> -<li><p><strong>restrict_to_user</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.User</span></code></a>) – The user to whom interaction with the pages should be restricted.</p></li> +<li><p><strong>restrict_to_user</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.User</span></code></a>) – The user to whom interaction with the pages should be restricted.</p></li> <li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The timeout after which users cannot change pages anymore.</p></li> <li><p><strong>footer_text</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Text to be added as a footer for each page.</p></li> <li><p><strong>url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The url to be set for the pagination embed.</p></li> @@ -557,7 +557,7 @@ to any user with a moderation role.</p> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> <p>Example: @@ -570,7 +570,7 @@ to any user with a moderation role.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis" title="Link 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">PaginationEmojis</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>The emojis that will be used for pagination.</p> <dl class="py attribute"> @@ -599,7 +599,7 @@ to any user with a moderation role.</p> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__"> -<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PaginationEmojis'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis:93876414274256',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'delete':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'<:trashcan:637136429717389331>',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'first':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏮',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'last':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏭',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'left':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⬅',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'right':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'➡',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PaginationEmojis',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PaginationEmojis'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis:94648214926912',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'delete':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'<:trashcan:637136429717389331>',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'first':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏮',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'last':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏭',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'left':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⬅',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'right':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'➡',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PaginationEmojis',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> <dd><p>The core schema of the model.</p> </dd></dl> @@ -662,13 +662,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__"> -<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055614e535ad0,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"left":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28d797f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1efbdd90,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"last":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28dd2170,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1efbde80,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"right":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28d797b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1efbde30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"delete":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed29160eb0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1efbded0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"first":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28df47f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1efbdde0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">5,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x00005615013ab640,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"first":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90deb2f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d15e290,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"left":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90d7c230,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d15e240,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"last":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90dccd30,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d15e330,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"delete":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a91108eb0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d15e380,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"right":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90d7c1f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d15e2e0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">5,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaSerializer</cite> used to dump instances of the model.</p> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__"> -<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PaginationEmojis",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"first",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"first",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed260d8070,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"first",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed260044b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28df47f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1efbdde0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed2790a460,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"left",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"left",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed246c3570,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"left",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1e515770,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28d797f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1efbdd90,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed2790a460,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"right",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"right",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed1e515eb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"right",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1e516b30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28d797b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1efbde30,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed2790a460,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"last",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"last",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed1e515670,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"last",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1e517f30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28dd2170,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1efbde80,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed2790a460,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"delete",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"delete",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed1e515a70,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"delete",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed1e515870,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed29160eb0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed1efbded0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed2790a460,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PaginationEmojis",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055614e535ad0,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fed2790a460,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PaginationEmojis",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"first",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"first",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8cacfcb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"first",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d9c7db0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90deb2f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8d15e290,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8f51a3e0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"left",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"left",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8d9c6ef0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"left",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8dc886b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90d7c230,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8d15e240,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8f51a3e0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"right",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"right",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8dac46f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"right",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8c02a430,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90d7c1f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8d15e2e0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8f51a3e0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"last",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"last",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8c0299f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"last",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8c02bf70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90dccd30,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8d15e330,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8f51a3e0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"delete",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"delete",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8c029ab0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"delete",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8c029ff0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a91108eb0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a8d15e380,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8f51a3e0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PaginationEmojis",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x00005615013ab640,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f4a8f51a3e0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaValidator</cite> used to validate instances of the model.</p> </dd></dl> @@ -783,7 +783,7 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.paste_service.html b/main/output/pydis_core.utils.paste_service.html index 5d89484c..396f9cce 100644 --- a/main/output/pydis_core.utils.paste_service.html +++ b/main/output/pydis_core.utils.paste_service.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="regex" href="pydis_core.utils.regex.html" /><link rel="prev" title="pagination" href="pydis_core.utils.pagination.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>paste_service - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>paste_service - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -467,13 +467,13 @@ <span id="paste-service"></span><h1>paste_service<a class="headerlink" href="#module-pydis_core.utils.paste_service" title="Link to this heading">¶</a></h1> <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.MAX_PASTE_SIZE"> -<span class="sig-name descname"><span class="pre">MAX_PASTE_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">524288</span></em><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/paste_service.py#L13"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.MAX_PASTE_SIZE" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">MAX_PASTE_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">524288</span></em><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/paste_service.py#L13"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.MAX_PASTE_SIZE" title="Link to this definition">¶</a></dt> <dd><p>The maximum allows size of a paste, in bytes.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteFile</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/paste_service.py#L33-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile" title="Link 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">PasteFile</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/paste_service.py#L33-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>A file to be pasted to the paste service.</p> <dl class="field-list simple"> @@ -511,7 +511,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__"> -<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PasteFile'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile:93876415636928',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'content':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'lexer':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'python',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'name':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PasteFile',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PasteFile'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile:94648216813376',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'content':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'lexer':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'python',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'name':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PasteFile',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> <dd><p>The core schema of the model.</p> </dd></dl> @@ -574,13 +574,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__"> -<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055614e6825c0,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"lexer":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed2899d7b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed2870d4b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"content":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28cd60f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"name":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed29b56ea0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed29b530c0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">3,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PasteFile",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000561501577f40,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"name":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a91740e80,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a9173d0a0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"content":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a909c8df0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"lexer":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90697f70,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a90410c70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">3,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PasteFile",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaSerializer</cite> used to dump instances of the model.</p> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_validator__"> -<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PasteFile",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"content",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"content",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed246c2e70,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"content",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed246c2e30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed28cd60f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"name",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"name",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed246c2ef0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"name",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed246c2eb0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed29b56ea0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed29b530c0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed2790a570,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"lexer",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"lexer",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed246c2f30,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"lexer",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed246c2f70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed2899d7b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fed2870d4b0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fed2790a570,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PasteFile",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055614e6825c0,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fed2790a570,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PasteFile",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_validator__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PasteFile",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"content",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"content",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8d571b30,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"content",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d571af0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a909c8df0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"name",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"name",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8d571bb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"name",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d571b70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a91740e80,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a9173d0a0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8f519ce0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"lexer",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"lexer",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8d571bf0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"lexer",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d571c30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a90697f70,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007f4a90410c70,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007f4a8f519ce0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PasteFile",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000561501577f40,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f4a8f519ce0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PasteFile",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_validator__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaValidator</cite> used to validate instances of the model.</p> </dd></dl> @@ -600,7 +600,7 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteResponse</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/paste_service.py#L20-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse" title="Link 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">PasteResponse</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/paste_service.py#L20-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>A successful response from the paste service.</p> <dl class="field-list simple"> @@ -637,7 +637,7 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__"> -<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PasteResponse'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse:93876415851600',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'link':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'removal':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PasteResponse',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PasteResponse'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse:94648216481904',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'link':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'removal':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PasteResponse',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> <dd><p>The core schema of the model.</p> </dd></dl> @@ -700,13 +700,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__"> -<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055614e6b6c50,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"removal":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed1e4bcb30,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"link":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed29aac2a0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">2,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PasteResponse",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000561501527070,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"removal":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a8d3f25f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"link":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a91696280,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">2,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PasteResponse",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaSerializer</cite> used to dump instances of the model.</p> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__"> -<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PasteResponse",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"link",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"link",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed246c1bf0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"link",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed246c1bb0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed29aac2a0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"removal",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"removal",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fed246c1c70,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"removal",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fed246c1c30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fed1e4bcb30,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PasteResponse",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055614e6b6c50,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fed2790a570,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PasteResponse",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PasteResponse",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"link",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"link",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8d5708b0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"link",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d570870,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a91696280,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"removal",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"removal",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007f4a8d570930,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"removal",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007f4a8d5708f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007f4a8d3f25f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PasteResponse",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000561501527070,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007f4a8f519ce0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PasteResponse",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaValidator</cite> used to validate instances of the model.</p> </dd></dl> @@ -726,28 +726,28 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteTooLongError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteTooLongError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/paste_service.py#L56-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteTooLongError" title="Link 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">PasteTooLongError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/paste_service.py#L56-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteTooLongError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when content is too large to upload to the paste service.</p> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteUnsupportedLexerError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteUnsupportedLexerError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/paste_service.py#L52-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteUnsupportedLexerError" title="Link 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">PasteUnsupportedLexerError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/paste_service.py#L52-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteUnsupportedLexerError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when an unsupported lexer is used.</p> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteUploadError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteUploadError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/paste_service.py#L48-L50"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteUploadError" title="Link 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">PasteUploadError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/paste_service.py#L48-L50"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteUploadError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when an error is encountered uploading to the paste service.</p> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.send_to_paste_service"> -<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">send_to_paste_service</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">files</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">paste_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'https://paste.pythondiscord.com'</span></span></em>, <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">524288</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/paste_service.py#L70-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.send_to_paste_service" title="Link 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">send_to_paste_service</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">files</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">paste_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'https://paste.pythondiscord.com'</span></span></em>, <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">524288</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/paste_service.py#L70-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.send_to_paste_service" title="Link to this definition">¶</a></dt> <dd><p>Upload some contents to the paste service.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -890,7 +890,7 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.regex.html b/main/output/pydis_core.utils.regex.html index 3f1b5494..e6916293 100644 --- a/main/output/pydis_core.utils.regex.html +++ b/main/output/pydis_core.utils.regex.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="scheduling" href="pydis_core.utils.scheduling.html" /><link rel="prev" title="paste_service" href="pydis_core.utils.paste_service.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>regex - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>regex - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,7 +468,7 @@ <p>Common regular expressions.</p> <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.DISCORD_INVITE" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.DISCORD_INVITE" title="Link to this definition">¶</a></dt> <dd><p>Regex for Discord server invites.</p> <div class="admonition warning"> <p class="admonition-title">Warning</p> @@ -482,7 +482,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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.FORMATTED_CODE_REGEX" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.FORMATTED_CODE_REGEX" title="Link to this definition">¶</a></dt> <dd><p>Regex for formatted code, using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -490,7 +490,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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.RAW_CODE_REGEX" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.RAW_CODE_REGEX" title="Link to this definition">¶</a></dt> <dd><p>Regex for raw code, <em>not</em> using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -568,7 +568,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/output/pydis_core.utils.scheduling.html b/main/output/pydis_core.utils.scheduling.html index 9c3fc5bb..6c94c586 100644 --- a/main/output/pydis_core.utils.scheduling.html +++ b/main/output/pydis_core.utils.scheduling.html @@ -6,13 +6,13 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="async_stats" href="pydis_core.async_stats.html" /><link rel="prev" title="regex" href="pydis_core.utils.regex.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>scheduling - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> + <title>scheduling - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -468,7 +468,7 @@ <p>Generic python scheduler.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L19-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L19-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><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="#pydis_core.utils.scheduling.Scheduler" title="pydis_core.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 @@ -482,7 +482,7 @@ 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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L49-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.__contains__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L49-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.__contains__" title="Link to this definition">¶</a></dt> <dd><p>Return <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.13)"><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> @@ -499,7 +499,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L37-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.__init__" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L37-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.__init__" title="Link to this definition">¶</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#pydis_core.utils.scheduling.Scheduler" title="pydis_core.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> @@ -510,7 +510,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L132-L149"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.cancel" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L132-L149"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.cancel" title="Link to this definition">¶</a></dt> <dd><p>Unschedule the task identified by <code class="docutils literal notranslate"><span class="pre">task_id</span></code>. Log a warning if the task doesn’t exist.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -524,7 +524,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L150-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.cancel_all" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L150-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.cancel_all" title="Link to this definition">¶</a></dt> <dd><p>Unschedule all known tasks.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -535,7 +535,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L61-L88"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L61-L88"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule" title="Link to this definition">¶</a></dt> <dd><p>Schedule the execution of a <code class="docutils literal notranslate"><span class="pre">coroutine</span></code>.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -554,7 +554,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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L89-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule_at" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L89-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule_at" title="Link to this definition">¶</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed at the given <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p> <p>If <code class="docutils literal notranslate"><span class="pre">time</span></code> is timezone aware, then use that timezone to calculate now() when subtracting. If <code class="docutils literal notranslate"><span class="pre">time</span></code> is naïve, then use UTC.</p> @@ -577,7 +577,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="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L113-L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule_later" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L113-L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule_later" title="Link to this definition">¶</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed after <code class="docutils literal notranslate"><span class="pre">delay</span></code> seconds.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -599,7 +599,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.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/cbe2bae7bd4826c804fd690cc695a7e4a6ba47d7/pydis_core/utils/scheduling.py#L221-L252"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.create_task" title="Link 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/16835478af6b842d776d634e53aab8ee31bd350c/pydis_core/utils/scheduling.py#L221-L252"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.create_task" title="Link to this definition">¶</a></dt> <dd><p>Wrapper for creating an <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.13)"><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> @@ -701,7 +701,7 @@ otherwise the running loop is used.</p> </aside> </div> -</div><script src="../_static/documentation_options.js?v=07a056c7"></script> +</div><script src="../_static/documentation_options.js?v=31a70c35"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/py-modindex.html b/main/py-modindex.html index 6bea256b..922fc72e 100644 --- a/main/py-modindex.html +++ b/main/py-modindex.html @@ -4,13 +4,13 @@ <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --><title>Python Module Index - Pydis Core Latest (11.5.1)</title> -<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --><title>Python Module Index - Pydis Core Latest (11.6.0)</title> +<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> @@ -168,7 +168,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -195,7 +195,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -645,7 +645,7 @@ </aside> </div> -</div><script src="_static/documentation_options.js?v=07a056c7"></script> +</div><script src="_static/documentation_options.js?v=31a70c35"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/search.html b/main/search.html index 9acf5fc2..a8938fb3 100644 --- a/main/search.html +++ b/main/search.html @@ -7,12 +7,12 @@ <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <meta name="robots" content="noindex" /> -<title>Search - Pydis Core Latest (11.5.1)</title><link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> +<title>Search - Pydis Core Latest (11.6.0)</title><link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</span> </a><form class="sidebar-search-container" method="get" action="#" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -500,7 +500,7 @@ </aside> </div> -</div><script src="_static/documentation_options.js?v=07a056c7"></script> +</div><script src="_static/documentation_options.js?v=31a70c35"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> diff --git a/main/searchindex.js b/main/searchindex.js index 299ac646..d58a7abd 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Bot Core Project Documentation": [[2, null]], "Changelog": [[0, null]], "Extras": [[2, "extras"]], "Exts": [[5, null]], "Local Development & Testing": [[1, null]], "Modules:": [[2, null]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Pydis Core": [[3, null]], "Reference": [[2, "reference"]], "Submodules": [[3, "submodules"], [7, "submodules"], [14, "submodules"]], "Subpackages": [[3, "subpackages"], [7, "subpackages"], [13, "subpackages"]], "Utils": [[7, null]], "abc": [[15, null]], "async_stats": [[4, null]], "caching": [[8, null]], "channel": [[9, null]], "checks": [[10, null]], "commands": [[11, null]], "commands package": [[14, null]], "cooldown": [[12, null]], "error_handling package": [[13, null]], "function": [[17, null]], "interactions": [[18, null]], "lock": [[19, null]], "logging": [[20, null]], "manager": [[16, null]], "members": [[21, null]], "messages": [[22, null]], "pagination": [[23, null]], "paste_service": [[24, null]], "regex": [[25, null]], "scheduling": [[26, null]], "site_api": [[6, null]]}, "docnames": ["changelog", "development", "index", "output/pydis_core", "output/pydis_core.async_stats", "output/pydis_core.exts", "output/pydis_core.site_api", "output/pydis_core.utils", "output/pydis_core.utils.caching", "output/pydis_core.utils.channel", "output/pydis_core.utils.checks", "output/pydis_core.utils.commands", "output/pydis_core.utils.cooldown", "output/pydis_core.utils.error_handling", "output/pydis_core.utils.error_handling.commands", "output/pydis_core.utils.error_handling.commands.abc", "output/pydis_core.utils.error_handling.commands.manager", "output/pydis_core.utils.function", "output/pydis_core.utils.interactions", "output/pydis_core.utils.lock", "output/pydis_core.utils.logging", "output/pydis_core.utils.members", "output/pydis_core.utils.messages", "output/pydis_core.utils.pagination", "output/pydis_core.utils.paste_service", "output/pydis_core.utils.regex", "output/pydis_core.utils.scheduling"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2}, "filenames": ["changelog.rst", "development.rst", "index.rst", "output/pydis_core.rst", "output/pydis_core.async_stats.rst", "output/pydis_core.exts.rst", "output/pydis_core.site_api.rst", "output/pydis_core.utils.rst", "output/pydis_core.utils.caching.rst", "output/pydis_core.utils.channel.rst", "output/pydis_core.utils.checks.rst", "output/pydis_core.utils.commands.rst", "output/pydis_core.utils.cooldown.rst", "output/pydis_core.utils.error_handling.rst", "output/pydis_core.utils.error_handling.commands.rst", "output/pydis_core.utils.error_handling.commands.abc.rst", "output/pydis_core.utils.error_handling.commands.manager.rst", "output/pydis_core.utils.function.rst", "output/pydis_core.utils.interactions.rst", "output/pydis_core.utils.lock.rst", "output/pydis_core.utils.logging.rst", "output/pydis_core.utils.members.rst", "output/pydis_core.utils.messages.rst", "output/pydis_core.utils.pagination.rst", "output/pydis_core.utils.paste_service.rst", "output/pydis_core.utils.regex.rst", "output/pydis_core.utils.scheduling.rst"], "indexentries": {"__call__() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.__call__", false]], "__class_vars__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__class_vars__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__class_vars__", false]], "__class_vars__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__class_vars__", false]], "__class_vars__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__class_vars__", false]], "__contains__() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.__contains__", false]], "__enter__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__enter__", false]], "__exit__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__exit__", false]], "__init__() (apiclient method)": [[6, "pydis_core.site_api.APIClient.__init__", false]], "__init__() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.__init__", false]], "__init__() (asyncstatsclient method)": [[4, "pydis_core.async_stats.AsyncStatsClient.__init__", false]], "__init__() (botbase method)": [[3, "pydis_core.BotBase.__init__", false]], "__init__() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.__init__", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__", false]], "__init__() (commandoncooldown method)": [[12, "pydis_core.utils.cooldown.CommandOnCooldown.__init__", false]], "__init__() (contextcheckfailure method)": [[10, "pydis_core.utils.checks.ContextCheckFailure.__init__", false]], "__init__() (deletemessagebutton method)": [[18, "pydis_core.utils.interactions.DeleteMessageButton.__init__", false]], "__init__() (linepaginator method)": [[3, "pydis_core.LinePaginator.__init__", false], [23, "pydis_core.utils.pagination.LinePaginator.__init__", false]], "__init__() (lockedresourceerror method)": [[19, "pydis_core.utils.lock.LockedResourceError.__init__", false]], "__init__() (responsecodeerror method)": [[6, "pydis_core.site_api.ResponseCodeError.__init__", false]], "__init__() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.__init__", false]], "__init__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__init__", false]], "__init__() (startuperror method)": [[3, "pydis_core.StartupError.__init__", false]], "__init__() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__init__", false]], "__private_attributes__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__private_attributes__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__private_attributes__", false]], "__private_attributes__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__private_attributes__", false]], "__private_attributes__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__private_attributes__", false]], "__pydantic_complete__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_complete__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_complete__", false]], "__pydantic_complete__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_complete__", false]], "__pydantic_complete__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_complete__", false]], "__pydantic_computed_fields__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_computed_fields__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_computed_fields__", false]], "__pydantic_computed_fields__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_computed_fields__", false]], "__pydantic_computed_fields__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_computed_fields__", false]], "__pydantic_core_schema__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_core_schema__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__", false]], "__pydantic_core_schema__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__", false]], "__pydantic_core_schema__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__", false]], "__pydantic_custom_init__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_custom_init__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_custom_init__", false]], "__pydantic_custom_init__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_custom_init__", false]], "__pydantic_custom_init__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_custom_init__", false]], "__pydantic_decorators__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_decorators__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_decorators__", false]], "__pydantic_decorators__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_decorators__", false]], "__pydantic_decorators__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_decorators__", false]], "__pydantic_extra__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_extra__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_extra__", false]], "__pydantic_extra__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_extra__", false]], "__pydantic_extra__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_extra__", false]], "__pydantic_fields__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_fields__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields__", false]], "__pydantic_fields__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_fields__", false]], "__pydantic_fields__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_fields__", false]], "__pydantic_fields_set__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_fields_set__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields_set__", false]], "__pydantic_fields_set__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_fields_set__", false]], "__pydantic_fields_set__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_fields_set__", false]], "__pydantic_generic_metadata__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_generic_metadata__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_generic_metadata__", false]], "__pydantic_generic_metadata__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_generic_metadata__", false]], "__pydantic_generic_metadata__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_generic_metadata__", false]], "__pydantic_parent_namespace__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_parent_namespace__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_parent_namespace__", false]], "__pydantic_parent_namespace__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_parent_namespace__", false]], "__pydantic_parent_namespace__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_parent_namespace__", false]], "__pydantic_post_init__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_post_init__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_post_init__", false]], "__pydantic_post_init__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_post_init__", false]], "__pydantic_post_init__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_post_init__", false]], "__pydantic_private__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_private__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_private__", false]], "__pydantic_private__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_private__", false]], "__pydantic_private__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_private__", false]], "__pydantic_serializer__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_serializer__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__", false]], "__pydantic_serializer__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__", false]], "__pydantic_serializer__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__", false]], "__pydantic_validator__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_validator__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__", false]], "__pydantic_validator__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_validator__", false]], "__pydantic_validator__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__", false]], "__signature__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__signature__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__signature__", false]], "__signature__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__signature__", false]], "__signature__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__signature__", false]], "__str__() (responsecodeerror method)": [[6, "pydis_core.site_api.ResponseCodeError.__str__", false]], "abstractcommanderrorhandler (class in pydis_core.utils.error_handling.commands)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler", false]], "abstractcommanderrorhandler (class in pydis_core.utils.error_handling.commands.abc)": [[15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler", false]], "add_cog() (botbase method)": [[3, "pydis_core.BotBase.add_cog", false]], "add_command() (botbase method)": [[3, "pydis_core.BotBase.add_command", false]], "add_line() (linepaginator method)": [[3, "pydis_core.LinePaginator.add_line", false], [23, "pydis_core.utils.pagination.LinePaginator.add_line", false]], "all_extensions (botbase attribute)": [[3, "pydis_core.BotBase.all_extensions", false]], "api_client (botbase attribute)": [[3, "pydis_core.BotBase.api_client", false]], "apiclient (class in pydis_core.site_api)": [[6, "pydis_core.site_api.APIClient", false]], "apply_monkey_patches() (in module pydis_core.utils)": [[7, "pydis_core.utils.apply_monkey_patches", false]], "asynccache (class in pydis_core.utils.caching)": [[8, "pydis_core.utils.caching.AsyncCache", false]], "asyncstatsclient (class in pydis_core.async_stats)": [[4, "pydis_core.async_stats.AsyncStatsClient", false]], "block_duplicate_invocations() (in module pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.block_duplicate_invocations", false]], "botbase (class in pydis_core)": [[3, "pydis_core.BotBase", false]], "call_without_cooldown() (commandoncooldown method)": [[12, "pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown", false]], "callback() (deletemessagebutton method)": [[18, "pydis_core.utils.interactions.DeleteMessageButton.callback", false]], "cancel() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.cancel", false]], "cancel_all() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.cancel_all", false]], "clean_text_or_reply() (in module pydis_core.utils.commands)": [[11, "pydis_core.utils.commands.clean_text_or_reply", false]], "clear() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.clear", false]], "clear() (botbase method)": [[3, "pydis_core.BotBase.clear", false]], "close() (apiclient method)": [[6, "pydis_core.site_api.APIClient.close", false]], "close() (botbase method)": [[3, "pydis_core.BotBase.close", false]], "command_wraps() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.command_wraps", false]], "commanderrormanager (class in pydis_core.utils.error_handling.commands)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager", false]], "commanderrormanager (class in pydis_core.utils.error_handling.commands.manager)": [[16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager", false]], "commandoncooldown": [[12, "pydis_core.utils.cooldown.CommandOnCooldown", false]], "contextcheckfailure": [[10, "pydis_core.utils.checks.ContextCheckFailure", false]], "cooldown_with_role_bypass() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.cooldown_with_role_bypass", false]], "create_socket() (asyncstatsclient method)": [[4, "pydis_core.async_stats.AsyncStatsClient.create_socket", false]], "create_task() (in module pydis_core.utils.scheduling)": [[26, "pydis_core.utils.scheduling.create_task", false]], "customlogger (class in pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.CustomLogger", false]], "delete() (apiclient method)": [[6, "pydis_core.site_api.APIClient.delete", false]], "deletemessagebutton (class in pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.DeleteMessageButton", false]], "discord_invite (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.DISCORD_INVITE", false]], "emptypaginatorembederror": [[3, "pydis_core.EmptyPaginatorEmbedError", false], [23, "pydis_core.utils.pagination.EmptyPaginatorEmbedError", false]], "formatted_code_regex (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.FORMATTED_CODE_REGEX", false]], "get() (apiclient method)": [[6, "pydis_core.site_api.APIClient.get", false]], "get_arg_value() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_arg_value", false]], "get_arg_value_wrapper() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_arg_value_wrapper", false]], "get_bound_args() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_bound_args", false]], "get_logger() (in module pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.get_logger", false]], "get_or_fetch_channel() (in module pydis_core.utils.channel)": [[9, "pydis_core.utils.channel.get_or_fetch_channel", false]], "get_or_fetch_member() (in module pydis_core.utils.members)": [[21, "pydis_core.utils.members.get_or_fetch_member", false]], "globalnameconflicterror": [[17, "pydis_core.utils.function.GlobalNameConflictError", false]], "guild_id (botbase attribute)": [[3, "pydis_core.BotBase.guild_id", false]], "handle_app_command_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error", false]], "handle_error() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error", false]], "handle_forbidden_from_block() (in module pydis_core.utils.error_handling)": [[13, "pydis_core.utils.error_handling.handle_forbidden_from_block", false]], "handle_role_change() (in module pydis_core.utils.members)": [[21, "pydis_core.utils.members.handle_role_change", false]], "handle_text_command_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error", false]], "has_any_role_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.has_any_role_check", false]], "has_no_roles_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.has_no_roles_check", false]], "http_session (botbase attribute)": [[3, "pydis_core.BotBase.http_session", false]], "id (lockedresourceerror attribute)": [[19, "pydis_core.utils.lock.LockedResourceError.id", false]], "in_whitelist_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.in_whitelist_check", false]], "interaction_check() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check", false]], "inwhitelistcheckfailure": [[10, "pydis_core.utils.checks.InWhitelistCheckFailure", false]], "is_in_category() (in module pydis_core.utils.channel)": [[9, "pydis_core.utils.channel.is_in_category", false]], "linepaginator (class in pydis_core)": [[3, "pydis_core.LinePaginator", false]], "linepaginator (class in pydis_core.utils.pagination)": [[23, "pydis_core.utils.pagination.LinePaginator", false]], "load_extensions() (botbase method)": [[3, "pydis_core.BotBase.load_extensions", false]], "lock() (in module pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.lock", false]], "lock_arg() (in module pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.lock_arg", false]], "lockedresourceerror": [[19, "pydis_core.utils.lock.LockedResourceError", false]], "log_format (in module pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.log_format", false]], "log_to_dev_log() (botbase method)": [[3, "pydis_core.BotBase.log_to_dev_log", false]], "max_paste_size (in module pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.MAX_PASTE_SIZE", false]], "maybe_raise_for_status() (apiclient static method)": [[6, "pydis_core.site_api.APIClient.maybe_raise_for_status", false]], "model_config (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.model_config", false], [23, "pydis_core.utils.pagination.PaginationEmojis.model_config", false]], "model_config (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.model_config", false]], "model_config (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.model_config", false]], "module": [[3, "module-pydis_core", false], [4, "module-pydis_core.async_stats", false], [5, "module-pydis_core.exts", false], [6, "module-pydis_core.site_api", false], [7, "module-pydis_core.utils", false], [8, "module-pydis_core.utils.caching", false], [9, "module-pydis_core.utils.channel", false], [10, "module-pydis_core.utils.checks", false], [11, "module-pydis_core.utils.commands", false], [12, "module-pydis_core.utils.cooldown", false], [13, "module-pydis_core.utils.error_handling", false], [14, "module-pydis_core.utils.error_handling.commands", false], [15, "module-pydis_core.utils.error_handling.commands.abc", false], [16, "module-pydis_core.utils.error_handling.commands.manager", false], [17, "module-pydis_core.utils.function", false], [18, "module-pydis_core.utils.interactions", false], [19, "module-pydis_core.utils.lock", false], [20, "module-pydis_core.utils.logging", false], [21, "module-pydis_core.utils.members", false], [22, "module-pydis_core.utils.messages", false], [23, "module-pydis_core.utils.pagination", false], [24, "module-pydis_core.utils.paste_service", false], [25, "module-pydis_core.utils.regex", false], [26, "module-pydis_core.utils.scheduling", false]], "on_guild_available() (botbase method)": [[3, "pydis_core.BotBase.on_guild_available", false]], "on_guild_unavailable() (botbase method)": [[3, "pydis_core.BotBase.on_guild_unavailable", false]], "on_timeout() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout", false]], "p (in module pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.P", false]], "paginate() (linepaginator class method)": [[3, "pydis_core.LinePaginator.paginate", false], [23, "pydis_core.utils.pagination.LinePaginator.paginate", false]], "paginationemojis (class in pydis_core)": [[3, "pydis_core.PaginationEmojis", false]], "paginationemojis (class in pydis_core.utils.pagination)": [[23, "pydis_core.utils.pagination.PaginationEmojis", false]], "pastefile (class in pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.PasteFile", false]], "pasteresponse (class in pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.PasteResponse", false]], "pastetoolongerror": [[24, "pydis_core.utils.paste_service.PasteTooLongError", false]], "pasteunsupportedlexererror": [[24, "pydis_core.utils.paste_service.PasteUnsupportedLexerError", false]], "pasteuploaderror": [[24, "pydis_core.utils.paste_service.PasteUploadError", false]], "patch() (apiclient method)": [[6, "pydis_core.site_api.APIClient.patch", false]], "ping_services() (botbase method)": [[3, "pydis_core.BotBase.ping_services", false]], "post() (apiclient method)": [[6, "pydis_core.site_api.APIClient.post", false]], "process_commands() (botbase method)": [[3, "pydis_core.BotBase.process_commands", false]], "put() (apiclient method)": [[6, "pydis_core.site_api.APIClient.put", false]], "pydis_core": [[3, "module-pydis_core", false]], "pydis_core.async_stats": [[4, "module-pydis_core.async_stats", false]], "pydis_core.exts": [[5, "module-pydis_core.exts", false]], "pydis_core.site_api": [[6, "module-pydis_core.site_api", false]], "pydis_core.utils": [[7, "module-pydis_core.utils", false]], "pydis_core.utils.caching": [[8, "module-pydis_core.utils.caching", false]], "pydis_core.utils.channel": [[9, "module-pydis_core.utils.channel", false]], "pydis_core.utils.checks": [[10, "module-pydis_core.utils.checks", false]], "pydis_core.utils.commands": [[11, "module-pydis_core.utils.commands", false]], "pydis_core.utils.cooldown": [[12, "module-pydis_core.utils.cooldown", false]], "pydis_core.utils.error_handling": [[13, "module-pydis_core.utils.error_handling", false]], "pydis_core.utils.error_handling.commands": [[14, "module-pydis_core.utils.error_handling.commands", false]], "pydis_core.utils.error_handling.commands.abc": [[15, "module-pydis_core.utils.error_handling.commands.abc", false]], "pydis_core.utils.error_handling.commands.manager": [[16, "module-pydis_core.utils.error_handling.commands.manager", false]], "pydis_core.utils.function": [[17, "module-pydis_core.utils.function", false]], "pydis_core.utils.interactions": [[18, "module-pydis_core.utils.interactions", false]], "pydis_core.utils.lock": [[19, "module-pydis_core.utils.lock", false]], "pydis_core.utils.logging": [[20, "module-pydis_core.utils.logging", false]], "pydis_core.utils.members": [[21, "module-pydis_core.utils.members", false]], "pydis_core.utils.messages": [[22, "module-pydis_core.utils.messages", false]], "pydis_core.utils.pagination": [[23, "module-pydis_core.utils.pagination", false]], "pydis_core.utils.paste_service": [[24, "module-pydis_core.utils.paste_service", false]], "pydis_core.utils.regex": [[25, "module-pydis_core.utils.regex", false]], "pydis_core.utils.scheduling": [[26, "module-pydis_core.utils.scheduling", false]], "r (class in pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.R", false]], "raw_code_regex (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.RAW_CODE_REGEX", false]], "reaction_check() (in module pydis_core.utils.messages)": [[22, "pydis_core.utils.messages.reaction_check", false]], "redis_session (botbase attribute)": [[3, "pydis_core.BotBase.redis_session", false]], "register_command_error_manager() (botbase method)": [[3, "pydis_core.BotBase.register_command_error_manager", false]], "register_handler() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler", false]], "remove_command() (botbase method)": [[3, "pydis_core.BotBase.remove_command", false]], "request() (apiclient method)": [[6, "pydis_core.site_api.APIClient.request", false]], "responsecodeerror": [[6, "pydis_core.site_api.ResponseCodeError", false]], "schedule() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule", false]], "schedule_at() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule_at", false]], "schedule_later() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule_later", false]], "scheduler (class in pydis_core.utils.scheduling)": [[26, "pydis_core.utils.scheduling.Scheduler", false]], "send_to_paste_service() (in module pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.send_to_paste_service", false]], "setup_hook() (botbase method)": [[3, "pydis_core.BotBase.setup_hook", false]], "sharedevent (class in pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.SharedEvent", false]], "should_handle_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error", false]], "startuperror": [[3, "pydis_core.StartupError", false]], "stats (botbase attribute)": [[3, "pydis_core.BotBase.stats", false]], "statsd_url (botbase attribute)": [[3, "pydis_core.BotBase.statsd_url", false]], "stop() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop", false]], "trace() (customlogger method)": [[20, "pydis_core.utils.logging.CustomLogger.trace", false]], "type (lockedresourceerror attribute)": [[19, "pydis_core.utils.lock.LockedResourceError.type", false]], "unqualify() (in module pydis_core.utils)": [[7, "pydis_core.utils.unqualify", false]], "update_wrapper_globals() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.update_wrapper_globals", false]], "user_has_access() (in module pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.user_has_access", false]], "viewwithuserandrolecheck (class in pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck", false]], "wait() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.wait", false]], "wait_until_guild_available() (botbase method)": [[3, "pydis_core.BotBase.wait_until_guild_available", false]]}, "objects": {"": [[3, 0, 0, "-", "pydis_core"]], "pydis_core": [[3, 1, 1, "", "BotBase"], [3, 4, 1, "", "EmptyPaginatorEmbedError"], [3, 1, 1, "", "LinePaginator"], [3, 1, 1, "", "PaginationEmojis"], [3, 4, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "pydis_core.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 3, 1, "", "all_extensions"], [3, 3, 1, "", "api_client"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [3, 3, 1, "", "guild_id"], [3, 3, 1, "", "http_session"], [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, "", "process_commands"], [3, 3, 1, "", "redis_session"], [3, 2, 1, "", "register_command_error_manager"], [3, 2, 1, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 3, 1, "", "stats"], [3, 3, 1, "", "statsd_url"], [3, 2, 1, "", "wait_until_guild_available"]], "pydis_core.LinePaginator": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_line"], [3, 2, 1, "", "paginate"]], "pydis_core.PaginationEmojis": [[3, 3, 1, "", "__class_vars__"], [3, 3, 1, "", "__private_attributes__"], [3, 3, 1, "", "__pydantic_complete__"], [3, 3, 1, "", "__pydantic_computed_fields__"], [3, 3, 1, "", "__pydantic_core_schema__"], [3, 3, 1, "", "__pydantic_custom_init__"], [3, 3, 1, "", "__pydantic_decorators__"], [3, 3, 1, "", "__pydantic_extra__"], [3, 3, 1, "", "__pydantic_fields__"], [3, 3, 1, "", "__pydantic_fields_set__"], [3, 3, 1, "", "__pydantic_generic_metadata__"], [3, 3, 1, "", "__pydantic_parent_namespace__"], [3, 3, 1, "", "__pydantic_post_init__"], [3, 3, 1, "", "__pydantic_private__"], [3, 3, 1, "", "__pydantic_serializer__"], [3, 3, 1, "", "__pydantic_validator__"], [3, 3, 1, "", "__signature__"], [3, 3, 1, "", "model_config"]], "pydis_core.StartupError": [[3, 2, 1, "", "__init__"]], "pydis_core.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "pydis_core.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "pydis_core.site_api": [[6, 1, 1, "", "APIClient"], [6, 4, 1, "", "ResponseCodeError"]], "pydis_core.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"]], "pydis_core.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "pydis_core.utils": [[7, 5, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "checks"], [11, 0, 0, "-", "commands"], [12, 0, 0, "-", "cooldown"], [13, 0, 0, "-", "error_handling"], [17, 0, 0, "-", "function"], [18, 0, 0, "-", "interactions"], [19, 0, 0, "-", "lock"], [20, 0, 0, "-", "logging"], [21, 0, 0, "-", "members"], [22, 0, 0, "-", "messages"], [23, 0, 0, "-", "pagination"], [24, 0, 0, "-", "paste_service"], [25, 0, 0, "-", "regex"], [26, 0, 0, "-", "scheduling"], [7, 5, 1, "", "unqualify"]], "pydis_core.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "pydis_core.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "pydis_core.utils.channel": [[9, 5, 1, "", "get_or_fetch_channel"], [9, 5, 1, "", "is_in_category"]], "pydis_core.utils.checks": [[10, 4, 1, "", "ContextCheckFailure"], [10, 4, 1, "", "InWhitelistCheckFailure"], [10, 5, 1, "", "cooldown_with_role_bypass"], [10, 5, 1, "", "has_any_role_check"], [10, 5, 1, "", "has_no_roles_check"], [10, 5, 1, "", "in_whitelist_check"]], "pydis_core.utils.checks.ContextCheckFailure": [[10, 2, 1, "", "__init__"]], "pydis_core.utils.commands": [[11, 5, 1, "", "clean_text_or_reply"]], "pydis_core.utils.cooldown": [[12, 4, 1, "", "CommandOnCooldown"], [12, 6, 1, "", "P"], [12, 1, 1, "", "R"], [12, 5, 1, "", "block_duplicate_invocations"]], "pydis_core.utils.cooldown.CommandOnCooldown": [[12, 2, 1, "", "__init__"], [12, 2, 1, "", "call_without_cooldown"]], "pydis_core.utils.error_handling": [[14, 0, 0, "-", "commands"], [13, 5, 1, "", "handle_forbidden_from_block"]], "pydis_core.utils.error_handling.commands": [[14, 1, 1, "", "AbstractCommandErrorHandler"], [14, 1, 1, "", "CommandErrorManager"], [15, 0, 0, "-", "abc"], [16, 0, 0, "-", "manager"]], "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler": [[14, 2, 1, "", "handle_app_command_error"], [14, 2, 1, "", "handle_text_command_error"], [14, 2, 1, "", "should_handle_error"]], "pydis_core.utils.error_handling.commands.CommandErrorManager": [[14, 2, 1, "", "__init__"], [14, 2, 1, "", "handle_error"], [14, 2, 1, "", "register_handler"]], "pydis_core.utils.error_handling.commands.abc": [[15, 1, 1, "", "AbstractCommandErrorHandler"]], "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler": [[15, 2, 1, "", "handle_app_command_error"], [15, 2, 1, "", "handle_text_command_error"], [15, 2, 1, "", "should_handle_error"]], "pydis_core.utils.error_handling.commands.manager": [[16, 1, 1, "", "CommandErrorManager"]], "pydis_core.utils.error_handling.commands.manager.CommandErrorManager": [[16, 2, 1, "", "__init__"], [16, 2, 1, "", "handle_error"], [16, 2, 1, "", "register_handler"]], "pydis_core.utils.function": [[17, 4, 1, "", "GlobalNameConflictError"], [17, 5, 1, "", "command_wraps"], [17, 5, 1, "", "get_arg_value"], [17, 5, 1, "", "get_arg_value_wrapper"], [17, 5, 1, "", "get_bound_args"], [17, 5, 1, "", "update_wrapper_globals"]], "pydis_core.utils.interactions": [[18, 1, 1, "", "DeleteMessageButton"], [18, 1, 1, "", "ViewWithUserAndRoleCheck"], [18, 5, 1, "", "user_has_access"]], "pydis_core.utils.interactions.DeleteMessageButton": [[18, 2, 1, "", "__init__"], [18, 2, 1, "", "callback"]], "pydis_core.utils.interactions.ViewWithUserAndRoleCheck": [[18, 2, 1, "", "__init__"], [18, 2, 1, "", "interaction_check"], [18, 2, 1, "", "on_timeout"], [18, 2, 1, "", "stop"]], "pydis_core.utils.lock": [[19, 4, 1, "", "LockedResourceError"], [19, 1, 1, "", "SharedEvent"], [19, 5, 1, "", "lock"], [19, 5, 1, "", "lock_arg"]], "pydis_core.utils.lock.LockedResourceError": [[19, 2, 1, "", "__init__"], [19, 3, 1, "", "id"], [19, 3, 1, "", "type"]], "pydis_core.utils.lock.SharedEvent": [[19, 2, 1, "", "__enter__"], [19, 2, 1, "", "__exit__"], [19, 2, 1, "", "__init__"], [19, 2, 1, "", "wait"]], "pydis_core.utils.logging": [[20, 1, 1, "", "CustomLogger"], [20, 5, 1, "", "get_logger"], [20, 6, 1, "", "log_format"]], "pydis_core.utils.logging.CustomLogger": [[20, 2, 1, "", "trace"]], "pydis_core.utils.members": [[21, 5, 1, "", "get_or_fetch_member"], [21, 5, 1, "", "handle_role_change"]], "pydis_core.utils.messages": [[22, 5, 1, "", "reaction_check"]], "pydis_core.utils.pagination": [[23, 4, 1, "", "EmptyPaginatorEmbedError"], [23, 1, 1, "", "LinePaginator"], [23, 1, 1, "", "PaginationEmojis"]], "pydis_core.utils.pagination.LinePaginator": [[23, 2, 1, "", "__init__"], [23, 2, 1, "", "add_line"], [23, 2, 1, "", "paginate"]], "pydis_core.utils.pagination.PaginationEmojis": [[23, 3, 1, "", "__class_vars__"], [23, 3, 1, "", "__private_attributes__"], [23, 3, 1, "", "__pydantic_complete__"], [23, 3, 1, "", "__pydantic_computed_fields__"], [23, 3, 1, "", "__pydantic_core_schema__"], [23, 3, 1, "", "__pydantic_custom_init__"], [23, 3, 1, "", "__pydantic_decorators__"], [23, 3, 1, "", "__pydantic_extra__"], [23, 3, 1, "", "__pydantic_fields__"], [23, 3, 1, "", "__pydantic_fields_set__"], [23, 3, 1, "", "__pydantic_generic_metadata__"], [23, 3, 1, "", "__pydantic_parent_namespace__"], [23, 3, 1, "", "__pydantic_post_init__"], [23, 3, 1, "", "__pydantic_private__"], [23, 3, 1, "", "__pydantic_serializer__"], [23, 3, 1, "", "__pydantic_validator__"], [23, 3, 1, "", "__signature__"], [23, 3, 1, "", "model_config"]], "pydis_core.utils.paste_service": [[24, 6, 1, "", "MAX_PASTE_SIZE"], [24, 1, 1, "", "PasteFile"], [24, 1, 1, "", "PasteResponse"], [24, 4, 1, "", "PasteTooLongError"], [24, 4, 1, "", "PasteUnsupportedLexerError"], [24, 4, 1, "", "PasteUploadError"], [24, 5, 1, "", "send_to_paste_service"]], "pydis_core.utils.paste_service.PasteFile": [[24, 3, 1, "", "__class_vars__"], [24, 3, 1, "", "__private_attributes__"], [24, 3, 1, "", "__pydantic_complete__"], [24, 3, 1, "", "__pydantic_computed_fields__"], [24, 3, 1, "", "__pydantic_core_schema__"], [24, 3, 1, "", "__pydantic_custom_init__"], [24, 3, 1, "", "__pydantic_decorators__"], [24, 3, 1, "", "__pydantic_extra__"], [24, 3, 1, "", "__pydantic_fields__"], [24, 3, 1, "", "__pydantic_fields_set__"], [24, 3, 1, "", "__pydantic_generic_metadata__"], [24, 3, 1, "", "__pydantic_parent_namespace__"], [24, 3, 1, "", "__pydantic_post_init__"], [24, 3, 1, "", "__pydantic_private__"], [24, 3, 1, "", "__pydantic_serializer__"], [24, 3, 1, "", "__pydantic_validator__"], [24, 3, 1, "", "__signature__"], [24, 3, 1, "", "model_config"]], "pydis_core.utils.paste_service.PasteResponse": [[24, 3, 1, "", "__class_vars__"], [24, 3, 1, "", "__private_attributes__"], [24, 3, 1, "", "__pydantic_complete__"], [24, 3, 1, "", "__pydantic_computed_fields__"], [24, 3, 1, "", "__pydantic_core_schema__"], [24, 3, 1, "", "__pydantic_custom_init__"], [24, 3, 1, "", "__pydantic_decorators__"], [24, 3, 1, "", "__pydantic_extra__"], [24, 3, 1, "", "__pydantic_fields__"], [24, 3, 1, "", "__pydantic_fields_set__"], [24, 3, 1, "", "__pydantic_generic_metadata__"], [24, 3, 1, "", "__pydantic_parent_namespace__"], [24, 3, 1, "", "__pydantic_post_init__"], [24, 3, 1, "", "__pydantic_private__"], [24, 3, 1, "", "__pydantic_serializer__"], [24, 3, 1, "", "__pydantic_validator__"], [24, 3, 1, "", "__signature__"], [24, 3, 1, "", "model_config"]], "pydis_core.utils.regex": [[25, 6, 1, "", "DISCORD_INVITE"], [25, 6, 1, "", "FORMATTED_CODE_REGEX"], [25, 6, 1, "", "RAW_CODE_REGEX"]], "pydis_core.utils.scheduling": [[26, 1, 1, "", "Scheduler"], [26, 5, 1, "", "create_task"]], "pydis_core.utils.scheduling.Scheduler": [[26, 2, 1, "", "__contains__"], [26, 2, 1, "", "__init__"], [26, 2, 1, "", "cancel"], [26, 2, 1, "", "cancel_all"], [26, 2, 1, "", "schedule"], [26, 2, 1, "", "schedule_at"], [26, 2, 1, "", "schedule_later"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"], "6": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:exception", "5": "py:function", "6": "py:data"}, "terms": {"": [0, 1, 3, 7, 8, 10, 11, 12, 17, 18, 19, 20, 22, 23, 24, 25, 26], "0": [0, 8, 10, 18, 19, 20], "0a0": 0, "0eb3d26": 0, "0x000055614e535ad0": 23, "0x000055614e541d40": 3, "0x000055614e6825c0": 24, "0x000055614e6b6c50": 24, "0x00007fed1e33d770": 3, "0x00007fed1e33d870": 3, "0x00007fed1e33d970": 3, "0x00007fed1e33dcb0": 3, "0x00007fed1e33e1b0": 3, "0x00007fed1e33f2b0": 3, "0x00007fed1e33ff70": 3, "0x00007fed1e4bcb30": 24, "0x00007fed1e515670": 23, "0x00007fed1e515770": 23, "0x00007fed1e515870": 23, "0x00007fed1e515a70": 23, "0x00007fed1e515eb0": 23, "0x00007fed1e516b30": 23, "0x00007fed1e517f30": 23, "0x00007fed1ec0cf80": 3, "0x00007fed1ec0cfd0": 3, "0x00007fed1ec0d020": 3, "0x00007fed1ec0d070": 3, "0x00007fed1ec0d0c0": 3, "0x00007fed1efbdd90": 23, "0x00007fed1efbdde0": 23, "0x00007fed1efbde30": 23, "0x00007fed1efbde80": 23, "0x00007fed1efbded0": 23, "0x00007fed244f2670": 3, "0x00007fed244f3270": 3, "0x00007fed246c1bb0": 24, "0x00007fed246c1bf0": 24, "0x00007fed246c1c30": 24, "0x00007fed246c1c70": 24, "0x00007fed246c2e30": 24, "0x00007fed246c2e70": 24, "0x00007fed246c2eb0": 24, "0x00007fed246c2ef0": 24, "0x00007fed246c2f30": 24, "0x00007fed246c2f70": 24, "0x00007fed246c3570": 23, "0x00007fed246fcbe0": 3, "0x00007fed260044b0": 23, "0x00007fed260d8070": [3, 23], "0x00007fed2790a460": 23, "0x00007fed2790a570": 24, "0x00007fed2870d4b0": 24, "0x00007fed2899d7b0": 24, "0x00007fed28cd60f0": 24, "0x00007fed28d797b0": [3, 23], "0x00007fed28d797f0": [3, 23], "0x00007fed28dd2170": [3, 23], "0x00007fed28df47f0": [3, 23], "0x00007fed29160eb0": [3, 23], "0x00007fed29aac2a0": 24, "0x00007fed29b530c0": 24, "0x00007fed29b56ea0": 24, "1": [0, 20], "10": 0, "101": 0, "103": 0, "104": 0, "106": 0, "107": 0, "108": 0, "10th": 0, "11": 0, "110": 0, "11th": 0, "12": 0, "124": 0, "125": 0, "128": 8, "138": 0, "13th": 0, "14th": 0, "15": 0, "151": 0, "157": 0, "158": 0, "162": 0, "169": 0, "16th": 0, "170": 0, "171": 0, "172": 0, "173": 0, "174": 0, "175": 0, "176": 0, "177": 0, "179": 0, "17th": 0, "180": 18, "181": 0, "182": 0, "183": 0, "184": 0, "185": 0, "187": 0, "188": 0, "189": 0, "18th": 0, "190": 0, "192": 0, "194": 0, "195": 0, "196": 0, "197": 0, "199": 0, "19th": 0, "2": [0, 3, 18, 24], "200": 0, "202": 0, "2021": 0, "2022": 0, "2023": 0, "2024": 0, "204": [0, 6], "205": 0, "206": 0, "207": 0, "208": 0, "209": 0, "20th": 0, "210": 0, "21st": 0, "22nd": 0, "23rd": 0, "244": 0, "24th": 0, "254": 0, "25th": 0, "269": 0, "26th": 0, "27th": 0, "282": 0, "28th": 0, "29": 0, "295": 0, "2nd": 0, "3": [0, 24], "30": 0, "300": [3, 23], "30th": 0, "32": 0, "34": 0, "35": 0, "37": 0, "39": 0, "3rd": 0, "4": 0, "4000": [3, 23], "403": 7, "42": 0, "4cbe8f5": 0, "5": [0, 3, 12, 23], "500": [3, 23], "524288": 24, "54": 0, "56": 0, "561": 0, "5a06fa5": 0, "5th": 0, "6": 0, "61": 0, "63": 0, "637136429717389331": [3, 23], "64": 0, "65": 0, "66": 0, "68": 0, "69": 0, "6th": 0, "7": 0, "72": 0, "75": 0, "78": 0, "79": 0, "8": 0, "8125": 4, "88": 0, "9": 0, "90001": [0, 13], "91": 0, "93": 0, "93876414274256": 23, "93876414324032": 3, "93876415636928": 24, "93876415851600": 24, "96": 0, "98": 0, "987235d": 0, "9th": 0, "A": [1, 3, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 18, 20, 23, 24, 26], "As": 0, "Be": 0, "For": 17, "If": [3, 6, 10, 12, 17, 18, 19, 22, 23, 26], "In": [3, 23], "It": [3, 7, 19, 23], "Not": 3, "On": 0, "That": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 17, 18, 20, 21, 23, 24, 26], "These": [3, 23], "To": [1, 3, 20], "_": 0, "__annotations__": 17, "__args__": [3, 23, 24], "__call__": [7, 8], "__class_vars__": [2, 3, 7, 23, 24], "__contains__": [7, 26], "__dict__": 17, "__doc__": 17, "__enter__": [7, 19], "__exit__": [7, 19], "__fields__": [3, 23, 24], "__get_pydantic_json_schema__": [3, 23, 24], "__global__": 17, "__init__": [0, 2, 3, 4, 6, 7, 8, 10, 12, 13, 14, 16, 18, 19, 23, 24, 26], "__module__": 17, "__name__": 17, "__origin__": [3, 23, 24], "__parameters__": [3, 23, 24], "__private_attributes__": [2, 3, 7, 23, 24], "__pydantic_complete__": [2, 3, 7, 23, 24], "__pydantic_computed_fields__": [2, 3, 7, 23, 24], "__pydantic_core_schema__": [2, 3, 7, 23, 24], "__pydantic_custom_init__": [2, 3, 7, 23, 24], "__pydantic_decorators__": [2, 3, 7, 23, 24], "__pydantic_extra__": [2, 3, 7, 23, 24], "__pydantic_fields__": [2, 3, 7, 23, 24], "__pydantic_fields_set__": [2, 3, 7, 23, 24], "__pydantic_generic_metadata__": [2, 3, 7, 23, 24], "__pydantic_parent_namespace__": [2, 3, 7, 23, 24], "__pydantic_post_init__": [2, 3, 7, 23, 24], "__pydantic_private__": [2, 3, 7, 23, 24], "__pydantic_serializer__": [2, 3, 7, 23, 24], "__pydantic_validator__": [2, 3, 7, 23, 24], "__qualname__": 17, "__root_validators__": [3, 23, 24], "__signature__": [2, 3, 7, 23, 24], "__str__": [3, 6], "__validators__": [3, 23, 24], "_decor": [3, 23, 24], "_exc_tb": 19, "_exc_typ": 19, "_exc_val": 19, "_gener": [3, 23, 24], "_guild_avail": 0, "_p": 17, "_r": 17, "_transport": 0, "abc": [0, 13, 14], "abl": 0, "about": [3, 12, 23, 24], "abstract": [0, 14, 15], "abstractcommanderrorhandl": [0, 7, 13, 14, 15], "abstracteventloop": [4, 26], "accept": [17, 18], "access": 18, "acquir": 19, "across": [0, 3, 20, 23], "act": 7, "action": 0, "activ": 19, "actual": 0, "ad": [0, 1, 3, 7, 18, 20, 23], "add": [0, 3, 10, 12, 23], "add_cog": [2, 3], "add_command": [2, 3], "add_lin": [2, 3, 7, 23], "add_rol": 21, "addit": 0, "after": [0, 3, 18, 23, 26], "again": 1, "aid": [3, 23], "aiodn": 0, "aiohttp": [0, 3, 6, 24], "alia": [3, 7, 12, 23, 24], "alias": [3, 7], "alias_pi": [3, 23, 24], "all": [0, 1, 3, 4, 7, 14, 16, 19, 20, 26], "all_command": 3, "all_extens": [2, 3], "allow": [0, 1, 3, 18, 22, 23, 24], "allow_mod": 22, "allowed_emoji": 22, "allowed_rol": [0, 1, 3, 18, 22, 23], "allowed_us": [0, 18, 22], "alpha": 0, "alreadi": [3, 23, 26], "also": [0, 3, 7, 17, 18, 19, 23], "alwai": 10, "among": 19, "amount": [3, 23], "an": [0, 1, 3, 4, 6, 7, 8, 9, 10, 14, 15, 17, 19, 20, 23, 24, 26], "ani": [3, 6, 10, 17, 19, 23, 24, 25, 26], "annot": [3, 17, 23, 24], "anymor": [3, 23], "anyth": [1, 24], "api": [0, 3, 6, 21], "api_cli": [0, 2, 3], "apicli": [0, 2, 3, 6], "app": [0, 3, 14, 15], "appear": 3, "append": [3, 23], "appli": [3, 7, 8, 10, 12, 19, 23, 24], "applic": 1, "apply_monkey_patch": [0, 2, 3, 7], "approach": 1, "april": 0, "ar": [0, 1, 3, 8, 17, 18, 22, 23, 24, 25], "arg": [3, 12, 17, 19, 20, 23, 24], "arg_offset": 8, "args_preprocessor": 12, "argument": [6, 7, 8, 11, 12, 17, 19, 20, 21], "around": 6, "assign": 17, "async": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 21, 23, 24], "async_rediscach": [0, 3], "async_stat": [2, 3], "asynccach": [3, 7, 8], "asyncio": [0, 4, 26], "asyncresolv": 0, "asyncstatscli": [2, 3, 4], "asyncstatsdcli": 0, "attach": 0, "attempt": [0, 3, 9, 19, 21, 23], "attr": 0, "attribut": [0, 3, 7, 17, 23, 24], "august": 0, "authent": 6, "author": [3, 10, 22, 23], "auto": 0, "auto_mod": 0, "autogener": 0, "automat": [0, 3, 23, 24], "avail": [0, 3, 14, 16, 19], "avoid": [0, 3, 23], "await": [0, 3, 12, 18, 19, 21, 23], "awar": [0, 26], "back": 0, "backslash": 0, "backtick": [3, 23], "bad": 0, "badargu": 11, "base": [0, 3, 4, 6, 8, 10, 12, 14, 15, 16, 17, 18, 19, 20, 23, 24, 26], "basemodel": [3, 23, 24], "basic": [0, 18], "becaus": [3, 17], "becom": [3, 19], "been": [0, 3], "befor": [0, 3, 10, 18, 19, 23, 26], "before_invok": 10, "behav": 17, "behavior": 10, "behaviour": [0, 3], "being": [0, 7, 10, 21], "belong": 3, "below": [1, 19], "best": [3, 23], "between": [0, 1, 17], "bind": [3, 17], "block": [0, 3, 12, 23, 25], "block_duplicate_invoc": [3, 7, 12], "bodi": 0, "boilerpl": 0, "bool": [3, 6, 9, 10, 12, 14, 15, 18, 19, 22, 23, 24, 26], "bot": [0, 1, 3, 7, 9, 22], "bot_token": 1, "botbas": [0, 2, 3], "both": [0, 1, 3, 24], "bound": [3, 23, 24], "boundari": [3, 23], "break": [0, 3, 17, 23], "broke": 0, "buckettyp": 10, "bug": 0, "build": [3, 23, 24], "bump": 0, "button": [0, 18], "buttonstyl": 18, "bypass": 10, "bypass_rol": 10, "byte": 24, "cach": [0, 3, 7, 9, 21], "cache_str": [3, 23, 24], "calcul": 26, "call": [0, 3, 12, 17, 26], "call_without_cooldown": [7, 12], "callabl": [8, 10, 12, 17, 19, 21], "callback": [7, 10, 18], "can": [0, 1, 3, 10, 18, 19, 20, 23, 26], "cancel": [7, 26], "cancel_al": [7, 26], "cannot": [0, 3, 19, 23], "capabl": [14, 16], "captur": [0, 17, 25], "carri": 18, "case": [0, 3, 23], "categori": [9, 10], "category_id": 9, "caus": [3, 7, 23], "certain": [0, 1], "chang": [0, 1, 3, 17, 23], "changelog": 2, "changeset": 0, "channel": [0, 3, 7, 10, 12], "channel_id": 9, "charact": [0, 3, 23], "chardet": 0, "check": [0, 3, 6, 7, 9, 12, 13, 18, 22, 26], "checkfailur": 10, "choos": [14, 16], "chunk": 0, "ci": 0, "cl": [3, 23, 24], "class": [0, 3, 4, 6, 8, 12, 14, 15, 16, 18, 19, 20, 23, 24, 26], "classmethod": [3, 23], "classvar": [3, 23, 24], "clean": [0, 11], "clean_text_or_repli": [3, 7, 11], "clear": [2, 3, 7, 8, 19], "click": 18, "client": [0, 3, 4], "clientrespons": 6, "clientsess": [3, 6, 24], "close": [0, 2, 3, 6, 26], "cloudflar": 7, "code": [0, 1, 3, 6, 19, 23, 25], "codepoint": [3, 23], "coerce_numbers_to_str": [3, 23, 24], "cog": [0, 3, 5], "collect": 10, "collis": 19, "com": [0, 24], "comma": 1, "command": [0, 1, 3, 7, 9, 10, 12, 13, 15, 16, 17, 19, 23], "command_wrap": [3, 7, 17], "commanderror": 12, "commanderrormanag": [0, 7, 13, 14, 16], "commandinvokeerror": 0, "commandoncooldown": [3, 7, 12], "commit": 0, "common": [0, 1, 3, 7, 20, 25], "commun": [3, 4], "complet": [3, 23, 24], "complianc": 0, "compos": 1, "comput": [3, 23, 24], "computed_field": [3, 23, 24], "computedfield": [3, 23, 24], "computedfieldinfo": [3, 23, 24], "concurr": 0, "config": [0, 3, 23, 24], "configdict": [3, 23, 24], "configur": [1, 3, 23, 24], "conflict": 17, "conform": [3, 23, 24], "connect": [0, 3, 4], "connector": 3, "constructor": [3, 6], "contain": [1, 3, 10, 18, 23, 24, 26], "content": [0, 3, 11, 23, 24], "context": [3, 10, 11, 14, 15, 19, 23], "context_or_interact": [14, 16], "contextcheckfailur": [3, 7, 10], "continu": [3, 23], "control": 0, "cooldown": [3, 7, 10], "cooldown_dur": 12, "cooldown_with_role_bypass": [3, 7, 10], "copi": [1, 17], "copy_default": [3, 23, 24], "core": [0, 1, 23, 24], "coreschema": [3, 23, 24], "coro": [19, 21, 26], "coroutin": [8, 19, 21, 26], "correct": [0, 1], "correspond": [3, 23, 24], "could": [0, 21], "count": 19, "cover": 0, "crash": 0, "creat": [0, 3, 4, 8, 12, 17, 23, 26], "create_datagram_endpoint": 4, "create_socket": [3, 4], "create_task": [3, 7, 26], "creation": 0, "criteria": 0, "ctx": [3, 10, 11, 18, 23], "current": [0, 3, 19, 23, 26], "custom": [0, 3, 8, 20, 23, 24], "custom_init": [3, 23, 24], "customlogg": [3, 7, 20], "cut": 0, "d": [1, 17], "dai": 0, "data": [3, 23, 24], "datetim": 26, "deal": 0, "decemb": 0, "declar": 0, "decor": [0, 3, 8, 10, 12, 17, 19, 23, 24], "decorator_func": 17, "decoratorinfo": [3, 23, 24], "decrement": 19, "default": [0, 1, 3, 10, 14, 16, 17, 23, 24], "defin": [3, 23, 24], "definit": [3, 23, 24], "delai": 26, "delet": [0, 3, 6, 8, 18, 23, 24], "deletemessagebutton": [0, 3, 7, 18], "depend": [0, 9], "deprec": 0, "describ": 10, "detail": 17, "detect": 0, "determin": [14, 15, 16], "dev": [1, 3], "develop": [0, 2, 3, 7], "dict": [3, 6, 17, 23, 24], "dictat": 0, "dictionari": [3, 23, 24], "did": 0, "directli": [0, 17], "directori": 1, "discord": [0, 1, 3, 5, 7, 9, 10, 11, 13, 14, 16, 17, 21, 23, 25], "discord_invit": [0, 3, 7, 25], "disnak": 0, "distinguish": 26, "django": 6, "dm": 10, "do": [0, 1, 9, 19], "doc": [0, 19], "docker": 1, "docstr": 0, "document": 0, "doe": [0, 17], "doesn": [3, 10, 26], "don": [0, 10, 26], "done": [3, 18, 23, 26], "drop": 0, "due": 0, "dummi": [0, 3], "dump": [3, 23, 24], "duplic": [0, 12], "durat": 10, "dure": [3, 23, 24], "dynam": 0, "e": [3, 23], "each": [0, 3, 23], "edg": 0, "edit": 3, "effort": [3, 23], "either": [0, 3], "els": 11, "elsewher": 26, "emb": [0, 3, 23], "emit": 3, "emoji": [0, 3, 22, 23], "empti": [3, 23], "emptypaginatorembederror": [2, 3, 7, 23], "enabl": [0, 1], "encount": 24, "end": [3, 23], "endpoint": 6, "ensur": [0, 3, 18, 25], "entir": [0, 3], "env": 1, "environ": [0, 1], "equival": 6, "error": [0, 3, 6, 7, 13, 14, 15, 16, 21, 24], "error_handl": [0, 3, 7], "etc": [1, 10], "evalu": 17, "even": 22, "event": [0, 3, 4, 19, 26], "event_loop": 26, "eventu": [3, 23, 24], "everi": [3, 23], "exact": 1, "exampl": [3, 23], "exc_info": 20, "exce": [3, 8, 23], "exceed": [3, 23], "except": [3, 6, 10, 12, 14, 16, 17, 19, 20, 23, 24, 26], "exception_on_empty_emb": [3, 23], "excess": [3, 23], "exclud": [3, 23, 24], "exclus": 19, "execut": [19, 26], "exist": [0, 1, 26], "exit": 19, "expect": 21, "expiri": 0, "explain": 0, "explicitli": [3, 23, 24], "expos": 19, "express": 25, "ext": [0, 2, 3, 7, 9, 10, 11, 23], "extend": 0, "extens": [0, 3], "extra": [0, 3, 6, 23, 24], "extra_behavior": [3, 23, 24], "extra_seri": [3, 23, 24], "extract": 0, "extras_valid": [3, 23, 24], "facilit": 0, "fail": [9, 10, 24], "fail_sil": 10, "failur": 21, "fakeredi": 0, "fals": [3, 10, 12, 19, 23, 24], "featur": [0, 1, 3], "februari": 0, "fetch": [9, 21], "few": 1, "field": [3, 23, 24], "field_seri": [3, 23, 24], "field_valid": [3, 23, 24], "fieldinfo": [3, 23, 24], "fifo": 8, "file": [0, 1, 24], "filter": [0, 3, 23, 24], "finish": [3, 19, 23], "first": [3, 14, 16, 23], "five": [3, 23], "fix": 0, "float": [10, 12, 18, 26], "folder": 1, "footer": [3, 23], "footer_text": [3, 23], "forbidden": [0, 9, 13], "format": [24, 25], "formatt": 20, "formatted_code_regex": [3, 7, 25], "forum": 0, "forwardref": 17, "found": [3, 17, 21, 26], "free": 1, "from": [0, 1, 3, 4, 6, 7, 9, 17, 18, 21, 23, 24, 26], "from_attribut": [3, 23, 24], "frozen": [3, 23, 24], "frozenset": [3, 17], "func": [17, 19], "function": [0, 3, 7, 8, 9, 12, 19, 20, 21, 23, 26], "functool": 17, "futur": [10, 26], "g": [3, 23], "gatewai": 3, "gener": [0, 3, 12, 23, 24, 26], "generalfieldsseri": [3, 23, 24], "generic_origin": [3, 23, 24], "get": [0, 3, 6, 9, 17, 21], "get_arg_valu": [3, 7, 17], "get_arg_value_wrapp": [3, 7, 17], "get_bound_arg": [3, 7, 17], "get_logg": [3, 7, 20], "get_or_fetch_channel": [0, 3, 7, 9], "get_or_fetch_memb": [0, 3, 7, 21], "git": 1, "github": 0, "give": 3, "given": [0, 3, 4, 7, 9, 11, 17, 19, 20, 21, 26], "global": 17, "globalnameconflicterror": [3, 7, 17], "go": [1, 3, 19, 23], "greater": 24, "groundwork": 1, "group": [7, 25], "guild": [0, 1, 3, 10, 21], "guild_available_but_cache_empti": 3, "guild_creat": 3, "guild_id": [1, 2, 3], "guildchannel": 9, "ha": [0, 3, 7, 10, 18, 23, 24], "handl": [0, 13, 14, 15, 16, 21, 26], "handle_app_command_error": [13, 14, 15], "handle_error": [13, 14, 16], "handle_forbidden_from_block": [3, 7, 13], "handle_role_chang": [0, 3, 7, 21], "handle_text_command_error": [13, 14, 15], "handler": [0, 3, 14, 15, 16], "happen": 3, "has_any_role_check": [3, 7, 10], "has_extra": [3, 23, 24], "has_no_roles_check": [3, 7, 10], "hashabl": [19, 26], "have": [0, 9, 10, 17, 20], "heavi": 7, "help": [0, 1], "helper": [0, 9, 12, 21], "hold": [3, 19, 23], "holder": 19, "hook": 0, "host": 4, "houston": 20, "how": [0, 8, 10, 17, 26], "howev": 1, "http": [0, 3, 6, 24, 25], "http_session": [2, 3, 24], "httpexcept": 9, "i": [0, 1, 3, 6, 7, 9, 10, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "icon": [3, 23], "icon_url": [3, 23], "id": [1, 3, 7, 9, 10, 18, 19, 23, 26], "identifi": [19, 26], "ignor": [1, 3, 7, 17, 22, 23, 24], "ignored_conflict_nam": 17, "immedi": 26, "implement": [0, 3, 4, 8, 18, 20], "import": 0, "in_whitelist": 10, "in_whitelist_check": [3, 7, 10], "inadequ": 3, "includ": [0, 1, 3, 13, 23, 24], "incorrect": 0, "increment": 19, "independantli": 0, "index": 2, "indic": [3, 21, 23], "individu": 3, "info": [0, 1], "inform": [2, 19, 20], "init": [0, 3, 4, 23, 24], "initi": [6, 26], "initialis": [3, 8], "input": 18, "insert": [3, 23], "insid": [3, 23], "inspect": [3, 23, 24], "instal": [0, 1], "instanc": [0, 3, 6, 8, 9, 10, 20, 23, 24, 26], "instanti": [3, 18, 23, 24, 26], "instead": [3, 12, 26], "int": [3, 4, 8, 9, 10, 17, 18, 23, 24], "intend": 21, "intent": 1, "interact": [0, 3, 7, 9, 14, 15, 23], "interactin": 21, "interaction_check": [7, 18], "interest": 20, "intern": [3, 7, 19], "intersphinx": 0, "introduc": 10, "invalid": 9, "invaliddata": 9, "invit": [0, 25], "invoc": [0, 12], "invok": [1, 10, 12, 18], "inwhitelistcheckfailur": [3, 7, 10], "is_in_categori": [3, 7, 9], "isn": [0, 13, 17], "issu": 10, "item": 8, "iter": [10, 12, 14, 16], "its": [0, 3, 12, 17], "itself": 18, "januari": 0, "json": 6, "juli": 0, "june": 0, "just": 0, "keep": [3, 23, 26], "kei": [3, 8, 23, 24], "key_pi": [3, 23, 24], "keyword": [6, 7, 17, 20], "known": 26, "kwarg": [3, 6, 12, 17, 18, 20, 26], "label": [0, 18], "lancebot": 1, "larg": 24, "larger": 24, "last": [3, 10, 18, 23], "latest": 0, "lead": 0, "least": 10, "left": [3, 23], "length": [3, 12, 23], "level": [0, 7, 20], "lexer": [0, 24], "librari": [0, 1], "like": [1, 17], "limit": [3, 23], "line": [3, 23], "linepagin": [0, 2, 3, 7, 23], "linesep": [3, 23], "link": 24, "lint": 0, "list": [0, 1, 3, 18, 23, 24], "listen": 18, "liter": [3, 23, 24], "ll": [1, 26], "load": [0, 1, 3, 7], "load_extens": [0, 2, 3], "loc_by_alia": [3, 23, 24], "local": 2, "localhost": 4, "lock": [0, 3, 7], "lock_arg": [3, 7, 19], "lockedresourceerror": [3, 7, 19], "log": [0, 3, 7, 13, 21, 26], "log_format": [0, 3, 7, 20], "log_to_dev_log": [2, 3], "logger": [0, 20], "logic": 0, "long": [10, 24, 26], "longer": [0, 18], "look": [17, 26], "lookup_kei": [3, 23, 24], "lookuppath": [3, 23, 24], "loop": [4, 26], "lot": 0, "lru": 8, "lua": 0, "lupa": 0, "m": 1, "machin": 1, "made": [0, 22], "mai": [0, 3, 8, 19, 23, 24], "main": 0, "make": [0, 1, 3, 20, 23], "manag": [0, 3, 13, 14, 19], "mani": [0, 3, 8], "manipul": [0, 17], "manual": 3, "map": [17, 19], "march": 0, "mark": 0, "match": [0, 3, 17], "max": 24, "max_length": 24, "max_lin": [3, 23], "max_paste_s": [3, 7, 24], "max_siz": [3, 8, 23, 24], "maximum": [3, 8, 23, 24], "maybe_raise_for_statu": [3, 6], "mean": 1, "meant": 0, "member": [0, 3, 7, 18], "member_id": 21, "mention": [1, 3], "messag": [0, 3, 7, 11, 12, 13, 18, 20, 23, 26], "message_id": 22, "message_typ": 0, "metadata": [3, 23, 24], "method": [0, 3, 4, 6, 7, 20, 23, 24], "metric": 3, "might": [1, 3, 10], "migrat": 0, "minut": [3, 23], "miss": 0, "mod": 0, "mode": [3, 23, 24], "model": [3, 23, 24], "model_config": [2, 3, 7, 23, 24], "model_nam": [3, 23, 24], "model_post_init": [3, 23, 24], "model_seri": [3, 23, 24], "model_valid": [3, 23, 24], "modelfield": [3, 23, 24], "modelfieldsvalid": [3, 23, 24], "modelprivateattr": [3, 23, 24], "modelseri": [3, 23, 24], "modelvalid": [3, 23, 24], "moder": [3, 18, 22, 23], "modifi": [1, 21], "modul": [0, 3, 7, 17, 23, 24, 26], "monitor": 1, "monkei": [0, 7], "month": 0, "more": [0, 1, 3, 17, 19, 23], "most": 1, "move": 0, "msg": 20, "multipl": 0, "multivers": 0, "must": [0, 17, 19, 26], "mutual": 19, "mypi": 20, "n": [3, 23], "name": [3, 7, 17, 19, 20, 23, 24, 26], "name_or_po": [17, 19], "name_pi": [3, 23, 24], "namespac": [0, 3, 19, 23, 24, 26], "navig": [0, 1, 3, 23], "na\u00efv": 26, "need": [0, 1, 3, 23], "never": [3, 23, 24], "new": [0, 1, 3, 4, 6, 8, 17, 23, 26], "newer": 0, "newli": 0, "next": [3, 23], "non": 6, "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "noreturn": [14, 15], "normal": 3, "notabl": 0, "note": [0, 10], "notfound": 9, "notic": 0, "notifi": 12, "novemb": 0, "now": [0, 1, 26], "number": [0, 3, 10, 23, 24], "object": [3, 6, 7, 8, 9, 12, 14, 16, 19, 21, 23, 24, 26], "occur": 18, "octob": 0, "offset": 8, "ok": 6, "older": 0, "on_error": [3, 23, 24], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "on_readi": 3, "on_timeout": [7, 18], "onc": [0, 3, 8], "one": [0, 3, 10, 14, 16, 23], "ones": 1, "onli": [0, 3, 18], "onto": [3, 23], "oper": [3, 19, 23, 26], "option": [0, 8, 17, 19], "order": [3, 8, 14, 16, 17, 19, 23, 26], "ordereddict": [17, 19], "origin": [0, 3, 18, 23, 24], "other": [0, 1, 19, 26], "otherwis": [10, 19, 26], "our": [0, 1, 7], "out": [0, 1, 3, 18], "output": 25, "over": [0, 3, 23], "overflow": [3, 23], "overli": 0, "overrid": [3, 23], "overwrit": [0, 3], "own": [0, 17], "p": [3, 7, 12], "packag": [0, 3, 7], "page": [2, 3, 23], "pagin": [0, 2, 3, 7], "pagination_emoji": [3, 23], "paginationemoji": [2, 3, 7, 23], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 17, 18, 19, 20, 21, 23, 24, 26], "paramspec": [12, 17], "parent": [0, 3, 18, 23, 24], "pars": 25, "pass": [0, 3, 6, 17, 20, 21, 26], "past": [0, 24, 26], "paste_servic": [0, 3, 7], "paste_url": 24, "pastebin": 0, "pastefil": [0, 3, 7, 24], "pasterespons": [3, 7, 24], "pastetoolongerror": [3, 7, 24], "pasteunsupportedlexererror": [3, 7, 24], "pasteuploaderror": [3, 7, 24], "patch": [0, 3, 6, 7], "path": [1, 3, 23, 24], "pattern": 25, "pep": 0, "per": [3, 10, 23], "perform": 19, "permiss": [0, 9], "ping": 3, "ping_servic": [0, 2, 3], "pip": 1, "place": [3, 23], "pleas": 25, "pluggableschemavalid": [3, 23, 24], "poetri": [0, 1], "popul": 3, "port": [0, 4], "posit": [8, 17, 19], "possibl": 1, "post": [3, 6, 23, 24], "post_init": [3, 23, 24], "pre": 1, "predic": [0, 14, 15], "prefix": [1, 3, 4, 23], "prematur": 26, "press": 0, "prevent": [12, 19, 26], "previous": 0, "prioriti": [14, 16], "privat": [3, 23, 24], "privatechannel": [0, 9], "problem": [10, 20], "process": [0, 3], "process_command": [0, 2, 3], "program": 1, "project": [0, 1, 20], "provid": [0, 1, 3, 8, 11, 13, 23, 26], "public": 0, "publish": 0, "purpos": [3, 21, 23, 24], "push": 0, "put": [3, 6], "py": [0, 3, 17, 23, 24], "py_kei": [3, 23, 24], "pydant": [0, 3, 23, 24], "pydantic_js_funct": [3, 23, 24], "pydanticgenericmetadata": [3, 23, 24], "pydi": [0, 2], "pydis_cor": [0, 1, 3, 18, 20, 23, 24], "pypi": 0, "pyproject": [0, 1], "python": [0, 1, 3, 24, 26], "pythondiscord": [0, 24], "qualifi": 7, "quot": 25, "r": [3, 7, 12], "rais": [3, 6, 9, 10, 11, 12, 13, 14, 15, 17, 19, 21, 23, 24, 26], "raise_error": 19, "raise_for_statu": 6, "rate": 10, "rather": 7, "raw": [12, 25], "raw_code_regex": [3, 7, 25], "rc2": 0, "re": [1, 3, 13, 22, 26], "reach": 19, "reaction": [0, 3, 22, 23], "reaction_check": [0, 3, 7, 22], "read": 0, "readi": 3, "real": 0, "reason": [3, 23], "rebuild": [3, 23, 24], "receiv": [0, 6, 9], "recognis": 20, "reconnect": 0, "redi": [0, 3], "redirect": 10, "redirect_channel": 10, "redis_sess": [2, 3], "rediscach": 0, "redissess": 3, "ref": [3, 23, 24], "refer": 0, "referenc": 0, "reflect": 17, "regex": [0, 3, 7], "regist": [0, 14, 16], "register_command_error_manag": [2, 3], "register_handl": [13, 14, 16], "registr": [3, 14, 16], "regular": 25, "reinstal": 1, "reject": 24, "relat": [8, 14, 16, 20], "releas": 0, "relev": 3, "reli": 0, "remain": [3, 23], "remov": [0, 3, 18, 22, 23, 24], "remove_command": [2, 3], "remove_rol": 21, "renam": 0, "replac": [3, 10, 17, 23, 24], "repli": [3, 11, 12, 13, 23], "repo": 0, "represent": 6, "request": [0, 3, 6, 25], "requir": [0, 1, 3, 23, 24, 26], "required_field": [3, 23, 24], "resolut": 0, "resolv": [3, 17], "resourc": 19, "resource_id": 19, "resource_typ": 19, "respons": [0, 6, 24], "response_json": 6, "response_text": 6, "responsecodeerror": [2, 3, 6], "restor": 0, "restrict": [0, 3, 23], "restrict_to_us": [3, 23], "result": [0, 26], "retriev": 9, "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "reusabl": 5, "revalid": [3, 23, 24], "revert": 0, "right": [0, 3, 23], "role": [0, 1, 3, 10, 18, 21, 22, 23], "root": [1, 3, 7], "root_alias": 7, "root_model": [3, 23, 24], "root_valid": [3, 23, 24], "rout": 7, "ruff": 0, "rule": 0, "run": [0, 1, 12, 19, 26], "runtimeerror": 19, "safe": 0, "same": [12, 26], "sampl": 0, "sanitis": 25, "save": [0, 3, 24], "scale": [3, 23], "scale_to_s": [3, 23], "schedul": [0, 3, 7], "schedule_at": [7, 26], "schedule_lat": [7, 26], "schema": [3, 23, 24], "schemafilt": [3, 23, 24], "schemaseri": [3, 23, 24], "schemavalid": [3, 23, 24], "script": 0, "search": 2, "second": [3, 10, 12, 18, 23, 26], "secondari": 18, "see": [0, 1, 17, 18, 19], "self": [0, 3, 18], "send": [0, 3, 6, 18, 23], "send_notic": 12, "send_to_paste_servic": [0, 3, 7, 24], "send_typ": 7, "seper": 1, "septemb": 0, "sequenc": [3, 7, 17, 18, 23], "serfield": [3, 23, 24], "serial": [3, 23, 24], "serv": [3, 23], "server": [3, 25], "servic": [0, 1, 3, 24], "session": [0, 3, 6, 24], "session_kwarg": 6, "set": [0, 1, 3, 12, 17, 18, 19, 23, 24], "set_author": [3, 23], "setup": [0, 3], "setup_hook": [2, 3], "sever": 20, "share": [0, 17], "sharedev": [3, 7, 19], "should": [0, 1, 3, 6, 14, 15, 18, 23, 24], "should_handle_error": [13, 14, 15, 16], "should_rais": 6, "signatur": [3, 12, 23, 24], "silent": 10, "similar": [3, 18, 23, 24, 25], "simpl": [3, 23, 24], "simpledict": [3, 23, 24], "sinc": 10, "singl": [0, 3, 23], "sir": 1, "site": [0, 3, 6], "site_api": [0, 2, 3], "site_api_token": 6, "site_api_url": 6, "size": [3, 8, 23, 24], "so": [0, 1, 3, 7], "socket": 4, "sole": 21, "some": [0, 3, 23, 24], "someth": 25, "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "specif": [0, 10], "specifi": [0, 10, 12, 18], "sphinx": 0, "split": 0, "stabl": 0, "standardis": [0, 20], "start": [0, 3, 26], "startup": 3, "startuperror": [2, 3], "stat": [0, 2, 3, 4], "state": 17, "static": 6, "statsclientbas": 4, "statsd": [0, 3, 4], "statsd_url": [0, 2, 3], "step": 1, "still": [3, 23, 24], "stop": [0, 7, 18], "store": [0, 3, 7, 8, 23], "str": [3, 4, 6, 7, 10, 11, 17, 18, 19, 20, 23, 24, 26], "strict": [0, 3, 23, 24], "string": [0, 6], "strserial": [3, 23, 24], "strvalid": [3, 23, 24], "style": 18, "sub": [0, 3], "submodul": [2, 13], "subpackag": 2, "subtract": 26, "success": [0, 24], "suffix": [3, 23], "suggest": 26, "support": [0, 4, 7, 26], "suppressed_except": 26, "sure": 1, "switch": [3, 23], "sync": [0, 3], "sync_app_command": 3, "synthes": [3, 23, 24], "system": [0, 1, 14, 16], "t": [0, 3, 10, 11, 13, 17, 19, 26], "target": [0, 8], "task": [0, 26], "task_id": 26, "task_return": 26, "templat": 1, "test": 2, "text": [0, 3, 6, 11, 14, 15, 23, 24], "textchannel": 9, "than": [7, 24], "thei": [3, 17, 22], "them": [1, 3, 17, 26], "thi": [0, 1, 3, 7, 9, 10, 12, 17, 18, 19, 21, 23, 24, 25, 26], "thread": [0, 9], "three": [3, 23], "through": [14, 16, 19], "thrown": 7, "thu": 3, "tild": 0, "time": [0, 10, 26], "timeout": [0, 3, 18, 23], "timezon": 26, "titl": [3, 23, 24], "token": [1, 6], "toml": [0, 1], "too": 24, "tool": [3, 7], "top": 7, "total": [3, 23], "trace": [0, 7, 20], "track": 26, "transport": 4, "trashcan": [3, 23], "tree": 3, "trigger": 10, "true": [3, 6, 10, 12, 19, 20, 22, 23, 24, 26], "truncat": [3, 23], "tupl": [17, 26], "turn": 19, "two": 7, "type": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "type_": 10, "typeerror": [10, 17], "typehint": 17, "typevar": [12, 17, 26], "u": [0, 3, 23], "ui": 18, "unavail": 3, "unawait": 26, "undefin": [3, 23, 24], "under": 7, "underli": 19, "union": 10, "uniqu": 26, "unknown": 9, "unqualifi": [0, 2, 3, 7], "unschedul": 26, "unsupport": 24, "unti": [3, 23], "until": [0, 3, 19, 25], "up": [0, 1, 3, 23], "updat": [0, 17], "update_wrapper_glob": [3, 7, 17], "upload": [0, 24], "upon": 0, "url": [0, 3, 6, 23, 24], "urllib": 25, "us": [0, 1, 3, 4, 6, 7, 9, 10, 12, 17, 19, 20, 21, 23, 24, 25, 26], "usag": 0, "user": [0, 3, 10, 12, 18, 22, 23], "user_has_access": [0, 3, 7, 18], "utc": 26, "util": [0, 1, 2, 3, 8, 17, 18, 20, 23, 24], "v1": [0, 3, 23, 24], "valid": [0, 3, 23, 24], "validate_default": [3, 23, 24], "valu": [3, 12, 17, 19, 20, 23, 24], "valueerror": [6, 17, 24], "vari": 1, "variabl": [1, 3, 23, 24], "variou": [0, 9], "verifi": 10, "version": [0, 11], "view": [0, 18], "viewwithuserandrolecheck": [0, 3, 7, 18], "wa": [0, 9, 10, 26], "wait": [0, 3, 7, 19, 26], "wait_until_guild_avail": [2, 3], "want": 1, "warn": [0, 26], "wasn": 11, "we": [20, 21], "websocket": 0, "were": 3, "what": 1, "when": [0, 3, 4, 6, 7, 8, 10, 12, 17, 19, 23, 24, 26], "where": 10, "whether": [0, 3, 6, 9, 10, 14, 15, 18, 23, 24], "which": [0, 1, 3, 7, 10, 12, 17, 19, 23, 26], "while": [3, 12, 19, 23], "whitelist": 10, "whitespac": [0, 25], "who": [0, 18], "whom": [3, 23], "withdefault": [3, 23, 24], "withdefaultseri": [3, 23, 24], "withdefaultvalid": [3, 23, 24], "within": [0, 3], "without": [0, 10], "won": 17, "word": [3, 23], "work": [0, 1], "worker": 7, "workflow": 0, "would": [3, 23], "wrap": [8, 17, 26], "wrapper": [0, 6, 12, 17, 26], "write": [0, 1], "wrong": 0, "www": 0, "x": 0, "you": [0, 1, 9, 25], "your": 1}, "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Pydis Core", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "checks", "commands", "cooldown", "error_handling package", "commands package", "abc", "manager", "function", "interactions", "lock", "logging", "members", "messages", "pagination", "paste_service", "regex", "scheduling"], "titleterms": {"1": 1, "2": 1, "abc": 15, "async_stat": 4, "bot": 2, "cach": 8, "changelog": 0, "channel": 9, "check": 10, "command": [11, 14], "cooldown": 12, "core": [2, 3], "develop": 1, "document": 2, "error_handl": 13, "ext": 5, "extra": 2, "function": 17, "interact": 18, "local": 1, "lock": 19, "log": 20, "manag": 16, "member": 21, "messag": 22, "modul": 2, "option": 1, "packag": [13, 14], "pagin": 23, "paste_servic": 24, "project": 2, "pydi": 3, "refer": 2, "regex": 25, "schedul": 26, "site_api": 6, "submodul": [3, 7, 14], "subpackag": [3, 7, 13], "test": 1, "util": 7}})
\ No newline at end of file +Search.setIndex({"alltitles": {"Bot Core Project Documentation": [[2, null]], "Changelog": [[0, null]], "Extras": [[2, "extras"]], "Exts": [[5, null]], "Local Development & Testing": [[1, null]], "Modules:": [[2, null]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Pydis Core": [[3, null]], "Reference": [[2, "reference"]], "Submodules": [[3, "submodules"], [7, "submodules"], [14, "submodules"]], "Subpackages": [[3, "subpackages"], [7, "subpackages"], [13, "subpackages"]], "Utils": [[7, null]], "abc": [[15, null]], "async_stats": [[4, null]], "caching": [[8, null]], "channel": [[9, null]], "checks": [[10, null]], "commands": [[11, null]], "commands package": [[14, null]], "cooldown": [[12, null]], "error_handling package": [[13, null]], "function": [[17, null]], "interactions": [[18, null]], "lock": [[19, null]], "logging": [[20, null]], "manager": [[16, null]], "members": [[21, null]], "messages": [[22, null]], "pagination": [[23, null]], "paste_service": [[24, null]], "regex": [[25, null]], "scheduling": [[26, null]], "site_api": [[6, null]]}, "docnames": ["changelog", "development", "index", "output/pydis_core", "output/pydis_core.async_stats", "output/pydis_core.exts", "output/pydis_core.site_api", "output/pydis_core.utils", "output/pydis_core.utils.caching", "output/pydis_core.utils.channel", "output/pydis_core.utils.checks", "output/pydis_core.utils.commands", "output/pydis_core.utils.cooldown", "output/pydis_core.utils.error_handling", "output/pydis_core.utils.error_handling.commands", "output/pydis_core.utils.error_handling.commands.abc", "output/pydis_core.utils.error_handling.commands.manager", "output/pydis_core.utils.function", "output/pydis_core.utils.interactions", "output/pydis_core.utils.lock", "output/pydis_core.utils.logging", "output/pydis_core.utils.members", "output/pydis_core.utils.messages", "output/pydis_core.utils.pagination", "output/pydis_core.utils.paste_service", "output/pydis_core.utils.regex", "output/pydis_core.utils.scheduling"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2}, "filenames": ["changelog.rst", "development.rst", "index.rst", "output/pydis_core.rst", "output/pydis_core.async_stats.rst", "output/pydis_core.exts.rst", "output/pydis_core.site_api.rst", "output/pydis_core.utils.rst", "output/pydis_core.utils.caching.rst", "output/pydis_core.utils.channel.rst", "output/pydis_core.utils.checks.rst", "output/pydis_core.utils.commands.rst", "output/pydis_core.utils.cooldown.rst", "output/pydis_core.utils.error_handling.rst", "output/pydis_core.utils.error_handling.commands.rst", "output/pydis_core.utils.error_handling.commands.abc.rst", "output/pydis_core.utils.error_handling.commands.manager.rst", "output/pydis_core.utils.function.rst", "output/pydis_core.utils.interactions.rst", "output/pydis_core.utils.lock.rst", "output/pydis_core.utils.logging.rst", "output/pydis_core.utils.members.rst", "output/pydis_core.utils.messages.rst", "output/pydis_core.utils.pagination.rst", "output/pydis_core.utils.paste_service.rst", "output/pydis_core.utils.regex.rst", "output/pydis_core.utils.scheduling.rst"], "indexentries": {"__call__() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.__call__", false]], "__class_vars__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__class_vars__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__class_vars__", false]], "__class_vars__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__class_vars__", false]], "__class_vars__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__class_vars__", false]], "__contains__() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.__contains__", false]], "__enter__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__enter__", false]], "__exit__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__exit__", false]], "__init__() (apiclient method)": [[6, "pydis_core.site_api.APIClient.__init__", false]], "__init__() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.__init__", false]], "__init__() (asyncstatsclient method)": [[4, "pydis_core.async_stats.AsyncStatsClient.__init__", false]], "__init__() (botbase method)": [[3, "pydis_core.BotBase.__init__", false]], "__init__() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.__init__", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__", false]], "__init__() (commandoncooldown method)": [[12, "pydis_core.utils.cooldown.CommandOnCooldown.__init__", false]], "__init__() (contextcheckfailure method)": [[10, "pydis_core.utils.checks.ContextCheckFailure.__init__", false]], "__init__() (deletemessagebutton method)": [[18, "pydis_core.utils.interactions.DeleteMessageButton.__init__", false]], "__init__() (linepaginator method)": [[3, "pydis_core.LinePaginator.__init__", false], [23, "pydis_core.utils.pagination.LinePaginator.__init__", false]], "__init__() (lockedresourceerror method)": [[19, "pydis_core.utils.lock.LockedResourceError.__init__", false]], "__init__() (responsecodeerror method)": [[6, "pydis_core.site_api.ResponseCodeError.__init__", false]], "__init__() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.__init__", false]], "__init__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__init__", false]], "__init__() (startuperror method)": [[3, "pydis_core.StartupError.__init__", false]], "__init__() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__init__", false]], "__private_attributes__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__private_attributes__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__private_attributes__", false]], "__private_attributes__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__private_attributes__", false]], "__private_attributes__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__private_attributes__", false]], "__pydantic_complete__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_complete__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_complete__", false]], "__pydantic_complete__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_complete__", false]], "__pydantic_complete__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_complete__", false]], "__pydantic_computed_fields__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_computed_fields__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_computed_fields__", false]], "__pydantic_computed_fields__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_computed_fields__", false]], "__pydantic_computed_fields__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_computed_fields__", false]], "__pydantic_core_schema__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_core_schema__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__", false]], "__pydantic_core_schema__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__", false]], "__pydantic_core_schema__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__", false]], "__pydantic_custom_init__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_custom_init__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_custom_init__", false]], "__pydantic_custom_init__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_custom_init__", false]], "__pydantic_custom_init__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_custom_init__", false]], "__pydantic_decorators__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_decorators__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_decorators__", false]], "__pydantic_decorators__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_decorators__", false]], "__pydantic_decorators__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_decorators__", false]], "__pydantic_extra__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_extra__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_extra__", false]], "__pydantic_extra__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_extra__", false]], "__pydantic_extra__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_extra__", false]], "__pydantic_fields__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_fields__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields__", false]], "__pydantic_fields__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_fields__", false]], "__pydantic_fields__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_fields__", false]], "__pydantic_fields_set__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_fields_set__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields_set__", false]], "__pydantic_fields_set__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_fields_set__", false]], "__pydantic_fields_set__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_fields_set__", false]], "__pydantic_generic_metadata__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_generic_metadata__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_generic_metadata__", false]], "__pydantic_generic_metadata__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_generic_metadata__", false]], "__pydantic_generic_metadata__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_generic_metadata__", false]], "__pydantic_parent_namespace__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_parent_namespace__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_parent_namespace__", false]], "__pydantic_parent_namespace__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_parent_namespace__", false]], "__pydantic_parent_namespace__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_parent_namespace__", false]], "__pydantic_post_init__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_post_init__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_post_init__", false]], "__pydantic_post_init__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_post_init__", false]], "__pydantic_post_init__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_post_init__", false]], "__pydantic_private__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_private__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_private__", false]], "__pydantic_private__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_private__", false]], "__pydantic_private__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_private__", false]], "__pydantic_serializer__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_serializer__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__", false]], "__pydantic_serializer__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__", false]], "__pydantic_serializer__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__", false]], "__pydantic_validator__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__pydantic_validator__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__", false]], "__pydantic_validator__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__pydantic_validator__", false]], "__pydantic_validator__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__", false]], "__signature__ (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.__signature__", false], [23, "pydis_core.utils.pagination.PaginationEmojis.__signature__", false]], "__signature__ (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.__signature__", false]], "__signature__ (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.__signature__", false]], "__str__() (responsecodeerror method)": [[6, "pydis_core.site_api.ResponseCodeError.__str__", false]], "abstractcommanderrorhandler (class in pydis_core.utils.error_handling.commands)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler", false]], "abstractcommanderrorhandler (class in pydis_core.utils.error_handling.commands.abc)": [[15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler", false]], "add_cog() (botbase method)": [[3, "pydis_core.BotBase.add_cog", false]], "add_command() (botbase method)": [[3, "pydis_core.BotBase.add_command", false]], "add_line() (linepaginator method)": [[3, "pydis_core.LinePaginator.add_line", false], [23, "pydis_core.utils.pagination.LinePaginator.add_line", false]], "all_extensions (botbase attribute)": [[3, "pydis_core.BotBase.all_extensions", false]], "api_client (botbase attribute)": [[3, "pydis_core.BotBase.api_client", false]], "apiclient (class in pydis_core.site_api)": [[6, "pydis_core.site_api.APIClient", false]], "apply_monkey_patches() (in module pydis_core.utils)": [[7, "pydis_core.utils.apply_monkey_patches", false]], "asynccache (class in pydis_core.utils.caching)": [[8, "pydis_core.utils.caching.AsyncCache", false]], "asyncstatsclient (class in pydis_core.async_stats)": [[4, "pydis_core.async_stats.AsyncStatsClient", false]], "block_duplicate_invocations() (in module pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.block_duplicate_invocations", false]], "botbase (class in pydis_core)": [[3, "pydis_core.BotBase", false]], "call_without_cooldown() (commandoncooldown method)": [[12, "pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown", false]], "callback() (deletemessagebutton method)": [[18, "pydis_core.utils.interactions.DeleteMessageButton.callback", false]], "cancel() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.cancel", false]], "cancel_all() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.cancel_all", false]], "clean_text_or_reply() (in module pydis_core.utils.commands)": [[11, "pydis_core.utils.commands.clean_text_or_reply", false]], "clear() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.clear", false]], "clear() (botbase method)": [[3, "pydis_core.BotBase.clear", false]], "close() (apiclient method)": [[6, "pydis_core.site_api.APIClient.close", false]], "close() (botbase method)": [[3, "pydis_core.BotBase.close", false]], "command_wraps() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.command_wraps", false]], "commanderrormanager (class in pydis_core.utils.error_handling.commands)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager", false]], "commanderrormanager (class in pydis_core.utils.error_handling.commands.manager)": [[16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager", false]], "commandoncooldown": [[12, "pydis_core.utils.cooldown.CommandOnCooldown", false]], "contextcheckfailure": [[10, "pydis_core.utils.checks.ContextCheckFailure", false]], "cooldown_with_role_bypass() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.cooldown_with_role_bypass", false]], "create_socket() (asyncstatsclient method)": [[4, "pydis_core.async_stats.AsyncStatsClient.create_socket", false]], "create_task() (in module pydis_core.utils.scheduling)": [[26, "pydis_core.utils.scheduling.create_task", false]], "customlogger (class in pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.CustomLogger", false]], "delete() (apiclient method)": [[6, "pydis_core.site_api.APIClient.delete", false]], "deletemessagebutton (class in pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.DeleteMessageButton", false]], "discord_invite (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.DISCORD_INVITE", false]], "emptypaginatorembederror": [[3, "pydis_core.EmptyPaginatorEmbedError", false], [23, "pydis_core.utils.pagination.EmptyPaginatorEmbedError", false]], "formatted_code_regex (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.FORMATTED_CODE_REGEX", false]], "get() (apiclient method)": [[6, "pydis_core.site_api.APIClient.get", false]], "get_arg_value() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_arg_value", false]], "get_arg_value_wrapper() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_arg_value_wrapper", false]], "get_bound_args() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_bound_args", false]], "get_logger() (in module pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.get_logger", false]], "get_or_fetch_channel() (in module pydis_core.utils.channel)": [[9, "pydis_core.utils.channel.get_or_fetch_channel", false]], "get_or_fetch_member() (in module pydis_core.utils.members)": [[21, "pydis_core.utils.members.get_or_fetch_member", false]], "globalnameconflicterror": [[17, "pydis_core.utils.function.GlobalNameConflictError", false]], "guild_id (botbase attribute)": [[3, "pydis_core.BotBase.guild_id", false]], "handle_app_command_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error", false]], "handle_error() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error", false]], "handle_forbidden_from_block() (in module pydis_core.utils.error_handling)": [[13, "pydis_core.utils.error_handling.handle_forbidden_from_block", false]], "handle_role_change() (in module pydis_core.utils.members)": [[21, "pydis_core.utils.members.handle_role_change", false]], "handle_text_command_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error", false]], "has_any_role_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.has_any_role_check", false]], "has_no_roles_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.has_no_roles_check", false]], "http_session (botbase attribute)": [[3, "pydis_core.BotBase.http_session", false]], "id (lockedresourceerror attribute)": [[19, "pydis_core.utils.lock.LockedResourceError.id", false]], "in_whitelist_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.in_whitelist_check", false]], "interaction_check() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check", false]], "inwhitelistcheckfailure": [[10, "pydis_core.utils.checks.InWhitelistCheckFailure", false]], "is_in_category() (in module pydis_core.utils.channel)": [[9, "pydis_core.utils.channel.is_in_category", false]], "linepaginator (class in pydis_core)": [[3, "pydis_core.LinePaginator", false]], "linepaginator (class in pydis_core.utils.pagination)": [[23, "pydis_core.utils.pagination.LinePaginator", false]], "load_extensions() (botbase method)": [[3, "pydis_core.BotBase.load_extensions", false]], "lock() (in module pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.lock", false]], "lock_arg() (in module pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.lock_arg", false]], "lockedresourceerror": [[19, "pydis_core.utils.lock.LockedResourceError", false]], "log_format (in module pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.log_format", false]], "log_to_dev_log() (botbase method)": [[3, "pydis_core.BotBase.log_to_dev_log", false]], "max_paste_size (in module pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.MAX_PASTE_SIZE", false]], "maybe_raise_for_status() (apiclient static method)": [[6, "pydis_core.site_api.APIClient.maybe_raise_for_status", false]], "model_config (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.model_config", false], [23, "pydis_core.utils.pagination.PaginationEmojis.model_config", false]], "model_config (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.model_config", false]], "model_config (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.model_config", false]], "module": [[3, "module-pydis_core", false], [4, "module-pydis_core.async_stats", false], [5, "module-pydis_core.exts", false], [6, "module-pydis_core.site_api", false], [7, "module-pydis_core.utils", false], [8, "module-pydis_core.utils.caching", false], [9, "module-pydis_core.utils.channel", false], [10, "module-pydis_core.utils.checks", false], [11, "module-pydis_core.utils.commands", false], [12, "module-pydis_core.utils.cooldown", false], [13, "module-pydis_core.utils.error_handling", false], [14, "module-pydis_core.utils.error_handling.commands", false], [15, "module-pydis_core.utils.error_handling.commands.abc", false], [16, "module-pydis_core.utils.error_handling.commands.manager", false], [17, "module-pydis_core.utils.function", false], [18, "module-pydis_core.utils.interactions", false], [19, "module-pydis_core.utils.lock", false], [20, "module-pydis_core.utils.logging", false], [21, "module-pydis_core.utils.members", false], [22, "module-pydis_core.utils.messages", false], [23, "module-pydis_core.utils.pagination", false], [24, "module-pydis_core.utils.paste_service", false], [25, "module-pydis_core.utils.regex", false], [26, "module-pydis_core.utils.scheduling", false]], "on_guild_available() (botbase method)": [[3, "pydis_core.BotBase.on_guild_available", false]], "on_guild_unavailable() (botbase method)": [[3, "pydis_core.BotBase.on_guild_unavailable", false]], "on_timeout() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout", false]], "p (in module pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.P", false]], "paginate() (linepaginator class method)": [[3, "pydis_core.LinePaginator.paginate", false], [23, "pydis_core.utils.pagination.LinePaginator.paginate", false]], "paginationemojis (class in pydis_core)": [[3, "pydis_core.PaginationEmojis", false]], "paginationemojis (class in pydis_core.utils.pagination)": [[23, "pydis_core.utils.pagination.PaginationEmojis", false]], "pastefile (class in pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.PasteFile", false]], "pasteresponse (class in pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.PasteResponse", false]], "pastetoolongerror": [[24, "pydis_core.utils.paste_service.PasteTooLongError", false]], "pasteunsupportedlexererror": [[24, "pydis_core.utils.paste_service.PasteUnsupportedLexerError", false]], "pasteuploaderror": [[24, "pydis_core.utils.paste_service.PasteUploadError", false]], "patch() (apiclient method)": [[6, "pydis_core.site_api.APIClient.patch", false]], "ping_services() (botbase method)": [[3, "pydis_core.BotBase.ping_services", false]], "post() (apiclient method)": [[6, "pydis_core.site_api.APIClient.post", false]], "process_commands() (botbase method)": [[3, "pydis_core.BotBase.process_commands", false]], "put() (apiclient method)": [[6, "pydis_core.site_api.APIClient.put", false]], "pydis_core": [[3, "module-pydis_core", false]], "pydis_core.async_stats": [[4, "module-pydis_core.async_stats", false]], "pydis_core.exts": [[5, "module-pydis_core.exts", false]], "pydis_core.site_api": [[6, "module-pydis_core.site_api", false]], "pydis_core.utils": [[7, "module-pydis_core.utils", false]], "pydis_core.utils.caching": [[8, "module-pydis_core.utils.caching", false]], "pydis_core.utils.channel": [[9, "module-pydis_core.utils.channel", false]], "pydis_core.utils.checks": [[10, "module-pydis_core.utils.checks", false]], "pydis_core.utils.commands": [[11, "module-pydis_core.utils.commands", false]], "pydis_core.utils.cooldown": [[12, "module-pydis_core.utils.cooldown", false]], "pydis_core.utils.error_handling": [[13, "module-pydis_core.utils.error_handling", false]], "pydis_core.utils.error_handling.commands": [[14, "module-pydis_core.utils.error_handling.commands", false]], "pydis_core.utils.error_handling.commands.abc": [[15, "module-pydis_core.utils.error_handling.commands.abc", false]], "pydis_core.utils.error_handling.commands.manager": [[16, "module-pydis_core.utils.error_handling.commands.manager", false]], "pydis_core.utils.function": [[17, "module-pydis_core.utils.function", false]], "pydis_core.utils.interactions": [[18, "module-pydis_core.utils.interactions", false]], "pydis_core.utils.lock": [[19, "module-pydis_core.utils.lock", false]], "pydis_core.utils.logging": [[20, "module-pydis_core.utils.logging", false]], "pydis_core.utils.members": [[21, "module-pydis_core.utils.members", false]], "pydis_core.utils.messages": [[22, "module-pydis_core.utils.messages", false]], "pydis_core.utils.pagination": [[23, "module-pydis_core.utils.pagination", false]], "pydis_core.utils.paste_service": [[24, "module-pydis_core.utils.paste_service", false]], "pydis_core.utils.regex": [[25, "module-pydis_core.utils.regex", false]], "pydis_core.utils.scheduling": [[26, "module-pydis_core.utils.scheduling", false]], "r (class in pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.R", false]], "raw_code_regex (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.RAW_CODE_REGEX", false]], "reaction_check() (in module pydis_core.utils.messages)": [[22, "pydis_core.utils.messages.reaction_check", false]], "redis_session (botbase attribute)": [[3, "pydis_core.BotBase.redis_session", false]], "register_command_error_manager() (botbase method)": [[3, "pydis_core.BotBase.register_command_error_manager", false]], "register_handler() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler", false]], "remove_command() (botbase method)": [[3, "pydis_core.BotBase.remove_command", false]], "request() (apiclient method)": [[6, "pydis_core.site_api.APIClient.request", false]], "responsecodeerror": [[6, "pydis_core.site_api.ResponseCodeError", false]], "schedule() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule", false]], "schedule_at() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule_at", false]], "schedule_later() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule_later", false]], "scheduler (class in pydis_core.utils.scheduling)": [[26, "pydis_core.utils.scheduling.Scheduler", false]], "send_to_paste_service() (in module pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.send_to_paste_service", false]], "setup_hook() (botbase method)": [[3, "pydis_core.BotBase.setup_hook", false]], "sharedevent (class in pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.SharedEvent", false]], "should_handle_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error", false]], "startuperror": [[3, "pydis_core.StartupError", false]], "stats (botbase attribute)": [[3, "pydis_core.BotBase.stats", false]], "statsd_url (botbase attribute)": [[3, "pydis_core.BotBase.statsd_url", false]], "stop() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop", false]], "trace() (customlogger method)": [[20, "pydis_core.utils.logging.CustomLogger.trace", false]], "type (lockedresourceerror attribute)": [[19, "pydis_core.utils.lock.LockedResourceError.type", false]], "unqualify() (in module pydis_core.utils)": [[7, "pydis_core.utils.unqualify", false]], "update_wrapper_globals() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.update_wrapper_globals", false]], "user_has_access() (in module pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.user_has_access", false]], "viewwithuserandrolecheck (class in pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck", false]], "wait() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.wait", false]], "wait_until_guild_available() (botbase method)": [[3, "pydis_core.BotBase.wait_until_guild_available", false]]}, "objects": {"": [[3, 0, 0, "-", "pydis_core"]], "pydis_core": [[3, 1, 1, "", "BotBase"], [3, 4, 1, "", "EmptyPaginatorEmbedError"], [3, 1, 1, "", "LinePaginator"], [3, 1, 1, "", "PaginationEmojis"], [3, 4, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "pydis_core.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 3, 1, "", "all_extensions"], [3, 3, 1, "", "api_client"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [3, 3, 1, "", "guild_id"], [3, 3, 1, "", "http_session"], [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, "", "process_commands"], [3, 3, 1, "", "redis_session"], [3, 2, 1, "", "register_command_error_manager"], [3, 2, 1, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 3, 1, "", "stats"], [3, 3, 1, "", "statsd_url"], [3, 2, 1, "", "wait_until_guild_available"]], "pydis_core.LinePaginator": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_line"], [3, 2, 1, "", "paginate"]], "pydis_core.PaginationEmojis": [[3, 3, 1, "", "__class_vars__"], [3, 3, 1, "", "__private_attributes__"], [3, 3, 1, "", "__pydantic_complete__"], [3, 3, 1, "", "__pydantic_computed_fields__"], [3, 3, 1, "", "__pydantic_core_schema__"], [3, 3, 1, "", "__pydantic_custom_init__"], [3, 3, 1, "", "__pydantic_decorators__"], [3, 3, 1, "", "__pydantic_extra__"], [3, 3, 1, "", "__pydantic_fields__"], [3, 3, 1, "", "__pydantic_fields_set__"], [3, 3, 1, "", "__pydantic_generic_metadata__"], [3, 3, 1, "", "__pydantic_parent_namespace__"], [3, 3, 1, "", "__pydantic_post_init__"], [3, 3, 1, "", "__pydantic_private__"], [3, 3, 1, "", "__pydantic_serializer__"], [3, 3, 1, "", "__pydantic_validator__"], [3, 3, 1, "", "__signature__"], [3, 3, 1, "", "model_config"]], "pydis_core.StartupError": [[3, 2, 1, "", "__init__"]], "pydis_core.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "pydis_core.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "pydis_core.site_api": [[6, 1, 1, "", "APIClient"], [6, 4, 1, "", "ResponseCodeError"]], "pydis_core.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"]], "pydis_core.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "pydis_core.utils": [[7, 5, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "checks"], [11, 0, 0, "-", "commands"], [12, 0, 0, "-", "cooldown"], [13, 0, 0, "-", "error_handling"], [17, 0, 0, "-", "function"], [18, 0, 0, "-", "interactions"], [19, 0, 0, "-", "lock"], [20, 0, 0, "-", "logging"], [21, 0, 0, "-", "members"], [22, 0, 0, "-", "messages"], [23, 0, 0, "-", "pagination"], [24, 0, 0, "-", "paste_service"], [25, 0, 0, "-", "regex"], [26, 0, 0, "-", "scheduling"], [7, 5, 1, "", "unqualify"]], "pydis_core.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "pydis_core.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "pydis_core.utils.channel": [[9, 5, 1, "", "get_or_fetch_channel"], [9, 5, 1, "", "is_in_category"]], "pydis_core.utils.checks": [[10, 4, 1, "", "ContextCheckFailure"], [10, 4, 1, "", "InWhitelistCheckFailure"], [10, 5, 1, "", "cooldown_with_role_bypass"], [10, 5, 1, "", "has_any_role_check"], [10, 5, 1, "", "has_no_roles_check"], [10, 5, 1, "", "in_whitelist_check"]], "pydis_core.utils.checks.ContextCheckFailure": [[10, 2, 1, "", "__init__"]], "pydis_core.utils.commands": [[11, 5, 1, "", "clean_text_or_reply"]], "pydis_core.utils.cooldown": [[12, 4, 1, "", "CommandOnCooldown"], [12, 6, 1, "", "P"], [12, 1, 1, "", "R"], [12, 5, 1, "", "block_duplicate_invocations"]], "pydis_core.utils.cooldown.CommandOnCooldown": [[12, 2, 1, "", "__init__"], [12, 2, 1, "", "call_without_cooldown"]], "pydis_core.utils.error_handling": [[14, 0, 0, "-", "commands"], [13, 5, 1, "", "handle_forbidden_from_block"]], "pydis_core.utils.error_handling.commands": [[14, 1, 1, "", "AbstractCommandErrorHandler"], [14, 1, 1, "", "CommandErrorManager"], [15, 0, 0, "-", "abc"], [16, 0, 0, "-", "manager"]], "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler": [[14, 2, 1, "", "handle_app_command_error"], [14, 2, 1, "", "handle_text_command_error"], [14, 2, 1, "", "should_handle_error"]], "pydis_core.utils.error_handling.commands.CommandErrorManager": [[14, 2, 1, "", "__init__"], [14, 2, 1, "", "handle_error"], [14, 2, 1, "", "register_handler"]], "pydis_core.utils.error_handling.commands.abc": [[15, 1, 1, "", "AbstractCommandErrorHandler"]], "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler": [[15, 2, 1, "", "handle_app_command_error"], [15, 2, 1, "", "handle_text_command_error"], [15, 2, 1, "", "should_handle_error"]], "pydis_core.utils.error_handling.commands.manager": [[16, 1, 1, "", "CommandErrorManager"]], "pydis_core.utils.error_handling.commands.manager.CommandErrorManager": [[16, 2, 1, "", "__init__"], [16, 2, 1, "", "handle_error"], [16, 2, 1, "", "register_handler"]], "pydis_core.utils.function": [[17, 4, 1, "", "GlobalNameConflictError"], [17, 5, 1, "", "command_wraps"], [17, 5, 1, "", "get_arg_value"], [17, 5, 1, "", "get_arg_value_wrapper"], [17, 5, 1, "", "get_bound_args"], [17, 5, 1, "", "update_wrapper_globals"]], "pydis_core.utils.interactions": [[18, 1, 1, "", "DeleteMessageButton"], [18, 1, 1, "", "ViewWithUserAndRoleCheck"], [18, 5, 1, "", "user_has_access"]], "pydis_core.utils.interactions.DeleteMessageButton": [[18, 2, 1, "", "__init__"], [18, 2, 1, "", "callback"]], "pydis_core.utils.interactions.ViewWithUserAndRoleCheck": [[18, 2, 1, "", "__init__"], [18, 2, 1, "", "interaction_check"], [18, 2, 1, "", "on_timeout"], [18, 2, 1, "", "stop"]], "pydis_core.utils.lock": [[19, 4, 1, "", "LockedResourceError"], [19, 1, 1, "", "SharedEvent"], [19, 5, 1, "", "lock"], [19, 5, 1, "", "lock_arg"]], "pydis_core.utils.lock.LockedResourceError": [[19, 2, 1, "", "__init__"], [19, 3, 1, "", "id"], [19, 3, 1, "", "type"]], "pydis_core.utils.lock.SharedEvent": [[19, 2, 1, "", "__enter__"], [19, 2, 1, "", "__exit__"], [19, 2, 1, "", "__init__"], [19, 2, 1, "", "wait"]], "pydis_core.utils.logging": [[20, 1, 1, "", "CustomLogger"], [20, 5, 1, "", "get_logger"], [20, 6, 1, "", "log_format"]], "pydis_core.utils.logging.CustomLogger": [[20, 2, 1, "", "trace"]], "pydis_core.utils.members": [[21, 5, 1, "", "get_or_fetch_member"], [21, 5, 1, "", "handle_role_change"]], "pydis_core.utils.messages": [[22, 5, 1, "", "reaction_check"]], "pydis_core.utils.pagination": [[23, 4, 1, "", "EmptyPaginatorEmbedError"], [23, 1, 1, "", "LinePaginator"], [23, 1, 1, "", "PaginationEmojis"]], "pydis_core.utils.pagination.LinePaginator": [[23, 2, 1, "", "__init__"], [23, 2, 1, "", "add_line"], [23, 2, 1, "", "paginate"]], "pydis_core.utils.pagination.PaginationEmojis": [[23, 3, 1, "", "__class_vars__"], [23, 3, 1, "", "__private_attributes__"], [23, 3, 1, "", "__pydantic_complete__"], [23, 3, 1, "", "__pydantic_computed_fields__"], [23, 3, 1, "", "__pydantic_core_schema__"], [23, 3, 1, "", "__pydantic_custom_init__"], [23, 3, 1, "", "__pydantic_decorators__"], [23, 3, 1, "", "__pydantic_extra__"], [23, 3, 1, "", "__pydantic_fields__"], [23, 3, 1, "", "__pydantic_fields_set__"], [23, 3, 1, "", "__pydantic_generic_metadata__"], [23, 3, 1, "", "__pydantic_parent_namespace__"], [23, 3, 1, "", "__pydantic_post_init__"], [23, 3, 1, "", "__pydantic_private__"], [23, 3, 1, "", "__pydantic_serializer__"], [23, 3, 1, "", "__pydantic_validator__"], [23, 3, 1, "", "__signature__"], [23, 3, 1, "", "model_config"]], "pydis_core.utils.paste_service": [[24, 6, 1, "", "MAX_PASTE_SIZE"], [24, 1, 1, "", "PasteFile"], [24, 1, 1, "", "PasteResponse"], [24, 4, 1, "", "PasteTooLongError"], [24, 4, 1, "", "PasteUnsupportedLexerError"], [24, 4, 1, "", "PasteUploadError"], [24, 5, 1, "", "send_to_paste_service"]], "pydis_core.utils.paste_service.PasteFile": [[24, 3, 1, "", "__class_vars__"], [24, 3, 1, "", "__private_attributes__"], [24, 3, 1, "", "__pydantic_complete__"], [24, 3, 1, "", "__pydantic_computed_fields__"], [24, 3, 1, "", "__pydantic_core_schema__"], [24, 3, 1, "", "__pydantic_custom_init__"], [24, 3, 1, "", "__pydantic_decorators__"], [24, 3, 1, "", "__pydantic_extra__"], [24, 3, 1, "", "__pydantic_fields__"], [24, 3, 1, "", "__pydantic_fields_set__"], [24, 3, 1, "", "__pydantic_generic_metadata__"], [24, 3, 1, "", "__pydantic_parent_namespace__"], [24, 3, 1, "", "__pydantic_post_init__"], [24, 3, 1, "", "__pydantic_private__"], [24, 3, 1, "", "__pydantic_serializer__"], [24, 3, 1, "", "__pydantic_validator__"], [24, 3, 1, "", "__signature__"], [24, 3, 1, "", "model_config"]], "pydis_core.utils.paste_service.PasteResponse": [[24, 3, 1, "", "__class_vars__"], [24, 3, 1, "", "__private_attributes__"], [24, 3, 1, "", "__pydantic_complete__"], [24, 3, 1, "", "__pydantic_computed_fields__"], [24, 3, 1, "", "__pydantic_core_schema__"], [24, 3, 1, "", "__pydantic_custom_init__"], [24, 3, 1, "", "__pydantic_decorators__"], [24, 3, 1, "", "__pydantic_extra__"], [24, 3, 1, "", "__pydantic_fields__"], [24, 3, 1, "", "__pydantic_fields_set__"], [24, 3, 1, "", "__pydantic_generic_metadata__"], [24, 3, 1, "", "__pydantic_parent_namespace__"], [24, 3, 1, "", "__pydantic_post_init__"], [24, 3, 1, "", "__pydantic_private__"], [24, 3, 1, "", "__pydantic_serializer__"], [24, 3, 1, "", "__pydantic_validator__"], [24, 3, 1, "", "__signature__"], [24, 3, 1, "", "model_config"]], "pydis_core.utils.regex": [[25, 6, 1, "", "DISCORD_INVITE"], [25, 6, 1, "", "FORMATTED_CODE_REGEX"], [25, 6, 1, "", "RAW_CODE_REGEX"]], "pydis_core.utils.scheduling": [[26, 1, 1, "", "Scheduler"], [26, 5, 1, "", "create_task"]], "pydis_core.utils.scheduling.Scheduler": [[26, 2, 1, "", "__contains__"], [26, 2, 1, "", "__init__"], [26, 2, 1, "", "cancel"], [26, 2, 1, "", "cancel_all"], [26, 2, 1, "", "schedule"], [26, 2, 1, "", "schedule_at"], [26, 2, 1, "", "schedule_later"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"], "6": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:exception", "5": "py:function", "6": "py:data"}, "terms": {"": [0, 1, 3, 7, 8, 10, 11, 12, 17, 18, 19, 20, 22, 23, 24, 25, 26], "0": [0, 8, 10, 18, 19, 20], "0a0": 0, "0eb3d26": 0, "0x0000561501352d30": 3, "0x00005615013ab640": 23, "0x0000561501527070": 24, "0x0000561501577f40": 24, "0x00007f4a8c0299f0": 23, "0x00007f4a8c029ab0": 23, "0x00007f4a8c029ff0": 23, "0x00007f4a8c02a430": 23, "0x00007f4a8c02bf70": 23, "0x00007f4a8c271af0": 3, "0x00007f4a8c271eb0": 3, "0x00007f4a8c2721f0": 3, "0x00007f4a8c2733b0": 3, "0x00007f4a8c2739f0": 3, "0x00007f4a8c273fb0": 3, "0x00007f4a8cacfcb0": 23, "0x00007f4a8cfa1480": 3, "0x00007f4a8cfa14d0": 3, "0x00007f4a8cfa1520": 3, "0x00007f4a8cfa1570": 3, "0x00007f4a8cfa15c0": 3, "0x00007f4a8d15e240": 23, "0x00007f4a8d15e290": 23, "0x00007f4a8d15e2e0": 23, "0x00007f4a8d15e330": 23, "0x00007f4a8d15e380": 23, "0x00007f4a8d3f25f0": 24, "0x00007f4a8d570870": 24, "0x00007f4a8d5708b0": 24, "0x00007f4a8d5708f0": 24, "0x00007f4a8d570930": 24, "0x00007f4a8d571af0": 24, "0x00007f4a8d571b30": 24, "0x00007f4a8d571b70": 24, "0x00007f4a8d571bb0": 24, "0x00007f4a8d571bf0": 24, "0x00007f4a8d571c30": 24, "0x00007f4a8d6613f0": 3, "0x00007f4a8d80c370": 3, "0x00007f4a8d80d430": 3, "0x00007f4a8d9c6ef0": 23, "0x00007f4a8d9c7db0": 23, "0x00007f4a8d9f0bd0": 3, "0x00007f4a8dac46f0": 23, "0x00007f4a8dc886b0": 23, "0x00007f4a8f519ce0": 24, "0x00007f4a8f51a3e0": 23, "0x00007f4a902a1330": 3, "0x00007f4a90410c70": 24, "0x00007f4a90697f70": 24, "0x00007f4a909c8df0": 24, "0x00007f4a90d7c1f0": [3, 23], "0x00007f4a90d7c230": [3, 23], "0x00007f4a90dccd30": [3, 23], "0x00007f4a90deb2f0": [3, 23], "0x00007f4a91108eb0": [3, 23], "0x00007f4a91696280": 24, "0x00007f4a9173d0a0": 24, "0x00007f4a91740e80": 24, "1": [0, 20], "10": 0, "101": 0, "103": 0, "104": 0, "106": 0, "107": 0, "108": 0, "10th": 0, "11": 0, "110": 0, "11th": 0, "12": 0, "124": 0, "125": 0, "128": 8, "138": 0, "13th": 0, "14th": 0, "15": 0, "151": 0, "157": 0, "158": 0, "162": 0, "169": 0, "16th": 0, "170": 0, "171": 0, "172": 0, "173": 0, "174": 0, "175": 0, "176": 0, "177": 0, "179": 0, "17th": 0, "180": 18, "181": 0, "182": 0, "183": 0, "184": 0, "185": 0, "187": 0, "188": 0, "189": 0, "18th": 0, "190": 0, "192": 0, "194": 0, "195": 0, "196": 0, "197": 0, "199": 0, "19th": 0, "2": [0, 3, 18, 24], "200": 0, "202": 0, "2021": 0, "2022": 0, "2023": 0, "2024": 0, "204": [0, 6], "205": 0, "206": 0, "207": 0, "208": 0, "209": 0, "20th": 0, "210": 0, "21st": 0, "22nd": 0, "23rd": 0, "244": 0, "24th": 0, "254": 0, "25th": 0, "269": 0, "26th": 0, "27th": 0, "282": 0, "28th": 0, "29": 0, "295": 0, "2nd": 0, "3": [0, 24], "30": 0, "300": [3, 23], "302": 0, "30th": 0, "32": 0, "34": 0, "35": 0, "37": 0, "39": 0, "3rd": 0, "4": 0, "4000": [3, 23], "403": 7, "42": 0, "4cbe8f5": 0, "5": [0, 3, 12, 23], "500": [3, 23], "524288": 24, "54": 0, "56": 0, "561": 0, "5a06fa5": 0, "5th": 0, "6": 0, "61": 0, "63": 0, "637136429717389331": [3, 23], "64": 0, "65": 0, "66": 0, "68": 0, "69": 0, "6th": 0, "7": 0, "72": 0, "75": 0, "78": 0, "79": 0, "8": 0, "8125": 4, "88": 0, "9": 0, "90001": [0, 13], "91": 0, "93": 0, "94648214564144": 3, "94648214926912": 23, "94648216481904": 24, "94648216813376": 24, "96": 0, "98": 0, "987235d": 0, "9th": 0, "A": [1, 3, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 18, 20, 23, 24, 26], "As": 0, "Be": 0, "For": 17, "If": [3, 6, 10, 12, 17, 18, 19, 22, 23, 26], "In": [3, 23], "It": [3, 7, 19, 23], "Not": 3, "On": 0, "That": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 17, 18, 20, 21, 23, 24, 26], "These": [3, 23], "To": [1, 3, 20], "_": 0, "__annotations__": 17, "__args__": [3, 23, 24], "__call__": [7, 8], "__class_vars__": [2, 3, 7, 23, 24], "__contains__": [7, 26], "__dict__": 17, "__doc__": 17, "__enter__": [7, 19], "__exit__": [7, 19], "__fields__": [3, 23, 24], "__get_pydantic_json_schema__": [3, 23, 24], "__global__": 17, "__init__": [0, 2, 3, 4, 6, 7, 8, 10, 12, 13, 14, 16, 18, 19, 23, 24, 26], "__module__": 17, "__name__": 17, "__origin__": [3, 23, 24], "__parameters__": [3, 23, 24], "__private_attributes__": [2, 3, 7, 23, 24], "__pydantic_complete__": [2, 3, 7, 23, 24], "__pydantic_computed_fields__": [2, 3, 7, 23, 24], "__pydantic_core_schema__": [2, 3, 7, 23, 24], "__pydantic_custom_init__": [2, 3, 7, 23, 24], "__pydantic_decorators__": [2, 3, 7, 23, 24], "__pydantic_extra__": [2, 3, 7, 23, 24], "__pydantic_fields__": [2, 3, 7, 23, 24], "__pydantic_fields_set__": [2, 3, 7, 23, 24], "__pydantic_generic_metadata__": [2, 3, 7, 23, 24], "__pydantic_parent_namespace__": [2, 3, 7, 23, 24], "__pydantic_post_init__": [2, 3, 7, 23, 24], "__pydantic_private__": [2, 3, 7, 23, 24], "__pydantic_serializer__": [2, 3, 7, 23, 24], "__pydantic_validator__": [2, 3, 7, 23, 24], "__qualname__": 17, "__root_validators__": [3, 23, 24], "__signature__": [2, 3, 7, 23, 24], "__str__": [3, 6], "__validators__": [3, 23, 24], "_decor": [3, 23, 24], "_exc_tb": 19, "_exc_typ": 19, "_exc_val": 19, "_gener": [3, 23, 24], "_guild_avail": 0, "_p": 17, "_r": 17, "_transport": 0, "abc": [0, 13, 14], "abl": 0, "about": [3, 12, 23, 24], "abstract": [0, 14, 15], "abstractcommanderrorhandl": [0, 7, 13, 14, 15], "abstracteventloop": [4, 26], "accept": [17, 18], "access": 18, "acquir": 19, "across": [0, 3, 20, 23], "act": 7, "action": 0, "activ": 19, "actual": 0, "ad": [0, 1, 3, 7, 18, 20, 23], "add": [0, 3, 10, 12, 23], "add_cog": [2, 3], "add_command": [2, 3], "add_lin": [2, 3, 7, 23], "add_rol": 21, "addit": 0, "after": [0, 3, 18, 23, 26], "again": 1, "aid": [3, 23], "aiodn": 0, "aiohttp": [0, 3, 6, 24], "alia": [3, 7, 12, 23, 24], "alias": [3, 7], "alias_pi": [3, 23, 24], "all": [0, 1, 3, 4, 7, 14, 16, 19, 20, 26], "all_command": 3, "all_extens": [2, 3], "allow": [0, 1, 3, 18, 22, 23, 24], "allow_mod": 22, "allowed_emoji": 22, "allowed_rol": [0, 1, 3, 18, 22, 23], "allowed_us": [0, 18, 22], "alpha": 0, "alreadi": [3, 23, 26], "also": [0, 3, 7, 17, 18, 19, 23], "alwai": 10, "among": 19, "amount": [3, 23], "an": [0, 1, 3, 4, 6, 7, 8, 9, 10, 14, 15, 17, 19, 20, 23, 24, 26], "ani": [3, 6, 10, 17, 19, 23, 24, 25, 26], "annot": [3, 17, 23, 24], "anymor": [3, 23], "anyth": [1, 24], "api": [0, 3, 6, 21], "api_cli": [0, 2, 3], "apicli": [0, 2, 3, 6], "app": [0, 3, 14, 15], "appear": 3, "append": [3, 23], "appli": [3, 7, 8, 10, 12, 19, 23, 24], "applic": 1, "apply_monkey_patch": [0, 2, 3, 7], "approach": 1, "april": 0, "ar": [0, 1, 3, 8, 17, 18, 22, 23, 24, 25], "arg": [3, 12, 17, 19, 20, 23, 24], "arg_offset": 8, "args_preprocessor": 12, "argument": [6, 7, 8, 11, 12, 17, 19, 20, 21], "around": 6, "assign": 17, "async": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 21, 23, 24], "async_rediscach": [0, 3], "async_stat": [2, 3], "asynccach": [3, 7, 8], "asyncio": [0, 4, 26], "asyncresolv": 0, "asyncstatscli": [2, 3, 4], "asyncstatsdcli": 0, "attach": 0, "attempt": [0, 3, 9, 19, 21, 23], "attr": 0, "attribut": [0, 3, 7, 17, 23, 24], "august": 0, "authent": 6, "author": [3, 10, 22, 23], "auto": 0, "auto_mod": 0, "autogener": 0, "automat": [0, 3, 23, 24], "avail": [0, 3, 14, 16, 19], "avoid": [0, 3, 23], "await": [0, 3, 12, 18, 19, 21, 23], "awar": [0, 26], "back": 0, "backslash": 0, "backtick": [3, 23], "bad": 0, "badargu": 11, "base": [0, 3, 4, 6, 8, 10, 12, 14, 15, 16, 17, 18, 19, 20, 23, 24, 26], "basemodel": [3, 23, 24], "basic": [0, 18], "becaus": [3, 17], "becom": [3, 19], "been": [0, 3], "befor": [0, 3, 10, 18, 19, 23, 26], "before_invok": 10, "behav": 17, "behavior": 10, "behaviour": [0, 3], "being": [0, 7, 10, 21], "belong": 3, "below": [1, 19], "best": [3, 23], "between": [0, 1, 17], "bind": [3, 17], "block": [0, 3, 12, 23, 25], "block_duplicate_invoc": [3, 7, 12], "bodi": 0, "boilerpl": 0, "bool": [3, 6, 9, 10, 12, 14, 15, 18, 19, 22, 23, 24, 26], "bot": [0, 1, 3, 7, 9, 22], "bot_token": 1, "botbas": [0, 2, 3], "both": [0, 1, 3, 24], "bound": [3, 23, 24], "boundari": [3, 23], "break": [0, 3, 17, 23], "broke": 0, "buckettyp": 10, "bug": 0, "bugfix": 0, "build": [3, 23, 24], "bump": 0, "button": [0, 18], "buttonstyl": 18, "bypass": 10, "bypass_rol": 10, "byte": 24, "cach": [0, 3, 7, 9, 21], "cache_str": [3, 23, 24], "calcul": 26, "call": [0, 3, 12, 17, 26], "call_without_cooldown": [7, 12], "callabl": [8, 10, 12, 17, 19, 21], "callback": [7, 10, 18], "can": [0, 1, 3, 10, 18, 19, 20, 23, 26], "cancel": [7, 26], "cancel_al": [7, 26], "cannot": [0, 3, 19, 23], "capabl": [14, 16], "captur": [0, 17, 25], "carri": 18, "case": [0, 3, 23], "categori": [9, 10], "category_id": 9, "caus": [3, 7, 23], "certain": [0, 1], "chang": [0, 1, 3, 17, 23], "changelog": 2, "changeset": 0, "channel": [0, 3, 7, 10, 12], "channel_id": 9, "charact": [0, 3, 23], "chardet": 0, "check": [0, 3, 6, 7, 9, 12, 13, 18, 22, 26], "checkfailur": 10, "choos": [14, 16], "chunk": 0, "ci": 0, "cl": [3, 23, 24], "class": [0, 3, 4, 6, 8, 12, 14, 15, 16, 18, 19, 20, 23, 24, 26], "classmethod": [3, 23], "classvar": [3, 23, 24], "clean": [0, 11], "clean_text_or_repli": [3, 7, 11], "clear": [2, 3, 7, 8, 19], "click": 18, "client": [0, 3, 4], "clientrespons": 6, "clientsess": [3, 6, 24], "close": [0, 2, 3, 6, 26], "cloudflar": 7, "code": [0, 1, 3, 6, 19, 23, 25], "codepoint": [3, 23], "coerce_numbers_to_str": [3, 23, 24], "cog": [0, 3, 5], "collect": 10, "collis": 19, "com": [0, 24], "comma": 1, "command": [0, 1, 3, 7, 9, 10, 12, 13, 15, 16, 17, 19, 23], "command_wrap": [3, 7, 17], "commanderror": 12, "commanderrormanag": [0, 7, 13, 14, 16], "commandinvokeerror": 0, "commandoncooldown": [3, 7, 12], "commit": 0, "common": [0, 1, 3, 7, 20, 25], "commun": [3, 4], "complet": [3, 23, 24], "complianc": 0, "compos": 1, "comput": [3, 23, 24], "computed_field": [3, 23, 24], "computedfield": [3, 23, 24], "computedfieldinfo": [3, 23, 24], "concurr": 0, "config": [0, 3, 23, 24], "configdict": [3, 23, 24], "configur": [1, 3, 23, 24], "conflict": 17, "conform": [3, 23, 24], "connect": [0, 3, 4], "connector": 3, "constructor": [3, 6], "contain": [1, 3, 10, 18, 23, 24, 26], "content": [0, 3, 11, 23, 24], "context": [3, 10, 11, 14, 15, 19, 23], "context_or_interact": [14, 16], "contextcheckfailur": [3, 7, 10], "continu": [3, 23], "control": 0, "cooldown": [3, 7, 10], "cooldown_dur": 12, "cooldown_with_role_bypass": [3, 7, 10], "copi": [1, 17], "copy_default": [3, 23, 24], "core": [0, 1, 23, 24], "coreschema": [3, 23, 24], "coro": [19, 21, 26], "coroutin": [8, 19, 21, 26], "correct": [0, 1], "correspond": [3, 23, 24], "could": [0, 21], "count": 19, "cover": 0, "crash": 0, "creat": [0, 3, 4, 8, 12, 17, 23, 26], "create_datagram_endpoint": 4, "create_socket": [3, 4], "create_task": [3, 7, 26], "creation": 0, "criteria": 0, "ctx": [3, 10, 11, 18, 23], "current": [0, 3, 19, 23, 26], "custom": [0, 3, 8, 20, 23, 24], "custom_init": [3, 23, 24], "customlogg": [3, 7, 20], "cut": 0, "d": [1, 17], "dai": 0, "data": [3, 23, 24], "datetim": 26, "deal": 0, "decemb": 0, "declar": 0, "decor": [0, 3, 8, 10, 12, 17, 19, 23, 24], "decorator_func": 17, "decoratorinfo": [3, 23, 24], "decrement": 19, "default": [0, 1, 3, 10, 14, 16, 17, 23, 24], "defin": [3, 23, 24], "definit": [3, 23, 24], "delai": 26, "delet": [0, 3, 6, 8, 18, 23, 24], "deletemessagebutton": [0, 3, 7, 18], "depend": [0, 9], "deprec": 0, "describ": 10, "detail": 17, "detect": 0, "determin": [14, 15, 16], "dev": [1, 3], "develop": [0, 2, 3, 7], "dict": [3, 6, 17, 23, 24], "dictat": 0, "dictionari": [3, 23, 24], "did": 0, "directli": [0, 17], "directori": 1, "discord": [0, 1, 3, 5, 7, 9, 10, 11, 13, 14, 16, 17, 21, 23, 25], "discord_invit": [0, 3, 7, 25], "disnak": 0, "distinguish": 26, "django": 6, "dm": 10, "do": [0, 1, 9, 19], "doc": [0, 19], "docker": 1, "docstr": 0, "document": 0, "doe": [0, 17], "doesn": [3, 10, 26], "don": [0, 10, 26], "done": [3, 18, 23, 26], "drop": 0, "due": 0, "dummi": [0, 3], "dump": [3, 23, 24], "duplic": [0, 12], "durat": 10, "dure": [3, 23, 24], "dynam": 0, "e": [3, 23], "each": [0, 3, 23], "edg": 0, "edit": 3, "effort": [3, 23], "either": [0, 3], "els": 11, "elsewher": 26, "emb": [0, 3, 23], "emit": 3, "emoji": [0, 3, 22, 23], "empti": [3, 23], "emptypaginatorembederror": [2, 3, 7, 23], "enabl": [0, 1], "encount": 24, "end": [3, 23], "endpoint": 6, "ensur": [0, 3, 18, 25], "entir": [0, 3], "env": 1, "environ": [0, 1], "equival": 6, "error": [0, 3, 6, 7, 13, 14, 15, 16, 21, 24], "error_handl": [0, 3, 7], "etc": [1, 10], "evalu": 17, "even": 22, "event": [0, 3, 4, 19, 26], "event_loop": 26, "eventu": [3, 23, 24], "everi": [3, 23], "exact": 1, "exampl": [3, 23], "exc_info": 20, "exce": [3, 8, 23], "exceed": [3, 23], "except": [3, 6, 10, 12, 14, 16, 17, 19, 20, 23, 24, 26], "exception_on_empty_emb": [3, 23], "excess": [3, 23], "exclud": [3, 23, 24], "exclus": 19, "execut": [19, 26], "exist": [0, 1, 26], "exit": 19, "expect": 21, "expiri": 0, "explain": 0, "explicitli": [3, 23, 24], "expos": 19, "express": 25, "ext": [0, 2, 3, 7, 9, 10, 11, 23], "extend": 0, "extens": [0, 3], "extra": [0, 3, 6, 23, 24], "extra_behavior": [3, 23, 24], "extra_seri": [3, 23, 24], "extract": 0, "extras_valid": [3, 23, 24], "facilit": 0, "fail": [9, 10, 24], "fail_sil": 10, "failur": 21, "fakeredi": 0, "fals": [3, 10, 12, 19, 23, 24], "featur": [0, 1, 3], "februari": 0, "fetch": [9, 21], "few": 1, "field": [3, 23, 24], "field_seri": [3, 23, 24], "field_valid": [3, 23, 24], "fieldinfo": [3, 23, 24], "fifo": 8, "file": [0, 1, 24], "filter": [0, 3, 23, 24], "finish": [3, 19, 23], "first": [3, 14, 16, 23], "five": [3, 23], "fix": 0, "float": [10, 12, 18, 26], "folder": 1, "footer": [3, 23], "footer_text": [3, 23], "forbidden": [0, 9, 13], "format": [24, 25], "formatt": 20, "formatted_code_regex": [3, 7, 25], "forum": 0, "forwardref": 17, "found": [3, 17, 21, 26], "free": 1, "from": [0, 1, 3, 4, 6, 7, 9, 17, 18, 21, 23, 24, 26], "from_attribut": [3, 23, 24], "frozen": [3, 23, 24], "frozenset": [3, 17], "func": [17, 19], "function": [0, 3, 7, 8, 9, 12, 19, 20, 21, 23, 26], "functool": 17, "futur": [10, 26], "g": [3, 23], "gatewai": 3, "gener": [0, 3, 12, 23, 24, 26], "generalfieldsseri": [3, 23, 24], "generic_origin": [3, 23, 24], "get": [0, 3, 6, 9, 17, 21], "get_arg_valu": [3, 7, 17], "get_arg_value_wrapp": [3, 7, 17], "get_bound_arg": [3, 7, 17], "get_logg": [3, 7, 20], "get_or_fetch_channel": [0, 3, 7, 9], "get_or_fetch_memb": [0, 3, 7, 21], "git": 1, "github": 0, "give": 3, "given": [0, 3, 4, 7, 9, 11, 17, 19, 20, 21, 26], "global": 17, "globalnameconflicterror": [3, 7, 17], "go": [1, 3, 19, 23], "greater": 24, "groundwork": 1, "group": [7, 25], "guild": [0, 1, 3, 10, 21], "guild_available_but_cache_empti": 3, "guild_creat": 3, "guild_id": [1, 2, 3], "guildchannel": 9, "ha": [0, 3, 7, 10, 18, 23, 24], "handl": [0, 13, 14, 15, 16, 21, 26], "handle_app_command_error": [13, 14, 15], "handle_error": [13, 14, 16], "handle_forbidden_from_block": [3, 7, 13], "handle_role_chang": [0, 3, 7, 21], "handle_text_command_error": [13, 14, 15], "handler": [0, 3, 14, 15, 16], "happen": 3, "has_any_role_check": [3, 7, 10], "has_extra": [3, 23, 24], "has_no_roles_check": [3, 7, 10], "hashabl": [19, 26], "have": [0, 9, 10, 17, 20], "heavi": 7, "help": [0, 1], "helper": [0, 9, 12, 21], "hold": [3, 19, 23], "holder": 19, "hook": 0, "host": 4, "houston": 20, "how": [0, 8, 10, 17, 26], "howev": 1, "http": [0, 3, 6, 24, 25], "http_session": [2, 3, 24], "httpexcept": 9, "i": [0, 1, 3, 6, 7, 9, 10, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "icon": [3, 23], "icon_url": [3, 23], "id": [1, 3, 7, 9, 10, 18, 19, 23, 26], "identifi": [19, 26], "ignor": [1, 3, 7, 17, 22, 23, 24], "ignored_conflict_nam": 17, "immedi": 26, "implement": [0, 3, 4, 8, 18, 20], "import": 0, "in_whitelist": 10, "in_whitelist_check": [3, 7, 10], "inadequ": 3, "includ": [0, 1, 3, 13, 23, 24], "incorrect": 0, "increment": 19, "independantli": 0, "index": 2, "indic": [3, 21, 23], "individu": 3, "info": [0, 1], "inform": [2, 19, 20], "init": [0, 3, 4, 23, 24], "initi": [6, 26], "initialis": [3, 8], "input": 18, "insert": [3, 23], "insid": [3, 23], "inspect": [3, 23, 24], "instal": [0, 1], "instanc": [0, 3, 6, 8, 9, 10, 20, 23, 24, 26], "instanti": [3, 18, 23, 24, 26], "instead": [3, 12, 26], "int": [3, 4, 8, 9, 10, 17, 18, 23, 24], "intend": 21, "intent": 1, "interact": [0, 3, 7, 9, 14, 15, 23], "interactin": 21, "interaction_check": [7, 18], "interest": 20, "intern": [3, 7, 19], "intersphinx": 0, "introduc": 10, "invalid": 9, "invaliddata": 9, "invit": [0, 25], "invoc": [0, 12], "invok": [1, 10, 12, 18], "inwhitelistcheckfailur": [3, 7, 10], "is_in_categori": [3, 7, 9], "isn": [0, 13, 17], "issu": 10, "item": 8, "iter": [10, 12, 14, 16], "its": [0, 3, 12, 17], "itself": 18, "januari": 0, "json": 6, "juli": 0, "june": 0, "just": 0, "keep": [3, 23, 26], "kei": [3, 8, 23, 24], "key_pi": [3, 23, 24], "keyword": [6, 7, 17, 20], "known": 26, "kwarg": [3, 6, 12, 17, 18, 20, 26], "label": [0, 18], "lancebot": 1, "larg": 24, "larger": 24, "last": [3, 10, 18, 23], "latest": 0, "lead": 0, "least": 10, "left": [3, 23], "length": [3, 12, 23], "level": [0, 7, 20], "lexer": [0, 24], "librari": [0, 1], "like": [1, 17], "limit": [3, 23], "line": [3, 23], "linepagin": [0, 2, 3, 7, 23], "linesep": [3, 23], "link": 24, "lint": 0, "list": [0, 1, 3, 18, 23, 24], "listen": 18, "liter": [3, 23, 24], "ll": [1, 26], "load": [0, 1, 3, 7], "load_extens": [0, 2, 3], "loc_by_alia": [3, 23, 24], "local": 2, "localhost": 4, "lock": [0, 3, 7], "lock_arg": [3, 7, 19], "lockedresourceerror": [3, 7, 19], "log": [0, 3, 7, 13, 21, 26], "log_format": [0, 3, 7, 20], "log_to_dev_log": [2, 3], "logger": [0, 20], "logic": 0, "long": [10, 24, 26], "longer": [0, 18], "look": [17, 26], "lookup_kei": [3, 23, 24], "lookuppath": [3, 23, 24], "loop": [4, 26], "lot": 0, "lru": 8, "lua": 0, "lupa": 0, "m": 1, "machin": 1, "made": [0, 22], "mai": [0, 3, 8, 19, 23, 24], "main": 0, "make": [0, 1, 3, 20, 23], "manag": [0, 3, 13, 14, 19], "mani": [0, 3, 8], "manipul": [0, 17], "manual": 3, "map": [17, 19], "march": 0, "mark": 0, "match": [0, 3, 17], "max": 24, "max_length": 24, "max_lin": [3, 23], "max_paste_s": [3, 7, 24], "max_siz": [3, 8, 23, 24], "maximum": [3, 8, 23, 24], "maybe_raise_for_statu": [3, 6], "mean": 1, "meant": 0, "member": [0, 3, 7, 18], "member_id": 21, "mention": [1, 3], "messag": [0, 3, 7, 11, 12, 13, 18, 20, 23, 26], "message_id": 22, "message_typ": 0, "metadata": [3, 23, 24], "method": [0, 3, 4, 6, 7, 20, 23, 24], "metric": 3, "might": [1, 3, 10], "migrat": 0, "minut": [3, 23], "miss": 0, "mod": 0, "mode": [3, 23, 24], "model": [3, 23, 24], "model_config": [2, 3, 7, 23, 24], "model_nam": [3, 23, 24], "model_post_init": [3, 23, 24], "model_seri": [3, 23, 24], "model_valid": [3, 23, 24], "modelfield": [3, 23, 24], "modelfieldsvalid": [3, 23, 24], "modelprivateattr": [3, 23, 24], "modelseri": [3, 23, 24], "modelvalid": [3, 23, 24], "moder": [3, 18, 22, 23], "modifi": [1, 21], "modul": [0, 3, 7, 17, 23, 24, 26], "monitor": 1, "monkei": [0, 7], "month": 0, "more": [0, 1, 3, 17, 19, 23], "most": 1, "move": 0, "msg": 20, "multipl": 0, "multivers": 0, "must": [0, 17, 19, 26], "mutual": 19, "mypi": 20, "n": [3, 23], "name": [3, 7, 17, 19, 20, 23, 24, 26], "name_or_po": [17, 19], "name_pi": [3, 23, 24], "namespac": [0, 3, 19, 23, 24, 26], "navig": [0, 1, 3, 23], "na\u00efv": 26, "need": [0, 1, 3, 23], "never": [3, 23, 24], "new": [0, 1, 3, 4, 6, 8, 17, 23, 26], "newer": 0, "newli": 0, "next": [0, 3, 23], "non": 6, "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "noreturn": [14, 15], "normal": 3, "notabl": 0, "note": [0, 10], "notfound": 9, "notic": 0, "notifi": 12, "novemb": 0, "now": [0, 1, 26], "number": [0, 3, 10, 23, 24], "object": [3, 6, 7, 8, 9, 12, 14, 16, 19, 21, 23, 24, 26], "occur": 18, "octob": 0, "offset": 8, "ok": 6, "older": 0, "on_error": [3, 23, 24], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "on_readi": 3, "on_timeout": [7, 18], "onc": [0, 3, 8], "one": [0, 3, 10, 14, 16, 23], "ones": 1, "onli": [0, 3, 18], "onto": [3, 23], "oper": [3, 19, 23, 26], "option": [0, 8, 17, 19], "order": [3, 8, 14, 16, 17, 19, 23, 26], "ordereddict": [17, 19], "origin": [0, 3, 18, 23, 24], "other": [0, 1, 19, 26], "otherwis": [10, 19, 26], "our": [0, 1, 7], "out": [0, 1, 3, 18], "output": 25, "over": [0, 3, 23], "overflow": [3, 23], "overli": 0, "overrid": [3, 23], "overwrit": [0, 3], "own": [0, 17], "p": [3, 7, 12], "packag": [0, 3, 7], "page": [2, 3, 23], "pagin": [0, 2, 3, 7], "pagination_emoji": [3, 23], "paginationemoji": [2, 3, 7, 23], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 17, 18, 19, 20, 21, 23, 24, 26], "paramspec": [12, 17], "parent": [0, 3, 18, 23, 24], "pars": 25, "pass": [0, 3, 6, 17, 20, 21, 26], "past": [0, 24, 26], "paste_servic": [0, 3, 7], "paste_url": 24, "pastebin": 0, "pastefil": [0, 3, 7, 24], "pasterespons": [3, 7, 24], "pastetoolongerror": [3, 7, 24], "pasteunsupportedlexererror": [3, 7, 24], "pasteuploaderror": [3, 7, 24], "patch": [0, 3, 6, 7], "path": [1, 3, 23, 24], "pattern": 25, "pep": 0, "per": [3, 10, 23], "perform": 19, "permiss": [0, 9], "ping": 3, "ping_servic": [0, 2, 3], "pip": 1, "place": [3, 23], "pleas": 25, "pluggableschemavalid": [3, 23, 24], "poetri": [0, 1], "popul": 3, "port": [0, 4], "posit": [8, 17, 19], "possibl": 1, "post": [3, 6, 23, 24], "post_init": [3, 23, 24], "pre": 1, "predic": [0, 14, 15], "prefix": [1, 3, 4, 23], "prematur": 26, "press": 0, "prevent": [12, 19, 26], "previous": 0, "prioriti": [14, 16], "privat": [3, 23, 24], "privatechannel": [0, 9], "problem": [10, 20], "process": [0, 3], "process_command": [0, 2, 3], "program": 1, "project": [0, 1, 20], "provid": [0, 1, 3, 8, 11, 13, 23, 26], "public": 0, "publish": 0, "purpos": [3, 21, 23, 24], "push": 0, "put": [3, 6], "py": [0, 3, 17, 23, 24], "py_kei": [3, 23, 24], "pydant": [0, 3, 23, 24], "pydantic_js_funct": [3, 23, 24], "pydanticgenericmetadata": [3, 23, 24], "pydi": [0, 2], "pydis_cor": [0, 1, 3, 18, 20, 23, 24], "pypi": 0, "pyproject": [0, 1], "python": [0, 1, 3, 24, 26], "pythondiscord": [0, 24], "qualifi": 7, "quot": 25, "r": [3, 7, 12], "rais": [3, 6, 9, 10, 11, 12, 13, 14, 15, 17, 19, 21, 23, 24, 26], "raise_error": 19, "raise_for_statu": 6, "rate": 10, "rather": 7, "raw": [12, 25], "raw_code_regex": [3, 7, 25], "rc2": 0, "re": [1, 3, 13, 22, 26], "reach": 19, "reaction": [0, 3, 22, 23], "reaction_check": [0, 3, 7, 22], "read": 0, "readi": 3, "real": 0, "reason": [3, 23], "rebuild": [3, 23, 24], "receiv": [0, 6, 9], "recognis": 20, "reconnect": 0, "redi": [0, 3], "redirect": 10, "redirect_channel": 10, "redis_sess": [2, 3], "rediscach": 0, "redissess": 3, "ref": [3, 23, 24], "refer": 0, "referenc": 0, "reflect": 17, "regex": [0, 3, 7], "regist": [0, 14, 16], "register_command_error_manag": [2, 3], "register_handl": [13, 14, 16], "registr": [3, 14, 16], "regular": 25, "reinstal": 1, "reject": 24, "relat": [8, 14, 16, 20], "releas": 0, "relev": 3, "reli": 0, "remain": [3, 23], "remov": [0, 3, 18, 22, 23, 24], "remove_command": [2, 3], "remove_rol": 21, "renam": 0, "replac": [3, 10, 17, 23, 24], "repli": [3, 11, 12, 13, 23], "repo": 0, "represent": 6, "request": [0, 3, 6, 25], "requir": [0, 1, 3, 23, 24, 26], "required_field": [3, 23, 24], "resolut": 0, "resolv": [3, 17], "resourc": 19, "resource_id": 19, "resource_typ": 19, "respons": [0, 6, 24], "response_json": 6, "response_text": 6, "responsecodeerror": [2, 3, 6], "restor": 0, "restrict": [0, 3, 23], "restrict_to_us": [3, 23], "result": [0, 26], "retriev": 9, "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "reusabl": 5, "revalid": [3, 23, 24], "revert": 0, "right": [0, 3, 23], "role": [0, 1, 3, 10, 18, 21, 22, 23], "root": [1, 3, 7], "root_alias": 7, "root_model": [3, 23, 24], "root_valid": [3, 23, 24], "rout": 7, "ruff": 0, "rule": 0, "run": [0, 1, 12, 19, 26], "runtimeerror": 19, "safe": 0, "same": [12, 26], "sampl": 0, "sanitis": 25, "save": [0, 3, 24], "scale": [3, 23], "scale_to_s": [3, 23], "schedul": [0, 3, 7], "schedule_at": [7, 26], "schedule_lat": [7, 26], "schema": [3, 23, 24], "schemafilt": [3, 23, 24], "schemaseri": [3, 23, 24], "schemavalid": [3, 23, 24], "script": 0, "search": 2, "second": [3, 10, 12, 18, 23, 26], "secondari": 18, "see": [0, 1, 17, 18, 19], "self": [0, 3, 18], "send": [0, 3, 6, 18, 23], "send_notic": 12, "send_to_paste_servic": [0, 3, 7, 24], "send_typ": 7, "seper": 1, "septemb": 0, "sequenc": [3, 7, 17, 18, 23], "serfield": [3, 23, 24], "serial": [3, 23, 24], "serv": [3, 23], "server": [3, 25], "servic": [0, 1, 3, 24], "session": [0, 3, 6, 24], "session_kwarg": 6, "set": [0, 1, 3, 12, 17, 18, 19, 23, 24], "set_author": [3, 23], "setup": [0, 3], "setup_hook": [2, 3], "sever": 20, "share": [0, 17], "sharedev": [3, 7, 19], "should": [0, 1, 3, 6, 14, 15, 18, 23, 24], "should_handle_error": [13, 14, 15, 16], "should_rais": 6, "signatur": [3, 12, 23, 24], "silent": 10, "similar": [3, 18, 23, 24, 25], "simpl": [3, 23, 24], "simpledict": [3, 23, 24], "sinc": 10, "singl": [0, 3, 23], "sir": 1, "site": [0, 3, 6], "site_api": [0, 2, 3], "site_api_token": 6, "site_api_url": 6, "size": [3, 8, 23, 24], "so": [0, 1, 3, 7], "socket": 4, "sole": 21, "some": [0, 3, 23, 24], "someth": 25, "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "specif": [0, 10], "specifi": [0, 10, 12, 18], "sphinx": 0, "split": 0, "stabl": 0, "standardis": [0, 20], "start": [0, 3, 26], "startup": 3, "startuperror": [2, 3], "stat": [0, 2, 3, 4], "state": 17, "static": 6, "statsclientbas": 4, "statsd": [0, 3, 4], "statsd_url": [0, 2, 3], "step": 1, "still": [3, 23, 24], "stop": [0, 7, 18], "store": [0, 3, 7, 8, 23], "str": [3, 4, 6, 7, 10, 11, 17, 18, 19, 20, 23, 24, 26], "strict": [0, 3, 23, 24], "string": [0, 6], "strserial": [3, 23, 24], "strvalid": [3, 23, 24], "style": 18, "sub": [0, 3], "submodul": [2, 13], "subpackag": 2, "subtract": 26, "success": [0, 24], "suffix": [3, 23], "suggest": 26, "support": [0, 4, 7, 26], "suppressed_except": 26, "sure": 1, "switch": [3, 23], "sync": [0, 3], "sync_app_command": 3, "synthes": [3, 23, 24], "system": [0, 1, 14, 16], "t": [0, 3, 10, 11, 13, 17, 19, 26], "target": [0, 8], "task": [0, 26], "task_id": 26, "task_return": 26, "templat": 1, "test": 2, "text": [0, 3, 6, 11, 14, 15, 23, 24], "textchannel": 9, "than": [7, 24], "thei": [3, 17, 22], "them": [1, 3, 17, 26], "thi": [0, 1, 3, 7, 9, 10, 12, 17, 18, 19, 21, 23, 24, 25, 26], "thread": [0, 9], "three": [3, 23], "through": [14, 16, 19], "thrown": 7, "thu": 3, "tild": 0, "time": [0, 10, 26], "timeout": [0, 3, 18, 23], "timezon": 26, "titl": [3, 23, 24], "token": [1, 6], "toml": [0, 1], "too": 24, "tool": [3, 7], "top": 7, "total": [3, 23], "trace": [0, 7, 20], "track": 26, "transport": 4, "trashcan": [3, 23], "tree": 3, "trigger": 10, "true": [3, 6, 10, 12, 19, 20, 22, 23, 24, 26], "truncat": [3, 23], "tupl": [17, 26], "turn": 19, "two": 7, "type": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "type_": 10, "typeerror": [10, 17], "typehint": 17, "typevar": [12, 17, 26], "u": [0, 3, 23], "ui": 18, "unavail": 3, "unawait": 26, "undefin": [3, 23, 24], "under": 7, "underli": 19, "union": 10, "uniqu": 26, "unknown": 9, "unqualifi": [0, 2, 3, 7], "unschedul": 26, "unsupport": 24, "unti": [3, 23], "until": [0, 3, 19, 25], "up": [0, 1, 3, 23], "updat": [0, 17], "update_wrapper_glob": [3, 7, 17], "upload": [0, 24], "upon": 0, "url": [0, 3, 6, 23, 24], "urllib": 25, "us": [0, 1, 3, 4, 6, 7, 9, 10, 12, 17, 19, 20, 21, 23, 24, 25, 26], "usag": 0, "user": [0, 3, 10, 12, 18, 22, 23], "user_has_access": [0, 3, 7, 18], "utc": 26, "util": [0, 1, 2, 3, 8, 17, 18, 20, 23, 24], "v1": [0, 3, 23, 24], "valid": [0, 3, 23, 24], "validate_default": [3, 23, 24], "valu": [3, 12, 17, 19, 20, 23, 24], "valueerror": [6, 17, 24], "vari": 1, "variabl": [1, 3, 23, 24], "variou": [0, 9], "verifi": 10, "version": [0, 11], "view": [0, 18], "viewwithuserandrolecheck": [0, 3, 7, 18], "wa": [0, 9, 10, 26], "wait": [0, 3, 7, 19, 26], "wait_until_guild_avail": [2, 3], "want": 1, "warn": [0, 26], "wasn": 11, "we": [20, 21], "websocket": 0, "were": 3, "what": 1, "when": [0, 3, 4, 6, 7, 8, 10, 12, 17, 19, 23, 24, 26], "where": 10, "whether": [0, 3, 6, 9, 10, 14, 15, 18, 23, 24], "which": [0, 1, 3, 7, 10, 12, 17, 19, 23, 26], "while": [3, 12, 19, 23], "whitelist": 10, "whitespac": [0, 25], "who": [0, 18], "whom": [3, 23], "withdefault": [3, 23, 24], "withdefaultseri": [3, 23, 24], "withdefaultvalid": [3, 23, 24], "within": [0, 3], "without": [0, 10], "won": 17, "word": [3, 23], "work": [0, 1], "worker": 7, "workflow": 0, "would": [3, 23], "wrap": [8, 17, 26], "wrapper": [0, 6, 12, 17, 26], "write": [0, 1], "wrong": 0, "www": 0, "x": 0, "you": [0, 1, 9, 25], "your": 1}, "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Pydis Core", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "checks", "commands", "cooldown", "error_handling package", "commands package", "abc", "manager", "function", "interactions", "lock", "logging", "members", "messages", "pagination", "paste_service", "regex", "scheduling"], "titleterms": {"1": 1, "2": 1, "abc": 15, "async_stat": 4, "bot": 2, "cach": 8, "changelog": 0, "channel": 9, "check": 10, "command": [11, 14], "cooldown": 12, "core": [2, 3], "develop": 1, "document": 2, "error_handl": 13, "ext": 5, "extra": 2, "function": 17, "interact": 18, "local": 1, "lock": 19, "log": 20, "manag": 16, "member": 21, "messag": 22, "modul": 2, "option": 1, "packag": [13, 14], "pagin": 23, "paste_servic": 24, "project": 2, "pydi": 3, "refer": 2, "regex": 25, "schedul": 26, "site_api": 6, "submodul": [3, 7, 14], "subpackag": [3, 7, 13], "test": 1, "util": 7}})
\ No newline at end of file diff --git a/main/versions.html b/main/versions.html index 9954f1d6..9372d8ab 100644 --- a/main/versions.html +++ b/main/versions.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> - <title>Versions - Pydis Core Latest (11.5.1)</title> - <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> + <title>Versions - Pydis Core Latest (11.6.0)</title> + <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> - <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="_static/changelog.css?v=117bb91a" /> @@ -169,7 +169,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Pydis Core Latest (11.5.1)</div></a> + <a href="index.html"><div class="brand">Pydis Core Latest (11.6.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -196,7 +196,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.5.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.6.0)</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"> @@ -707,7 +707,7 @@ </aside> </div> -</div><script src="_static/documentation_options.js?v=07a056c7"></script> +</div><script src="_static/documentation_options.js?v=31a70c35"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> |