From 4497a82c504818d61ab18c5251ae2bc42bae279e Mon Sep 17 00:00:00 2001
From: ChrisLovering guild_id ( allowed_roles ( http_session (aiohttp.ClientSession) โ The session to use for the bot. redis_session ( api_client ( statsd_url ( guild_id ( allowed_roles ( http_session (aiohttp.ClientSession) โ The session to use for the bot. redis_session ( api_client ( statsd_url (
-
int) โ The ID of the guild used for wait_until_guild_available().list) โ A list of role IDs that the bot is allowed to mention.RedisSession | None) โ The async_rediscache.RedisSession to use for the bot.APIClient | None) โ The pydis_core.site_api.APIClient instance to use for the bot.str | None) โ The URL of the statsd server to use for the bot. If not given,
+int) โ The ID of the guild used for wait_until_guild_available().list) โ A list of role IDs that the bot is allowed to mention.RedisSession | None) โ The async_rediscache.RedisSession to use for the bot.APIClient | None) โ The pydis_core.site_api.APIClient instance to use for the bot.str | None) โ The URL of the statsd server to use for the bot. If not given,
a dummy statsd client will be created.
Add the given cog to the bot and log the operation.
Add command as normal and then add its root aliases to the bot.
Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.
Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.
Load all the extensions within the given module and save them to self.all_extensions.
Log the given message to #dev-log.
Clear the internal guild available event when self.guild_id becomes unavailable.
Ping all required services on setup to ensure they are up before starting.
This extension check is only relevant for clients that make use of pydis_core.BotBase.load_extensions.
ping_services().
@@ -622,7 +630,7 @@ and
@@ -632,7 +640,7 @@ gateway event before giving up and thus not populating the cache for unavailable
Bases: Exception
Bases: Exception
Raised when attempting to paginate with empty contents.
pagination_emojis (PaginationEmojis) โ The emojis used to navigate pages.
prefix (str) โ The prefix inserted to every page. e.g. three backticks.
suffix (str) โ The suffix appended at the end of every page. e.g. three backticks.
max_size (int) โ The maximum amount of codepoints allowed in a page.
scale_to_size (int) โ The maximum amount of characters a single line can scale up to.
max_lines (int) โ The maximum amount of lines allowed in a page.
prefix (str) โ The prefix inserted to every page. e.g. three backticks.
suffix (str) โ The suffix appended at the end of every page. e.g. three backticks.
max_size (int) โ The maximum amount of codepoints allowed in a page.
scale_to_size (int) โ The maximum amount of characters a single line can scale up to.
max_lines (int) โ The maximum amount of lines allowed in a page.
pagination_emojis (PaginationEmojis) โ The emojis used to navigate pages.
lines (list[str]) โ A list of lines to be added to the paginated content.
lines (list[str]) โ A list of lines to be added to the paginated content.
ctx (discord.ext.commands.Context) โ The context in which the pagination is needed.
embed (discord.Embed) โ The embed that holds the content, it serves as the page.
prefix (str) โ The prefix inserted to every page. e.g. three backticks.
suffix (str) โ The suffix appended at the end of every page. e.g. three backticks.
max_lines (int) โ The maximum amount of lines allowed in a page.
max_size (int) โ The maximum amount of codepoints allowed in a page.
scale_to_size (int) โ The maximum amount of characters a single line can scale up to.
empty (bool) โ Indicates whether an empty line should be added to each provided line.
prefix (str) โ The prefix inserted to every page. e.g. three backticks.
suffix (str) โ The suffix appended at the end of every page. e.g. three backticks.
max_lines (int) โ The maximum amount of lines allowed in a page.
max_size (int) โ The maximum amount of codepoints allowed in a page.
scale_to_size (int) โ The maximum amount of characters a single line can scale up to.
empty (bool) โ Indicates whether an empty line should be added to each provided line.
restrict_to_user (discord.User) โ The user to whom interaction with the pages should be restricted.
timeout (int) โ The timeout after which users cannot change pages anymore.
footer_text (str) โ Text to be added as a footer for each page.
url (str) โ The url to be set for the pagination embed.
exception_on_empty_embed (bool) โ Indicates whether to raise an exception when no lines are provided.
reply (bool) โ Indicates whether to send the page as a reply to the contextโs message.
allowed_roles (Sequence[int]) โ A list of role ids that are allowed to change pages.
timeout (int) โ The timeout after which users cannot change pages anymore.
footer_text (str) โ Text to be added as a footer for each page.
url (str) โ The url to be set for the pagination embed.
exception_on_empty_embed (bool) โ Indicates whether to raise an exception when no lines are provided.
reply (bool) โ Indicates whether to send the page as a reply to the contextโs message.
allowed_roles (Sequence[int]) โ A list of role ids that are allowed to change pages.
Example: @@ -755,9 +763,15 @@ to any user with a moderation role.
Whether model building is completed, or if there are still undefined fields.
A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.
+The core schema of the model.
A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to โallowโ.
A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects. +This replaces Model.__fields__ from Pydantic V1.
+The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The synthesized __init__ [Signature][inspect.Signature] of the model.
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
-Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
Metadata about the fields defined on the model, -mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
-This replaces Model.__fields__ from Pydantic V1.
-Bases: Exception
Bases: Exception
Exception class for startup errors.
PaginationEmojis.__class_vars__PaginationEmojis.__private_attributes__PaginationEmojis.__pydantic_complete__PaginationEmojis.__pydantic_computed_fields__PaginationEmojis.__pydantic_core_schema__PaginationEmojis.__pydantic_custom_init__PaginationEmojis.__pydantic_decorators__PaginationEmojis.__pydantic_extra__PaginationEmojis.__pydantic_fields__PaginationEmojis.__pydantic_fields_set__PaginationEmojis.__pydantic_generic_metadata__PaginationEmojis.__pydantic_parent_namespace__PaginationEmojis.__pydantic_serializer__PaginationEmojis.__pydantic_validator__PaginationEmojis.__signature__PaginationEmojis.model_computed_fieldsPaginationEmojis.model_configPaginationEmojis.model_fieldsStartupError