From 574f77ba8e2d1f1640ac0318b992758d3197abbe Mon Sep 17 00:00:00 2001 From: wookie184 Date: Sun, 19 May 2024 01:32:44 +0000 Subject: Deploying to docs from @ python-discord/bot-core@c296ba30d359c7cd92fd5b4a40d7ef898d603bff 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v11.0.1/output/pydis_core.async_stats.html | 14 ++-- v11.0.1/output/pydis_core.exts.html | 8 +-- v11.0.1/output/pydis_core.html | 80 +++++++++++----------- v11.0.1/output/pydis_core.site_api.html | 34 ++++----- v11.0.1/output/pydis_core.utils.caching.html | 16 ++--- v11.0.1/output/pydis_core.utils.channel.html | 12 ++-- v11.0.1/output/pydis_core.utils.checks.html | 22 +++--- v11.0.1/output/pydis_core.utils.commands.html | 10 +-- v11.0.1/output/pydis_core.utils.cooldown.html | 20 +++--- ...dis_core.utils.error_handling.commands.abc.html | 16 ++--- .../pydis_core.utils.error_handling.commands.html | 26 +++---- ...core.utils.error_handling.commands.manager.html | 16 ++--- .../output/pydis_core.utils.error_handling.html | 12 ++-- v11.0.1/output/pydis_core.utils.function.html | 20 +++--- v11.0.1/output/pydis_core.utils.html | 16 ++--- v11.0.1/output/pydis_core.utils.interactions.html | 26 +++---- v11.0.1/output/pydis_core.utils.lock.html | 30 ++++---- v11.0.1/output/pydis_core.utils.logging.html | 16 ++--- v11.0.1/output/pydis_core.utils.members.html | 12 ++-- v11.0.1/output/pydis_core.utils.messages.html | 10 +-- v11.0.1/output/pydis_core.utils.pagination.html | 26 +++---- v11.0.1/output/pydis_core.utils.paste_service.html | 34 ++++----- v11.0.1/output/pydis_core.utils.regex.html | 14 ++-- v11.0.1/output/pydis_core.utils.scheduling.html | 26 +++---- 24 files changed, 258 insertions(+), 258 deletions(-) (limited to 'v11.0.1/output') diff --git a/v11.0.1/output/pydis_core.async_stats.html b/v11.0.1/output/pydis_core.async_stats.html index f745c507..7c04ca4e 100644 --- a/v11.0.1/output/pydis_core.async_stats.html +++ b/v11.0.1/output/pydis_core.async_stats.html @@ -5,14 +5,14 @@ - + async_stats - Pydis Core v11.0.1 - + @@ -390,16 +390,16 @@
-

async_stats#

+

async_stats

An async transport method for statsd communication.

-class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]#
+class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]

Bases: StatsClientBase

An async implementation of statsd.client.base.StatsClientBase that supports async stat communication.

-__init__(loop, host='localhost', port=8125, prefix=None)[source]#
+__init__(loop, host='localhost', port=8125, prefix=None)[source]

Create a new AsyncStatsClient.

Parameters:
@@ -416,7 +416,7 @@
-async create_socket()[source]#
+async create_socket()[source]

Use asyncio.loop.create_datagram_endpoint from the loop given on init to create a socket.

Return type:
@@ -502,7 +502,7 @@ - + diff --git a/v11.0.1/output/pydis_core.exts.html b/v11.0.1/output/pydis_core.exts.html index 40cff5bd..68027042 100644 --- a/v11.0.1/output/pydis_core.exts.html +++ b/v11.0.1/output/pydis_core.exts.html @@ -5,14 +5,14 @@ - + Exts - Pydis Core v11.0.1 - + @@ -390,7 +390,7 @@
-

Exts#

+

Exts

Reusable Discord cogs.

@@ -444,7 +444,7 @@ - + diff --git a/v11.0.1/output/pydis_core.html b/v11.0.1/output/pydis_core.html index 0ed56f52..9d6b8ed5 100644 --- a/v11.0.1/output/pydis_core.html +++ b/v11.0.1/output/pydis_core.html @@ -5,14 +5,14 @@ - + Pydis Core - Pydis Core v11.0.1 - + @@ -390,16 +390,16 @@
-

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].
- + diff --git a/v11.0.1/output/pydis_core.site_api.html b/v11.0.1/output/pydis_core.site_api.html index 580d3f13..ba208090 100644 --- a/v11.0.1/output/pydis_core.site_api.html +++ b/v11.0.1/output/pydis_core.site_api.html @@ -5,14 +5,14 @@ - + site_api - Pydis Core v11.0.1 - + @@ -390,16 +390,16 @@
-

