-

Pydis Core#

+

Pydis Core

Useful utilities and tools for Discord bot development.

-class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#
+class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]

Bases: Bot

A sub-class that implements many common features that Python Discord bots use.

-guild_id[source]#
+guild_id[source]

ID of the guild that the bot belongs to.

Type:
@@ -410,7 +410,7 @@
-http_session[source]#
+http_session[source]

The http session used for sending out HTTP requests.

Type:
@@ -421,7 +421,7 @@
-api_client[source]#
+api_client[source]

The API client used for communications with the site service.

Type:
@@ -432,7 +432,7 @@
-statsd_url[source]#
+statsd_url[source]

The url that statsd sends metrics to.

Type:
@@ -443,7 +443,7 @@
-redis_session[source]#
+redis_session[source]

The redis session used to communicate with the Redis instance.

Type:
@@ -454,7 +454,7 @@
-stats[source]#
+stats[source]

The statsd client that sends metrics.

Type:
@@ -465,7 +465,7 @@
-all_extensions[source]#
+all_extensions[source]

All extensions that were found within the module passed to self.load_extensions. Use self.extensions to get the loaded extensions.

@@ -477,7 +477,7 @@
-__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#
+__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]

Initialise the base bot instance.

Parameters:
@@ -496,7 +496,7 @@ a dummy statsd client will be created.

-async add_cog(cog)[source]#
+async add_cog(cog)[source]

Add the given cog to the bot and log the operation.

Return type:
@@ -507,7 +507,7 @@ a dummy statsd client will be created.

-add_command(command)[source]#
+add_command(command)[source]

Add command as normal and then add its root aliases to the bot.

Return type:
@@ -518,7 +518,7 @@ a dummy statsd client will be created.

-clear()[source]#
+clear()[source]

Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.

Return type:
@@ -529,7 +529,7 @@ a dummy statsd client will be created.

-async close()[source]#
+async close()[source]

Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.

Return type:
@@ -540,7 +540,7 @@ a dummy statsd client will be created.

-async load_extensions(module, *, sync_app_commands=True)[source]#
+async load_extensions(module, *, sync_app_commands=True)[source]

Load all the extensions within the given module and save them to self.all_extensions.

Parameters:
@@ -554,7 +554,7 @@ a dummy statsd client will be created.

-async log_to_dev_log(message)[source]#
+async log_to_dev_log(message)[source]

Log the given message to #dev-log.

Return type:
@@ -565,7 +565,7 @@ a dummy statsd client will be created.

-async on_guild_available(guild)[source]#
+async on_guild_available(guild)[source]

Set the internal guild available event when self.guild_id becomes available.

If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and guild_available_but_cache_empty event will be emitted.

@@ -578,7 +578,7 @@ will not be set and guild_available_but_cache_empty event will be e
-async on_guild_unavailable(guild)[source]#
+async on_guild_unavailable(guild)[source]

Clear the internal guild available event when self.guild_id becomes unavailable.

Return type:
@@ -589,7 +589,7 @@ will not be set and guild_available_but_cache_empty event will be e
-async ping_services()[source]#
+async ping_services()[source]

Ping all required services on setup to ensure they are up before starting.

Return type:
@@ -600,7 +600,7 @@ will not be set and guild_available_but_cache_empty event will be e
-async process_commands(message)[source]#
+async process_commands(message)[source]

Overwrite default Discord.py behaviour to process commands only after ensuring extensions are loaded.

This extension check is only relevant for clients that make use of pydis_core.BotBase.load_extensions.

@@ -612,7 +612,7 @@ will not be set and guild_available_but_cache_empty event will be e
-register_command_error_manager(manager)[source]#
+register_command_error_manager(manager)[source]

Bind an instance of the command error manager to both the bot and the command tree.

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.

@@ -625,7 +625,7 @@ So registration needs to happen once the bot instance has been created.

-remove_command(name)[source]#
+remove_command(name)[source]

Remove a command/alias as normal and then remove its root aliases from the bot.

Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit bot.all_commands.

@@ -638,7 +638,7 @@ To remove them, either remove the entire command or manually edit bot.all_
-async setup_hook()[source]#
+async setup_hook()[source]

An async init to startup generic services.

Connects to statsd, and calls AsyncStatsClient.create_socket @@ -652,7 +652,7 @@ and

-async wait_until_guild_available()[source]#
+async wait_until_guild_available()[source]

Wait until the guild that matches the guild_id given at init is available (and the cache is ready).

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.

@@ -667,14 +667,14 @@ gateway event before giving up and thus not populating the cache for unavailable
-exception EmptyPaginatorEmbedError[source]#
+exception EmptyPaginatorEmbedError[source]

Bases: Exception

Raised when attempting to paginate with empty contents.

-class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]#
+class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]

Bases: Paginator

A class that aids in paginating code blocks for Discord messages.

@@ -691,14 +691,14 @@ gateway event before giving up and thus not populating the cache for unavailable
-__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]#
+__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]

This function overrides the Paginator.__init__ from inside discord.ext.commands.

It overrides in order to allow us to configure the maximum number of lines per page.

-add_line(line='', *, empty=False)[source]#
+add_line(line='', *, empty=False)[source]

Adds a line to the current page.

If a line on a page exceeds max_size characters, then max_size will go up to scale_to_size for a single line before creating a new page for the overflow words. If it @@ -726,7 +726,7 @@ page at a reasonable size.

-async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]#
+async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]

Use a paginator and set of reactions to provide pagination over a set of lines.

The reactions are used to switch page, or to finish with pagination.

When used, this will send a message using ctx.send() and apply a set of reactions to it. These reactions may @@ -770,24 +770,24 @@ to any user with a moderation role.

-class PaginationEmojis(**data)[source]#
+class PaginationEmojis(**data)[source]

Bases: BaseModel

The emojis that will be used for pagination.

-model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#
+model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

-model_config: ClassVar[ConfigDict] = {}#
+model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

-model_fields: ClassVar[dict[str, FieldInfo]] = {'delete': FieldInfo(annotation=str, required=False, default='<:trashcan:637136429717389331>'), 'first': FieldInfo(annotation=str, required=False, default='⏮'), 'last': FieldInfo(annotation=str, required=False, default='⏭'), 'left': FieldInfo(annotation=str, required=False, default='⬅'), 'right': FieldInfo(annotation=str, required=False, default='➡')}#
+model_fields: ClassVar[dict[str, FieldInfo]] = {'delete': FieldInfo(annotation=str, required=False, default='<:trashcan:637136429717389331>'), 'first': FieldInfo(annotation=str, required=False, default='⏮'), 'last': FieldInfo(annotation=str, required=False, default='⏭'), 'left': FieldInfo(annotation=str, required=False, default='⬅'), 'right': FieldInfo(annotation=str, required=False, default='➡')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

@@ -797,18 +797,18 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
-exception StartupError(base)[source]#
+exception StartupError(base)[source]

Bases: Exception

Exception class for startup errors.

-__init__(base)[source]#
+__init__(base)[source]
-

Subpackages#

+

Subpackages

  • Exts
    • @@ -925,7 +925,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
-

Submodules#

+

Submodules

  • async_stats
      @@ -1073,7 +1073,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
- + -- cgit v1.2.3