An async transport method for statsd communication.
Bases: StatsClientBase
An async implementation of statsd.client.base.StatsClientBase that supports async stat communication.
Create a new AsyncStatsClient.
Use asyncio.loop.create_datagram_endpoint from the loop given on init to create a socket.
Useful utilities and tools for Discord bot development.
Bases: Bot
A sub-class that implements many common features that Python Discord bots use.
ID of the guild that the bot belongs to.
The http session used for sending out HTTP requests.
The API client used for communications with the site service.
The url that statsd sends metrics to.
The redis session used to communicate with the Redis instance.
The statsd client that sends metrics.
All extensions that were found within the module passed to
self.load_extensions. Use self.extensions to get the loaded extensions.
Initialise the base bot instance.
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.
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.
@@ -649,7 +649,7 @@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.
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.
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.
@@ -696,7 +696,7 @@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.
@@ -709,7 +709,7 @@An async init to startup generic services.
Connects to statsd, and calls
AsyncStatsClient.create_socket
@@ -723,7 +723,7 @@
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.
@@ -738,14 +738,14 @@Bases: Exception
Raised when attempting to paginate with empty contents.
Bases: Paginator
A class that aids in paginating code blocks for Discord messages.
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.
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 @@ -797,7 +797,7 @@
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 @@ -841,7 +841,7 @@
Bases: BaseModel
The emojis that will be used for pagination.
Bases: Exception
Exception class for startup errors.
An API wrapper around the Site API.
Bases: object
A wrapper for the Django Site API.
Initialize a new APIClient instance.
Close the aiohttp session.
Equivalent to APIClient.request() with DELETE passed as the method.
Equivalent to APIClient.request() with GET passed as the method.
Raise ResponseCodeError for non-OK response if an exception should be raised.
Equivalent to APIClient.request() with PATCH passed as the method.
Equivalent to APIClient.request() with POST passed as the method.
Equivalent to APIClient.request() with PUT passed as the method.
Send an HTTP request to the site API and return the JSON response.
Bases: ValueError
Raised in APIClient.request() when a non-OK HTTP response is received.
Initialize a new ResponseCodeError instance.
Utilities related to custom caches.
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.
Decorator for async cache.
Initialise a new AsyncCache instance.
Clear cache instance.
Useful helper functions for interacting with various discord channel objects.
Attempt to get or fetch the given channel_id from the bots cache, and return it.
Return whether the given channel in the the category with the id category_id.
Bases: CheckFailure
Raised when a context-specific check fails.
Bases: ContextCheckFailure
Raised when the in_whitelist check fails.
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.
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.
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.
Check if a command was issued in a context that is whitelisted by channel, category, or roles.
Cleans a text argument or replied message’s content.
Helpers for setting a cooldown on commands.
Bases: CommandError, Generic[P, R]
Raised when a command is invoked while on cooldown.
Run the command this cooldown blocked.
Prevent duplicate invocations of a command with the same arguments in a channel for cooldown_duration seconds.
Bases: ABC
An abstract command error handler.
Handle error raised in the context of app commands.
Handle error raised in the context of text commands.
A predicate that determines whether the error should be handled.
Bases: ABC
An abstract command error handler.
Handle error raised in the context of app commands.
Handle error raised in the context of text commands.
A predicate that determines whether the error should be handled.
Bases: object
A class that registers error handlers and handles all command related errors.
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.
@@ -527,7 +527,7 @@Register a command error handler.
Bases: object
A class that registers error handlers and handles all command related errors.
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.
@@ -487,7 +487,7 @@Register a command error handler.
Handles discord.Forbidden 90001 errors, or re-raises if error isn’t a 90001 error.
Utils for manipulating functions.
Bases: Exception
Raised on a conflict between the globals used to resolve annotations of a wrapped function and its wrapper.
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.
Return a value from arguments based on a name or position.
Call decorator_func with the value of the arg at the given name/position.
Bind args and kwargs to func and return a mapping of parameter names to argument values.
Default parameter values are also set.
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
diff --git a/main/output/pydis_core.utils.html b/main/output/pydis_core.utils.html
index 1e58839c1..d66662df6 100644
--- a/main/output/pydis_core.utils.html
+++ b/main/output/pydis_core.utils.html
@@ -465,7 +465,7 @@
Useful utilities and tools for Discord bot development.
Applies all common monkey patches for our bots.
Return an unqualified name given a qualified module/package name.
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.
@@ -479,12 +479,12 @@Delete the original message on button click.
Bases: View
A view that allows the original invoker and moderators to interact with it.
Ensure the user clicking the button is the view invoker, or a moderator.
Remove the view from self.message if set.
Stop listening for interactions, and remove the view from self.message if set.
Return whether the user is in the allowed_users list, or has a role from allowed_roles.
Bases: RuntimeError
Exception raised when an operation is attempted on a locked resource.
Name of the locked resource’s type
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.
Decrement the count of the active holders; if 0 is reached set the internal event.
Wait for all active holders to exit.
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.
Apply the lock decorator using the value of the arg at the given name/position as the ID.
See lock docs for more information.
Common logging related functions.
Bases: Logger
Custom implementation of the logging.Logger class with an added trace method.
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)
@@ -494,7 +494,7 @@