site_api#

+

site_api

An API wrapper around the Site API.

-class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
+class APIClient(site_api_url, site_api_token, **session_kwargs)[source]

Bases: object

A wrapper for the Django Site API.

-__init__(site_api_url, site_api_token, **session_kwargs)[source]#
+__init__(site_api_url, site_api_token, **session_kwargs)[source]

Initialize a new APIClient instance.

Parameters:
@@ -414,7 +414,7 @@
-async close()[source]#
+async close()[source]

Close the aiohttp session.

Return type:
@@ -425,7 +425,7 @@
-async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async delete(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with DELETE passed as the method.

Return type:
@@ -436,7 +436,7 @@
-async get(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async get(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with GET passed as the method.

Return type:
@@ -447,7 +447,7 @@
-async static maybe_raise_for_status(response, *, should_raise)[source]#
+async static maybe_raise_for_status(response, *, should_raise)[source]

Raise ResponseCodeError for non-OK response if an exception should be raised.

Parameters:
@@ -467,7 +467,7 @@
-async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async patch(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with PATCH passed as the method.

Return type:
@@ -478,7 +478,7 @@
-async post(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async post(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with POST passed as the method.

Return type:
@@ -489,7 +489,7 @@
-async put(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async put(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with PUT passed as the method.

Return type:
@@ -500,7 +500,7 @@
-async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#
+async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]

Send an HTTP request to the site API and return the JSON response.

Parameters:
@@ -527,12 +527,12 @@
-exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
+exception ResponseCodeError(response, response_json=None, response_text=None)[source]

Bases: ValueError

Raised in APIClient.request() when a non-OK HTTP response is received.

-__init__(response, response_json=None, response_text=None)[source]#
+__init__(response, response_json=None, response_text=None)[source]

Initialize a new ResponseCodeError instance.

Parameters:
@@ -547,7 +547,7 @@
-__str__()[source]#
+__str__()[source]

Return a string representation of the error.

@@ -640,7 +640,7 @@ - + diff --git a/v11.0.1/output/pydis_core.utils.caching.html b/v11.0.1/output/pydis_core.utils.caching.html index d8f71091..f87600b4 100644 --- a/v11.0.1/output/pydis_core.utils.caching.html +++ b/v11.0.1/output/pydis_core.utils.caching.html @@ -5,14 +5,14 @@ - + caching - Pydis Core v11.0.1 - + @@ -390,18 +390,18 @@
-

caching#

+

caching

Utilities related to custom caches.

-class AsyncCache(max_size=128)[source]#
+class AsyncCache(max_size=128)[source]

Bases: object

LRU cache implementation for coroutines.

Once the cache exceeds the maximum size, keys are deleted in FIFO order.

An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.

-__call__(arg_offset=0)[source]#
+__call__(arg_offset=0)[source]

Decorator for async cache.

Parameters:
@@ -418,7 +418,7 @@
-__init__(max_size=128)[source]#
+__init__(max_size=128)[source]

Initialise a new AsyncCache instance.

Parameters:
@@ -429,7 +429,7 @@
-clear()[source]#
+clear()[source]

Clear cache instance.

Return type:
@@ -516,7 +516,7 @@ - + diff --git a/v11.0.1/output/pydis_core.utils.channel.html b/v11.0.1/output/pydis_core.utils.channel.html index 9f150f42..1a4e932f 100644 --- a/v11.0.1/output/pydis_core.utils.channel.html +++ b/v11.0.1/output/pydis_core.utils.channel.html @@ -5,14 +5,14 @@ - + channel - Pydis Core v11.0.1 - + @@ -390,11 +390,11 @@
-

channel#

+

channel

Useful helper functions for interacting with various discord channel objects.

-async get_or_fetch_channel(bot, channel_id)[source]#
+async get_or_fetch_channel(bot, channel_id)[source]

Attempt to get or fetch the given channel_id from the bots cache, and return it.

Parameters:
@@ -422,7 +422,7 @@
-is_in_category(channel, category_id)[source]#
+is_in_category(channel, category_id)[source]

Return whether the given channel in the the category with the id category_id.

Parameters:
@@ -512,7 +512,7 @@ - + diff --git a/v11.0.1/output/pydis_core.utils.checks.html b/v11.0.1/output/pydis_core.utils.checks.html index 9a901df2..663cf35a 100644 --- a/v11.0.1/output/pydis_core.utils.checks.html +++ b/v11.0.1/output/pydis_core.utils.checks.html @@ -5,14 +5,14 @@ - + checks - Pydis Core v11.0.1 - + @@ -390,29 +390,29 @@
-

checks#

+

checks

-exception ContextCheckFailure(redirect_channel)[source]#
+exception ContextCheckFailure(redirect_channel)[source]

Bases: CheckFailure

Raised when a context-specific check fails.

-__init__(redirect_channel)[source]#
+__init__(redirect_channel)[source]
-exception InWhitelistCheckFailure(redirect_channel)[source]#
+exception InWhitelistCheckFailure(redirect_channel)[source]

Bases: ContextCheckFailure

Raised when the in_whitelist check fails.

-cooldown_with_role_bypass(rate, per, type_=('default', 0), *, bypass_roles)[source]#
+cooldown_with_role_bypass(rate, per, type_=('default', 0), *, bypass_roles)[source]

Decorate a command to have a cooldown, which can be bypassed by users with specified roles.

Note: This replaces the Command.before_invoke callback, which might introduce problems in the future.

@@ -438,7 +438,7 @@
-async has_any_role_check(ctx, *roles)[source]#
+async has_any_role_check(ctx, *roles)[source]

Verify if the context’s author has any of the specified roles.

This check will always fail if the context is a DM, since DMs don’t have roles.

@@ -459,7 +459,7 @@
-async has_no_roles_check(ctx, *roles)[source]#
+async has_no_roles_check(ctx, *roles)[source]

Verify if the context’s author doesn’t have any of the specified roles.

This check will always fail if the context is a DM, since DMs don’t have roles.

@@ -480,7 +480,7 @@
-in_whitelist_check(ctx, redirect, channels=(), categories=(), roles=(), *, fail_silently=False)[source]#
+in_whitelist_check(ctx, redirect, channels=(), categories=(), roles=(), *, fail_silently=False)[source]

Check if a command was issued in a context that is whitelisted by channel, category, or roles.

Parameters:
@@ -584,7 +584,7 @@ - + diff --git a/v11.0.1/output/pydis_core.utils.commands.html b/v11.0.1/output/pydis_core.utils.commands.html index 69c1f51e..29cd6083 100644 --- a/v11.0.1/output/pydis_core.utils.commands.html +++ b/v11.0.1/output/pydis_core.utils.commands.html @@ -5,14 +5,14 @@ - + commands - Pydis Core v11.0.1 - + @@ -390,10 +390,10 @@
-

commands#

+

commands

-async clean_text_or_reply(ctx, text=None)[source]#
+async clean_text_or_reply(ctx, text=None)[source]

Cleans a text argument or replied message’s content.

Parameters:
@@ -485,7 +485,7 @@ - + diff --git a/v11.0.1/output/pydis_core.utils.cooldown.html b/v11.0.1/output/pydis_core.utils.cooldown.html index 2cddeb12..82189e44 100644 --- a/v11.0.1/output/pydis_core.utils.cooldown.html +++ b/v11.0.1/output/pydis_core.utils.cooldown.html @@ -5,14 +5,14 @@ - + cooldown - Pydis Core v11.0.1 - + @@ -390,21 +390,21 @@
-

cooldown#

+

cooldown

Helpers for setting a cooldown on commands.

-exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]#
+exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]

Bases: CommandError, Generic[P, R]

Raised when a command is invoked while on cooldown.

-__init__(message, function, /, *args, **kwargs)[source]#
+__init__(message, function, /, *args, **kwargs)[source]
-async call_without_cooldown()[source]#
+async call_without_cooldown()[source]

Run the command this cooldown blocked.

Return type:
@@ -420,20 +420,20 @@
-P = ~P[source]#
+P = ~P[source]

The command’s signature.

-class R[source]#
+class R[source]

The command’s return value.

alias of TypeVar(‘R’)

-block_duplicate_invocations(*, cooldown_duration=5, send_notice=False, args_preprocessor=None)[source]#
+block_duplicate_invocations(*, cooldown_duration=5, send_notice=False, args_preprocessor=None)[source]

Prevent duplicate invocations of a command with the same arguments in a channel for cooldown_duration seconds.

Parameters:
@@ -535,7 +535,7 @@ its return value is then used to check for the cooldown instead of the raw argum - + diff --git a/v11.0.1/output/pydis_core.utils.error_handling.commands.abc.html b/v11.0.1/output/pydis_core.utils.error_handling.commands.abc.html index 71c8ede0..a574bd80 100644 --- a/v11.0.1/output/pydis_core.utils.error_handling.commands.abc.html +++ b/v11.0.1/output/pydis_core.utils.error_handling.commands.abc.html @@ -5,14 +5,14 @@ - + abc - Pydis Core v11.0.1 - + @@ -390,15 +390,15 @@
-

abc#

+

abc

-class AbstractCommandErrorHandler[source]#
+class AbstractCommandErrorHandler[source]

Bases: ABC

An abstract command error handler.

-abstract async handle_app_command_error(interaction, error)[source]#
+abstract async handle_app_command_error(interaction, error)[source]

Handle error raised in the context of app commands.

Return type:
@@ -409,7 +409,7 @@
-abstract async handle_text_command_error(context, error)[source]#
+abstract async handle_text_command_error(context, error)[source]

Handle error raised in the context of text commands.

Return type:
@@ -420,7 +420,7 @@
-abstract async should_handle_error(error)[source]#
+abstract async should_handle_error(error)[source]

A predicate that determines whether the error should be handled.

Return type:
@@ -507,7 +507,7 @@ - + diff --git a/v11.0.1/output/pydis_core.utils.error_handling.commands.html b/v11.0.1/output/pydis_core.utils.error_handling.commands.html index d4a729fb..6911a0e6 100644 --- a/v11.0.1/output/pydis_core.utils.error_handling.commands.html +++ b/v11.0.1/output/pydis_core.utils.error_handling.commands.html @@ -5,14 +5,14 @@ - + commands package - Pydis Core v11.0.1 - + @@ -390,15 +390,15 @@
-

commands package#

+

commands package

-class AbstractCommandErrorHandler[source]#
+class AbstractCommandErrorHandler[source]

Bases: ABC

An abstract command error handler.

-abstract async handle_app_command_error(interaction, error)[source]#
+abstract async handle_app_command_error(interaction, error)[source]

Handle error raised in the context of app commands.

Return type:
@@ -409,7 +409,7 @@
-abstract async handle_text_command_error(context, error)[source]#
+abstract async handle_text_command_error(context, error)[source]

Handle error raised in the context of text commands.

Return type:
@@ -420,7 +420,7 @@
-abstract async should_handle_error(error)[source]#
+abstract async should_handle_error(error)[source]

A predicate that determines whether the error should be handled.

Return type:
@@ -433,17 +433,17 @@
-class CommandErrorManager(default)[source]#
+class CommandErrorManager(default)[source]

Bases: object

A class that registers error handlers and handles all command related errors.

-__init__(default)[source]#
+__init__(default)[source]
-async handle_error(error, context_or_interaction)[source]#
+async handle_error(error, context_or_interaction)[source]

Handle a Discord exception.

Iterate through available handlers by registration order, and choose the first one capable of handling the error as determined by should_handle_error; there is no priority system.

@@ -456,7 +456,7 @@ the error as determined by should_handle_error; there is no priorit
-register_handler(handler)[source]#
+register_handler(handler)[source]

Register a command error handler.

Return type:
@@ -468,7 +468,7 @@ the error as determined by should_handle_error; there is no priorit
-

Submodules#

+

Submodules

  • abc
      @@ -575,7 +575,7 @@ the error as determined by should_handle_error; there is no priorit
- + diff --git a/v11.0.1/output/pydis_core.utils.error_handling.commands.manager.html b/v11.0.1/output/pydis_core.utils.error_handling.commands.manager.html index 2a9afe32..82b29ab4 100644 --- a/v11.0.1/output/pydis_core.utils.error_handling.commands.manager.html +++ b/v11.0.1/output/pydis_core.utils.error_handling.commands.manager.html @@ -5,14 +5,14 @@ - + manager - Pydis Core v11.0.1 - + @@ -390,20 +390,20 @@
-

manager#

+

manager

-class CommandErrorManager(default)[source]#
+class CommandErrorManager(default)[source]

Bases: object

A class that registers error handlers and handles all command related errors.

-__init__(default)[source]#
+__init__(default)[source]
-async handle_error(error, context_or_interaction)[source]#
+async handle_error(error, context_or_interaction)[source]

Handle a Discord exception.

Iterate through available handlers by registration order, and choose the first one capable of handling the error as determined by should_handle_error; there is no priority system.

@@ -416,7 +416,7 @@ the error as determined by should_handle_error; there is no priorit
-register_handler(handler)[source]#
+register_handler(handler)[source]

Register a command error handler.

Return type:
@@ -503,7 +503,7 @@ the error as determined by should_handle_error; there is no priorit - + diff --git a/v11.0.1/output/pydis_core.utils.error_handling.html b/v11.0.1/output/pydis_core.utils.error_handling.html index c08213a2..758a4414 100644 --- a/v11.0.1/output/pydis_core.utils.error_handling.html +++ b/v11.0.1/output/pydis_core.utils.error_handling.html @@ -5,14 +5,14 @@ - + error_handling package - Pydis Core v11.0.1 - + @@ -390,10 +390,10 @@
-

error_handling package#

+

error_handling package

-async handle_forbidden_from_block(error, message=None)[source]#
+async handle_forbidden_from_block(error, message=None)[source]

Handles discord.Forbidden 90001 errors, or re-raises if error isn’t a 90001 error.

Parameters:
@@ -409,7 +409,7 @@
-

Subpackages#

+

Subpackages

- + diff --git a/v11.0.1/output/pydis_core.utils.function.html b/v11.0.1/output/pydis_core.utils.function.html index 3d5d3299..fde4127c 100644 --- a/v11.0.1/output/pydis_core.utils.function.html +++ b/v11.0.1/output/pydis_core.utils.function.html @@ -5,14 +5,14 @@ - + function - Pydis Core v11.0.1 - + @@ -390,18 +390,18 @@
-

function#

+

function

Utils for manipulating functions.

-exception GlobalNameConflictError[source]#
+exception GlobalNameConflictError[source]

Bases: Exception

Raised on a conflict between the globals used to resolve annotations of a wrapped function and its wrapper.

-command_wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__',), *, ignored_conflict_names=frozenset({}))[source]#
+command_wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__',), *, ignored_conflict_names=frozenset({}))[source]

Update the decorated function to look like wrapped, and update globals for discord.py forwardref evaluation.

See update_wrapper_globals() for more details on how the globals are updated.

@@ -425,7 +425,7 @@ with the wrapper replaced with the function
-get_arg_value(name_or_pos, arguments)[source]#
+get_arg_value(name_or_pos, arguments)[source]

Return a value from arguments based on a name or position.

Parameters:
@@ -448,7 +448,7 @@ with the wrapper replaced with the function
-get_arg_value_wrapper(decorator_func, name_or_pos, func=None)[source]#
+get_arg_value_wrapper(decorator_func, name_or_pos, func=None)[source]

Call decorator_func with the value of the arg at the given name/position.

Parameters:
@@ -470,7 +470,7 @@ parameter names to argument values of the function it’s decorating.

-get_bound_args(func, args, kwargs)[source]#
+get_bound_args(func, args, kwargs)[source]

Bind args and kwargs to func and return a mapping of parameter names to argument values.

Default parameter values are also set.

@@ -492,7 +492,7 @@ parameter names to argument values of the function it’s decorating.

-update_wrapper_globals(wrapper, wrapped, *, ignored_conflict_names=frozenset({}))[source]#
+update_wrapper_globals(wrapper, wrapped, *, ignored_conflict_names=frozenset({}))[source]

Create a copy of wrapper, the copy’s globals are updated with wrapped's globals.

For forwardrefs in command annotations, discord.py uses the __global__ attribute of the function to resolve their values. This breaks for decorators that replace the function because they have @@ -596,7 +596,7 @@ changes won’t be reflected in the new function’s globals.

- + diff --git a/v11.0.1/output/pydis_core.utils.html b/v11.0.1/output/pydis_core.utils.html index 58fd5219..abf2cfb3 100644 --- a/v11.0.1/output/pydis_core.utils.html +++ b/v11.0.1/output/pydis_core.utils.html @@ -5,14 +5,14 @@ - + Utils - Pydis Core v11.0.1 - + @@ -390,11 +390,11 @@
-

Utils#

+

Utils

Useful utilities and tools for Discord bot development.

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

Applies all common monkey patches for our bots.

Return type:
@@ -413,7 +413,7 @@ that will act as top-level groups rather than being aliases of the command’s g
-unqualify(name)[source]#
+unqualify(name)[source]

Return an unqualified name given a qualified module/package name.

Parameters:
@@ -429,7 +429,7 @@ that will act as top-level groups rather than being aliases of the command’s g
-

Subpackages#

+

Subpackages

  • error_handling package
      @@ -449,7 +449,7 @@ that will act as top-level groups rather than being aliases of the command’s g
-

Submodules#

+

Submodules

  • caching
      @@ -687,7 +687,7 @@ that will act as top-level groups rather than being aliases of the command’s g
- + diff --git a/v11.0.1/output/pydis_core.utils.interactions.html b/v11.0.1/output/pydis_core.utils.interactions.html index 14ad84fb..0ead26ec 100644 --- a/v11.0.1/output/pydis_core.utils.interactions.html +++ b/v11.0.1/output/pydis_core.utils.interactions.html @@ -5,14 +5,14 @@ - + interactions - Pydis Core v11.0.1 - + @@ -390,10 +390,10 @@
-

interactions#

+

interactions

-class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]#
+class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]

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.

@@ -408,12 +408,12 @@
-__init__(*, style=('secondary', 2), label='Delete', **kwargs)[source]#
+__init__(*, style=('secondary', 2), label='Delete', **kwargs)[source]
-async callback(interaction)[source]#
+async callback(interaction)[source]

Delete the original message on button click.

Return type:
@@ -426,7 +426,7 @@
-class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]#
+class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]

Bases: View

A view that allows the original invoker and moderators to interact with it.

@@ -443,12 +443,12 @@ If None
-__init__(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]#
+__init__(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]
-async interaction_check(interaction)[source]#
+async interaction_check(interaction)[source]

Ensure the user clicking the button is the view invoker, or a moderator.

Parameters:
@@ -462,7 +462,7 @@ If None
-async on_timeout()[source]#
+async on_timeout()[source]

Remove the view from self.message if set.

Return type:
@@ -473,7 +473,7 @@ If None
-stop()[source]#
+stop()[source]

Stop listening for interactions, and remove the view from self.message if set.

Return type:
@@ -486,7 +486,7 @@ If None
-user_has_access(user, *, allowed_users=(), allowed_roles=())[source]#
+user_has_access(user, *, allowed_users=(), allowed_roles=())[source]

Return whether the user is in the allowed_users list, or has a role from allowed_roles.

Parameters:
@@ -585,7 +585,7 @@ If None - + diff --git a/v11.0.1/output/pydis_core.utils.lock.html b/v11.0.1/output/pydis_core.utils.lock.html index c33d0485..819622e6 100644 --- a/v11.0.1/output/pydis_core.utils.lock.html +++ b/v11.0.1/output/pydis_core.utils.lock.html @@ -5,14 +5,14 @@ - + lock - Pydis Core v11.0.1 - + @@ -390,15 +390,15 @@
-

lock#

+

lock

-exception LockedResourceError(resource_type, resource_id)[source]#
+exception LockedResourceError(resource_type, resource_id)[source]

Bases: RuntimeError

Exception raised when an operation is attempted on a locked resource.

-type[source]#
+type[source]

Name of the locked resource’s type

Type:
@@ -409,7 +409,7 @@
-id[source]#
+id[source]

ID of the locked resource

Type:
@@ -420,38 +420,38 @@
-__init__(resource_type, resource_id)[source]#
+__init__(resource_type, resource_id)[source]
-class SharedEvent[source]#
+class SharedEvent[source]

Bases: object

Context manager managing an internal event exposed through the wait coro.

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.

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

Increment the count of the active holders and clear the internal event.

-__exit__(_exc_type, _exc_val, _exc_tb)[source]#
+__exit__(_exc_type, _exc_val, _exc_tb)[source]

Decrement the count of the active holders; if 0 is reached set the internal event.

-__init__()[source]#
+__init__()[source]
-async wait()[source]#
+async wait()[source]

Wait for all active holders to exit.

Return type:
@@ -464,7 +464,7 @@ when all of the holders finish the event will be set.

-lock(namespace, resource_id, *, raise_error=False, wait=False)[source]#
+lock(namespace, resource_id, *, raise_error=False, wait=False)[source]

Turn the decorated coroutine function into a mutually exclusive operation on a resource_id.

If decorating a command, this decorator must go before (below) the command decorator.

@@ -491,7 +491,7 @@ and return None.

-lock_arg(namespace, name_or_pos, func=None, *, raise_error=False, wait=False)[source]#
+lock_arg(namespace, name_or_pos, func=None, *, raise_error=False, wait=False)[source]

Apply the lock decorator using the value of the arg at the given name/position as the ID.

See lock docs for more information.

@@ -589,7 +589,7 @@ and return None.

- + diff --git a/v11.0.1/output/pydis_core.utils.logging.html b/v11.0.1/output/pydis_core.utils.logging.html index 6600b7d8..3a95c036 100644 --- a/v11.0.1/output/pydis_core.utils.logging.html +++ b/v11.0.1/output/pydis_core.utils.logging.html @@ -5,14 +5,14 @@ - + logging - Pydis Core v11.0.1 - + @@ -390,16 +390,16 @@
-

logging#

+

logging

Common logging related functions.

-class CustomLogger(name, level=0)[source]#
+class CustomLogger(name, level=0)[source]

Bases: Logger

Custom implementation of the logging.Logger class with an added trace method.

-trace(msg, *args, **kwargs)[source]#
+trace(msg, *args, **kwargs)[source]

Log the given message with the severity "TRACE".

To pass exception information, use the keyword argument exc_info with a true value:

logger.trace("Houston, we have an %s", "interesting problem", exc_info=1)
@@ -423,7 +423,7 @@
 
 

 

-get_logger(name=None)[source]#

+get_logger(name=None)[source]
 
Utility to make mypy recognise that logger is of type CustomLogger.

 

 
Parameters:

@@ -440,7 +440,7 @@
 
 

 

-log_format[source]#

+log_format[source]
 
A logging.Formatter that can be used to standardise logging across all projects using pydis_core.

 

 

@@ -522,7 +522,7 @@
- + diff --git a/v11.0.1/output/pydis_core.utils.members.html b/v11.0.1/output/pydis_core.utils.members.html index 74b49db0..67c33d32 100644 --- a/v11.0.1/output/pydis_core.utils.members.html +++ b/v11.0.1/output/pydis_core.utils.members.html @@ -5,14 +5,14 @@ - + members - Pydis Core v11.0.1 - + @@ -390,11 +390,11 @@
-

members#

+

members

Useful helper functions for interactin with discord.Member objects.

-async get_or_fetch_member(guild, member_id)[source]#
+async get_or_fetch_member(guild, member_id)[source]

Attempt to get a member from cache; on failure fetch from the API.

Return type:
@@ -408,7 +408,7 @@
-async handle_role_change(member, coro, role)[source]#
+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.

@@ -498,7 +498,7 @@ - + diff --git a/v11.0.1/output/pydis_core.utils.messages.html b/v11.0.1/output/pydis_core.utils.messages.html index aeb53921..37f3c4c9 100644 --- a/v11.0.1/output/pydis_core.utils.messages.html +++ b/v11.0.1/output/pydis_core.utils.messages.html @@ -5,14 +5,14 @@ - + messages - Pydis Core v11.0.1 - + @@ -390,10 +390,10 @@
-

messages#

+

messages

-reaction_check(reaction, user, *, message_id, allowed_emoji, allowed_users, allowed_roles=None)[source]#
+reaction_check(reaction, user, *, message_id, allowed_emoji, allowed_users, allowed_roles=None)[source]

Check if a reaction’s emoji and author are allowed and the message is message_id.

If the user is not allowed, remove the reaction. Ignore reactions made by the bot. If allow_mods is True, allow users with moderator roles even if they’re not in allowed_users.

@@ -475,7 +475,7 @@ If allow_mods is True, allow users with moderator roles even if the - + diff --git a/v11.0.1/output/pydis_core.utils.pagination.html b/v11.0.1/output/pydis_core.utils.pagination.html index b7f5216a..97b04b25 100644 --- a/v11.0.1/output/pydis_core.utils.pagination.html +++ b/v11.0.1/output/pydis_core.utils.pagination.html @@ -5,14 +5,14 @@ - + pagination - Pydis Core v11.0.1 - + @@ -390,17 +390,17 @@
-

pagination#

+

pagination

-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.

@@ -417,14 +417,14 @@
-__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 @@ -452,7 +452,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 @@ -496,24 +496,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.

@@ -604,7 +604,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo]. - + diff --git a/v11.0.1/output/pydis_core.utils.paste_service.html b/v11.0.1/output/pydis_core.utils.paste_service.html index bd6dde26..f7510466 100644 --- a/v11.0.1/output/pydis_core.utils.paste_service.html +++ b/v11.0.1/output/pydis_core.utils.paste_service.html @@ -5,14 +5,14 @@ - + paste_service - Pydis Core v11.0.1 - + @@ -390,16 +390,16 @@
-

