From 0a068679f4c82a66c514c69ab1a7a569a736ed0f Mon Sep 17 00:00:00 2001
From: HassanAbouelela
Date: Mon, 12 Dec 2022 18:11:20 +0000
Subject: Deploying to docs from @
python-discord/bot-core@9c728dff2351a0170b372fec76e2b5e15f8846f3 🚀
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
v8.0.0/output/botcore.async_stats.html | 18 +++++++++-------
v8.0.0/output/botcore.exts.html | 16 +++++++-------
v8.0.0/output/botcore.html | 20 ++++++++++--------
v8.0.0/output/botcore.site_api.html | 16 +++++++-------
v8.0.0/output/botcore.utils.caching.html | 16 +++++++-------
v8.0.0/output/botcore.utils.channel.html | 30 ++++++++++++++-------------
v8.0.0/output/botcore.utils.commands.html | 20 ++++++++++--------
v8.0.0/output/botcore.utils.html | 18 +++++++++-------
v8.0.0/output/botcore.utils.interactions.html | 24 +++++++++++----------
v8.0.0/output/botcore.utils.logging.html | 16 +++++++-------
v8.0.0/output/botcore.utils.members.html | 30 ++++++++++++++-------------
v8.0.0/output/botcore.utils.regex.html | 16 +++++++-------
v8.0.0/output/botcore.utils.scheduling.html | 16 +++++++-------
13 files changed, 141 insertions(+), 115 deletions(-)
(limited to 'v8.0.0/output')
diff --git a/v8.0.0/output/botcore.async_stats.html b/v8.0.0/output/botcore.async_stats.html
index a5edaf4f..5342366b 100644
--- a/v8.0.0/output/botcore.async_stats.html
+++ b/v8.0.0/output/botcore.async_stats.html
@@ -5,14 +5,14 @@
-
+
async_stats - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -365,7 +369,7 @@
asyncio.loop.create_datagram_endpoint .
host (str ) – The host to connect to.
port (int ) – The port to connect to.
-prefix (Optional [str ]) – The prefix to use for all stats.
+prefix (str ) – The prefix to use for all stats.
@@ -423,9 +427,7 @@
diff --git a/v8.0.0/output/botcore.exts.html b/v8.0.0/output/botcore.exts.html
index becb5020..f9a24db2 100644
--- a/v8.0.0/output/botcore.exts.html
+++ b/v8.0.0/output/botcore.exts.html
@@ -5,14 +5,14 @@
-
+
Exts - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -388,9 +392,7 @@
diff --git a/v8.0.0/output/botcore.html b/v8.0.0/output/botcore.html
index fa3030c2..ecd8ff55 100644
--- a/v8.0.0/output/botcore.html
+++ b/v8.0.0/output/botcore.html
@@ -5,14 +5,14 @@
-
+
Botcore - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -352,7 +356,7 @@
class BotBase ( * args , guild_id , allowed_roles , http_session , redis_session = None , api_client = None , statsd_url = None , ** kwargs ) [source]
-Bases: Bot
+Bases: Bot
A sub-class that implements many common features that Python Discord bots use.
@@ -483,7 +487,7 @@ will not be set and guild_available_but_cache_empty event will be e
To remove them, either remove the entire command or manually edit bot.all_commands .
Return type:
-Optional [Command ]
+Optional [Command ]
@@ -658,9 +662,7 @@ gateway event before giving up and thus not populating the cache for unavailable
diff --git a/v8.0.0/output/botcore.site_api.html b/v8.0.0/output/botcore.site_api.html
index 706370c1..38d454b8 100644
--- a/v8.0.0/output/botcore.site_api.html
+++ b/v8.0.0/output/botcore.site_api.html
@@ -5,14 +5,14 @@
-
+
site_api - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -559,9 +563,7 @@
diff --git a/v8.0.0/output/botcore.utils.caching.html b/v8.0.0/output/botcore.utils.caching.html
index acac868f..76e6dd4a 100644
--- a/v8.0.0/output/botcore.utils.caching.html
+++ b/v8.0.0/output/botcore.utils.caching.html
@@ -5,14 +5,14 @@
-
+
caching - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -436,9 +440,7 @@
diff --git a/v8.0.0/output/botcore.utils.channel.html b/v8.0.0/output/botcore.utils.channel.html
index 328e182b..d7407fb7 100644
--- a/v8.0.0/output/botcore.utils.channel.html
+++ b/v8.0.0/output/botcore.utils.channel.html
@@ -5,14 +5,14 @@
-
+
channel - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -356,20 +360,20 @@
Parameters:
Raises:
Return type:
-GuildChannel
+GuildChannel
Returns:
The channel from the ID.
@@ -384,7 +388,7 @@
Parameters:
-channel (TextChannel ) – The channel to check.
+channel (TextChannel ) – The channel to check.
category_id (int ) – The category to check for.
@@ -436,9 +440,7 @@
diff --git a/v8.0.0/output/botcore.utils.commands.html b/v8.0.0/output/botcore.utils.commands.html
index ee6cb91f..262c96f8 100644
--- a/v8.0.0/output/botcore.utils.commands.html
+++ b/v8.0.0/output/botcore.utils.commands.html
@@ -5,14 +5,14 @@
-
+
commands - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -355,12 +359,12 @@
Parameters:
-ctx (Context ) – The command’s context
+ctx (Context ) – The command’s context
text (Optional [str ]) – The provided text argument of the command (if given)
Raises:
-discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.
+discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.
Return type:
str
@@ -410,9 +414,7 @@
diff --git a/v8.0.0/output/botcore.utils.html b/v8.0.0/output/botcore.utils.html
index 917cea2a..505225e7 100644
--- a/v8.0.0/output/botcore.utils.html
+++ b/v8.0.0/output/botcore.utils.html
@@ -5,14 +5,14 @@
-
+
Utils - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -354,7 +358,7 @@
apply_monkey_patches ( ) [source]
Applies all common monkey patches for our bots.
-Patches discord.ext.commands.Command and discord.ext.commands.Group to support root aliases. A root_aliases keyword argument is added to these two objects, which is a sequence of alias names
+
Patches discord.ext.commands.Command and discord.ext.commands.Group to support root aliases. A root_aliases 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.
It’s stored as an attribute also named root_aliases
@@ -496,9 +500,7 @@ that will act as top-level groups rather than being aliases of the command’s g
diff --git a/v8.0.0/output/botcore.utils.interactions.html b/v8.0.0/output/botcore.utils.interactions.html
index 93d554a1..d9fa71aa 100644
--- a/v8.0.0/output/botcore.utils.interactions.html
+++ b/v8.0.0/output/botcore.utils.interactions.html
@@ -5,14 +5,14 @@
-
+
interactions - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -351,7 +355,7 @@
class DeleteMessageButton ( * , style=<ButtonStyle.secondary: 2> , label='Delete' , **kwargs ) [source]
-Bases: Button
+Bases: Button
A button that can be added to a view to delete the message containing the view on click.
This button itself carries out no interaction checks, these should be done by the parent view.
See botcore.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.
@@ -384,7 +388,7 @@
class ViewWithUserAndRoleCheck ( * , allowed_users , allowed_roles , timeout = 180.0 , message = None ) [source]
-Bases: View
+Bases: View
A view that allows the original invoker and moderators to interact with it.
Parameters:
@@ -393,7 +397,7 @@
allowed_roles (Sequence [int ]) – A sequence of role ids that are allowed to interact with the view.
timeout (Optional [float ]) – Timeout in seconds from last interaction with the UI before no longer accepting input.
If None then there is no timeout.
-message (Optional [Message ]) – The message to remove the view from on timeout. This can also be set with
+
message (Optional [Message ]) – The message to remove the view from on timeout. This can also be set with
view.message = await ctx.send( ... )` , or similar, after the view is instantiated.
@@ -409,7 +413,7 @@ If None Ensure the user clicking the button is the view invoker, or a moderator.
Parameters:
-interaction (Interaction ) – The interaction that occurred.
+interaction (Interaction ) – The interaction that occurred.
Return type:
bool
@@ -469,9 +473,7 @@ If None
diff --git a/v8.0.0/output/botcore.utils.logging.html b/v8.0.0/output/botcore.utils.logging.html
index 9ef395a8..dc76cccb 100644
--- a/v8.0.0/output/botcore.utils.logging.html
+++ b/v8.0.0/output/botcore.utils.logging.html
@@ -5,14 +5,14 @@
-
+
logging - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -434,9 +438,7 @@
diff --git a/v8.0.0/output/botcore.utils.members.html b/v8.0.0/output/botcore.utils.members.html
index 778aeb79..4d7c906c 100644
--- a/v8.0.0/output/botcore.utils.members.html
+++ b/v8.0.0/output/botcore.utils.members.html
@@ -5,14 +5,14 @@
-
+
members - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -348,17 +352,17 @@
members
-Useful helper functions for interactin with discord.Member objects.
+Useful helper functions for interactin with discord.Member objects.
async get_or_fetch_member ( guild , member_id ) [source]
Attempt to get a member from cache; on failure fetch from the API.
Return type:
-Optional [Member ]
+Optional [Member ]
Returns:
-The discord.Member or None to indicate the member could not be found.
+The discord.Member or None to indicate the member could not be found.
@@ -368,13 +372,13 @@
async handle_role_change ( member , coro , role ) [source]
Await the given coro with role as the sole argument.
Handle errors that we expect to be raised from
-discord.Member.add_roles and discord.Member.remove_roles .
+discord.Member.add_roles and discord.Member.remove_roles .
Parameters:
Return type:
@@ -422,9 +426,7 @@
diff --git a/v8.0.0/output/botcore.utils.regex.html b/v8.0.0/output/botcore.utils.regex.html
index 55ec391a..38dd45c1 100644
--- a/v8.0.0/output/botcore.utils.regex.html
+++ b/v8.0.0/output/botcore.utils.regex.html
@@ -5,14 +5,14 @@
-
+
regex - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -418,9 +422,7 @@ such as
-
-
-
+
diff --git a/v8.0.0/output/botcore.utils.scheduling.html b/v8.0.0/output/botcore.utils.scheduling.html
index 7d77b157..25fa3116 100644
--- a/v8.0.0/output/botcore.utils.scheduling.html
+++ b/v8.0.0/output/botcore.utils.scheduling.html
@@ -5,14 +5,14 @@
-
+
scheduling - Pydis Core v8.0.0
-
+
-
+
@@ -156,7 +156,7 @@
Pydis Core v8.0.0
@@ -207,6 +207,10 @@
main
+
+ v9.1.1
+
+
v9.0.0
@@ -543,9 +547,7 @@ otherwise the running loop is used.
--
cgit v1.2.3