paste_service#

+

paste_service

-MAX_PASTE_SIZE = 524288[source]#
+MAX_PASTE_SIZE = 524288[source]

The maximum allows size of a paste, in bytes.

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

Bases: BaseModel

A file to be pasted to the paste service.

@@ -413,19 +413,19 @@
-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]] = {'content': FieldInfo(annotation=str, required=True), 'lexer': FieldInfo(annotation=str, required=False, default='python'), 'name': FieldInfo(annotation=str, required=False, default='')}#
+model_fields: ClassVar[dict[str, FieldInfo]] = {'content': FieldInfo(annotation=str, required=True), 'lexer': FieldInfo(annotation=str, required=False, default='python'), 'name': 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.

@@ -435,7 +435,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
-class PasteResponse(**data)[source]#
+class PasteResponse(**data)[source]

Bases: BaseModel

A successful response from the paste service.

@@ -448,19 +448,19 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
-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]] = {'link': FieldInfo(annotation=str, required=True), 'removal': FieldInfo(annotation=str, required=True)}#
+model_fields: ClassVar[dict[str, FieldInfo]] = {'link': FieldInfo(annotation=str, required=True), 'removal': FieldInfo(annotation=str, required=True)}

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

This replaces Model.__fields__ from Pydantic V1.

@@ -470,28 +470,28 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
-exception PasteTooLongError[source]#
+exception PasteTooLongError[source]

Bases: Exception

Raised when content is too large to upload to the paste service.

-exception PasteUnsupportedLexerError[source]#
+exception PasteUnsupportedLexerError[source]

Bases: Exception

Raised when an unsupported lexer is used.

-exception PasteUploadError[source]#
+exception PasteUploadError[source]

Bases: Exception

Raised when an error is encountered uploading to the paste service.

-async send_to_paste_service(*, files, http_session, paste_url='https://paste.pythondiscord.com', max_size=524288)[source]#
+async send_to_paste_service(*, files, http_session, paste_url='https://paste.pythondiscord.com', max_size=524288)[source]

Upload some contents to the paste service.

Parameters:
@@ -605,7 +605,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo]. - + diff --git a/v11.0.1/output/pydis_core.utils.regex.html b/v11.0.1/output/pydis_core.utils.regex.html index 767db2e1..71ee9f69 100644 --- a/v11.0.1/output/pydis_core.utils.regex.html +++ b/v11.0.1/output/pydis_core.utils.regex.html @@ -5,14 +5,14 @@ - + regex - Pydis Core v11.0.1 - + @@ -390,11 +390,11 @@
-

regex#

+

regex

Common regular expressions.

-DISCORD_INVITE[source]#
+DISCORD_INVITE[source]

Regex for Discord server invites.

Warning

@@ -408,7 +408,7 @@ such as
-FORMATTED_CODE_REGEX[source]#
+FORMATTED_CODE_REGEX[source]

Regex for formatted code, using Discord’s code blocks.

@@ -416,7 +416,7 @@ such as
-RAW_CODE_REGEX[source]#
+RAW_CODE_REGEX[source]

Regex for raw code, not using Discord’s code blocks.

@@ -495,7 +495,7 @@ such as - + diff --git a/v11.0.1/output/pydis_core.utils.scheduling.html b/v11.0.1/output/pydis_core.utils.scheduling.html index 8368f248..7eaa51fe 100644 --- a/v11.0.1/output/pydis_core.utils.scheduling.html +++ b/v11.0.1/output/pydis_core.utils.scheduling.html @@ -5,14 +5,14 @@ - + scheduling - Pydis Core v11.0.1 - + @@ -390,11 +390,11 @@
-

scheduling#

+

scheduling

Generic python scheduler.

-class Scheduler(name)[source]#
+class Scheduler(name)[source]

Bases: object

Schedule the execution of coroutines and keep track of them.

When instantiating a Scheduler, a name must be provided. This name is used to distinguish the @@ -408,7 +408,7 @@ the same ID used to schedule it.

Any exception raised in a scheduled task is logged when the task is done.

-__contains__(task_id)[source]#
+__contains__(task_id)[source]

Return True if a task with the given task_id is currently scheduled.

Parameters:
@@ -425,7 +425,7 @@ the same ID used to schedule it.

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

Initialize a new Scheduler instance.

Parameters:
@@ -436,7 +436,7 @@ the same ID used to schedule it.

-cancel(task_id)[source]#
+cancel(task_id)[source]

Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

Parameters:
@@ -450,7 +450,7 @@ the same ID used to schedule it.

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

Unschedule all known tasks.

Return type:
@@ -461,7 +461,7 @@ the same ID used to schedule it.

-schedule(task_id, coroutine)[source]#
+schedule(task_id, coroutine)[source]

Schedule the execution of a coroutine.

If a task with task_id already exists, close coroutine instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

@@ -480,7 +480,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
-schedule_at(time, task_id, coroutine)[source]#
+schedule_at(time, task_id, coroutine)[source]

Schedule coroutine to be executed at the given time.

If time is timezone aware, then use that timezone to calculate now() when subtracting. If time is naïve, then use UTC.

@@ -503,7 +503,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
-schedule_later(delay, task_id, coroutine)[source]#
+schedule_later(delay, task_id, coroutine)[source]

Schedule coroutine to be executed after delay seconds.

If a task with task_id already exists, close coroutine instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

@@ -525,7 +525,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
-create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
+create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]

Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

If the event_loop kwarg is provided, the task is created from that event loop, otherwise the running loop is used.

@@ -628,7 +628,7 @@ otherwise the running loop is used.

- + -- cgit v1.2.3