From 6c17e8382c048c1e29c12b479e8e213a4fedec24 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Tue, 26 Jul 2022 16:01:54 +0000 Subject: Deploying to docs from @ python-discord/bot-core@20ed26e794c677205417a475b5d3719822e4bc4b 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/.buildinfo | 2 +- main/.doctrees/changelog.doctree | Bin 90529 -> 90529 bytes main/.doctrees/development.doctree | Bin 14879 -> 14879 bytes main/.doctrees/environment.pickle | Bin 2656083 -> 2657657 bytes main/.doctrees/index.doctree | Bin 5890 -> 5890 bytes main/.doctrees/output/botcore.async_stats.doctree | Bin 18861 -> 18861 bytes main/.doctrees/output/botcore.doctree | Bin 61098 -> 61098 bytes main/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes main/.doctrees/output/botcore.site_api.doctree | Bin 65280 -> 65280 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16603 -> 16603 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17549 -> 17549 bytes .../output/botcore.utils.commands.doctree | Bin 10549 -> 10549 bytes main/.doctrees/output/botcore.utils.doctree | Bin 14058 -> 14058 bytes .../output/botcore.utils.interactions.doctree | Bin 35386 -> 35386 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18145 -> 18145 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17417 -> 17417 bytes main/.doctrees/output/botcore.utils.regex.doctree | Bin 9019 -> 9019 bytes .../output/botcore.utils.scheduling.doctree | Bin 55134 -> 55497 bytes main/changelog.html | 8 +++++ main/development.html | 8 +++++ main/genindex.html | 8 +++++ main/index.html | 8 +++++ main/output/botcore.async_stats.html | 14 ++++++-- main/output/botcore.exts.html | 8 +++++ main/output/botcore.html | 40 ++++++++++++--------- main/output/botcore.site_api.html | 34 +++++++++++------- main/output/botcore.utils.caching.html | 16 ++++++--- main/output/botcore.utils.channel.html | 12 +++++-- main/output/botcore.utils.commands.html | 10 +++++- main/output/botcore.utils.html | 12 +++++-- main/output/botcore.utils.interactions.html | 22 ++++++++---- main/output/botcore.utils.logging.html | 14 ++++++-- main/output/botcore.utils.members.html | 12 +++++-- main/output/botcore.utils.regex.html | 14 ++++++-- main/output/botcore.utils.scheduling.html | 28 +++++++++------ main/py-modindex.html | 8 +++++ main/search.html | 8 +++++ main/versions.html | 20 +++++++++++ 38 files changed, 239 insertions(+), 67 deletions(-) (limited to 'main') diff --git a/main/.buildinfo b/main/.buildinfo index de8017fe..2caead72 100644 --- a/main/.buildinfo +++ b/main/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 36283552916f08b05e953547bac4ea18 +config: 394fdf545d9269770720f721a0e5d3d1 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/changelog.doctree b/main/.doctrees/changelog.doctree index 55389a2d..1b87efb0 100644 Binary files a/main/.doctrees/changelog.doctree and b/main/.doctrees/changelog.doctree differ diff --git a/main/.doctrees/development.doctree b/main/.doctrees/development.doctree index 87bec9a4..ac58d96e 100644 Binary files a/main/.doctrees/development.doctree and b/main/.doctrees/development.doctree differ diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle index 37b8fd26..cecff49a 100644 Binary files a/main/.doctrees/environment.pickle and b/main/.doctrees/environment.pickle differ diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree index 0f399dd9..57884dbd 100644 Binary files a/main/.doctrees/index.doctree and b/main/.doctrees/index.doctree differ diff --git a/main/.doctrees/output/botcore.async_stats.doctree b/main/.doctrees/output/botcore.async_stats.doctree index e682f663..ad9b4b3b 100644 Binary files a/main/.doctrees/output/botcore.async_stats.doctree and b/main/.doctrees/output/botcore.async_stats.doctree differ diff --git a/main/.doctrees/output/botcore.doctree b/main/.doctrees/output/botcore.doctree index 0fb19df0..4065f105 100644 Binary files a/main/.doctrees/output/botcore.doctree and b/main/.doctrees/output/botcore.doctree differ diff --git a/main/.doctrees/output/botcore.exts.doctree b/main/.doctrees/output/botcore.exts.doctree index 9ba57329..cefedb0d 100644 Binary files a/main/.doctrees/output/botcore.exts.doctree and b/main/.doctrees/output/botcore.exts.doctree differ diff --git a/main/.doctrees/output/botcore.site_api.doctree b/main/.doctrees/output/botcore.site_api.doctree index a30d771b..0e62cd12 100644 Binary files a/main/.doctrees/output/botcore.site_api.doctree and b/main/.doctrees/output/botcore.site_api.doctree differ diff --git a/main/.doctrees/output/botcore.utils.caching.doctree b/main/.doctrees/output/botcore.utils.caching.doctree index ced6fcad..f0ffa51f 100644 Binary files a/main/.doctrees/output/botcore.utils.caching.doctree and b/main/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/main/.doctrees/output/botcore.utils.channel.doctree b/main/.doctrees/output/botcore.utils.channel.doctree index 57e0f8ef..de5b056d 100644 Binary files a/main/.doctrees/output/botcore.utils.channel.doctree and b/main/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/main/.doctrees/output/botcore.utils.commands.doctree b/main/.doctrees/output/botcore.utils.commands.doctree index aa993fc4..cb4ffa82 100644 Binary files a/main/.doctrees/output/botcore.utils.commands.doctree and b/main/.doctrees/output/botcore.utils.commands.doctree differ diff --git a/main/.doctrees/output/botcore.utils.doctree b/main/.doctrees/output/botcore.utils.doctree index 7eebf003..e3755024 100644 Binary files a/main/.doctrees/output/botcore.utils.doctree and b/main/.doctrees/output/botcore.utils.doctree differ diff --git a/main/.doctrees/output/botcore.utils.interactions.doctree b/main/.doctrees/output/botcore.utils.interactions.doctree index a07409cf..63f3b0ce 100644 Binary files a/main/.doctrees/output/botcore.utils.interactions.doctree and b/main/.doctrees/output/botcore.utils.interactions.doctree differ diff --git a/main/.doctrees/output/botcore.utils.logging.doctree b/main/.doctrees/output/botcore.utils.logging.doctree index e7c8d5aa..e9b96e3b 100644 Binary files a/main/.doctrees/output/botcore.utils.logging.doctree and b/main/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/main/.doctrees/output/botcore.utils.members.doctree b/main/.doctrees/output/botcore.utils.members.doctree index b4c44810..4d38e8f8 100644 Binary files a/main/.doctrees/output/botcore.utils.members.doctree and b/main/.doctrees/output/botcore.utils.members.doctree differ diff --git a/main/.doctrees/output/botcore.utils.regex.doctree b/main/.doctrees/output/botcore.utils.regex.doctree index e175a07d..53adfe6b 100644 Binary files a/main/.doctrees/output/botcore.utils.regex.doctree and b/main/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/main/.doctrees/output/botcore.utils.scheduling.doctree b/main/.doctrees/output/botcore.utils.scheduling.doctree index b778d9df..a523051b 100644 Binary files a/main/.doctrees/output/botcore.utils.scheduling.doctree and b/main/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/main/changelog.html b/main/changelog.html index 48b8cd4b..bc8959d1 100644 --- a/main/changelog.html +++ b/main/changelog.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • diff --git a/main/development.html b/main/development.html index 3a632efa..75e256e0 100644 --- a/main/development.html +++ b/main/development.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • diff --git a/main/genindex.html b/main/genindex.html index 72b6ab75..5bebf398 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -205,6 +205,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • diff --git a/main/index.html b/main/index.html index 590ed42f..7cc5dacd 100644 --- a/main/index.html +++ b/main/index.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • diff --git a/main/output/botcore.async_stats.html b/main/output/botcore.async_stats.html index c09ff3e0..67ed22c4 100644 --- a/main/output/botcore.async_stats.html +++ b/main/output/botcore.async_stats.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,12 +326,12 @@

    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:
    @@ -340,7 +348,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:
    diff --git a/main/output/botcore.exts.html b/main/output/botcore.exts.html index 6ddaf414..97a92838 100644 --- a/main/output/botcore.exts.html +++ b/main/output/botcore.exts.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • diff --git a/main/output/botcore.html b/main/output/botcore.html index 85d5db8d..25b21a76 100644 --- a/main/output/botcore.html +++ b/main/output/botcore.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,12 +326,12 @@

    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.

    -__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:
    @@ -342,7 +350,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:
    @@ -353,7 +361,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:
    @@ -364,7 +372,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:
    @@ -375,7 +383,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:
    @@ -386,7 +394,7 @@ a dummy statsd client will be created.

    -async load_extensions(module)[source]#
    +async load_extensions(module)[source]#

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

    This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

    @@ -398,7 +406,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:
    @@ -409,7 +417,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.

    @@ -422,7 +430,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:
    @@ -433,7 +441,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:
    @@ -444,7 +452,7 @@ will not be set and guild_available_but_cache_empty event will be e
    -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.

    @@ -457,7 +465,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 @@ -471,7 +479,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.

    @@ -486,12 +494,12 @@ gateway event before giving up and thus not populating the cache for unavailable
    -exception StartupError(base)[source]#
    +exception StartupError(base)[source]#

    Bases: Exception

    Exception class for startup errors.

    -__init__(base)[source]#
    +__init__(base)[source]#
    diff --git a/main/output/botcore.site_api.html b/main/output/botcore.site_api.html index af94a643..b749750c 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,12 +326,12 @@

    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:
    @@ -338,7 +346,7 @@
    -async close()[source]#
    +async close()[source]#

    Close the aiohttp session.

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

    Send a DELETE request to the site API and return the JSON response.

    Parameters:
    @@ -370,7 +378,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:
    @@ -381,7 +389,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:
    @@ -401,7 +409,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:
    @@ -412,7 +420,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:
    @@ -423,7 +431,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:
    @@ -434,7 +442,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:
    @@ -461,12 +469,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:
    @@ -481,7 +489,7 @@
    -__str__()[source]#
    +__str__()[source]#

    Return a string representation of the error.

    diff --git a/main/output/botcore.utils.caching.html b/main/output/botcore.utils.caching.html index 4244e248..27e01f02 100644 --- a/main/output/botcore.utils.caching.html +++ b/main/output/botcore.utils.caching.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,14 +326,14 @@

    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:
    @@ -342,7 +350,7 @@
    -__init__(max_size=128)[source]#
    +__init__(max_size=128)[source]#

    Initialise a new AsyncCache instance.

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

    Clear cache instance.

    Return type:
    diff --git a/main/output/botcore.utils.channel.html b/main/output/botcore.utils.channel.html index 20f124cd..40cd119b 100644 --- a/main/output/botcore.utils.channel.html +++ b/main/output/botcore.utils.channel.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,7 +326,7 @@

    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:
    @@ -346,7 +354,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:
    diff --git a/main/output/botcore.utils.commands.html b/main/output/botcore.utils.commands.html index 02a3f487..a38a68fd 100644 --- a/main/output/botcore.utils.commands.html +++ b/main/output/botcore.utils.commands.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -317,7 +325,7 @@

    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:
    diff --git a/main/output/botcore.utils.html b/main/output/botcore.utils.html index 83bdd981..00aca180 100644 --- a/main/output/botcore.utils.html +++ b/main/output/botcore.utils.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,7 +326,7 @@

    Useful utilities and tools for Discord bot development.

    -apply_monkey_patches()[source]#
    +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 @@ -337,7 +345,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:
    diff --git a/main/output/botcore.utils.interactions.html b/main/output/botcore.utils.interactions.html index e01d2e1d..b437a9fe 100644 --- a/main/output/botcore.utils.interactions.html +++ b/main/output/botcore.utils.interactions.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -317,7 +325,7 @@

    interactions#

    -class DeleteMessageButton(*, style=<ButtonStyle.secondary: 2>, label='Delete', **kwargs)[source]#
    +class DeleteMessageButton(*, style=<ButtonStyle.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.

    @@ -332,12 +340,12 @@
    -__init__(*, style=<ButtonStyle.secondary: 2>, label='Delete', **kwargs)[source]#
    +__init__(*, style=<ButtonStyle.secondary: 2>, label='Delete', **kwargs)[source]#
    -async callback(interaction)[source]#
    +async callback(interaction)[source]#

    Delete the original message on button click.

    Return type:
    @@ -350,7 +358,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.

    @@ -367,12 +375,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:
    @@ -386,7 +394,7 @@ If None
    -async on_timeout()[source]#
    +async on_timeout()[source]#

    Remove the view from self.message if set.

    Return type:
    diff --git a/main/output/botcore.utils.logging.html b/main/output/botcore.utils.logging.html index 8cb5e2c2..6921910d 100644 --- a/main/output/botcore.utils.logging.html +++ b/main/output/botcore.utils.logging.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,12 +326,12 @@

    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)
    @@ -347,7 +355,7 @@
     
     
    -get_logger(name=None)[source]#
    +get_logger(name=None)[source]#

    Utility to make mypy recognise that logger is of type CustomLogger.

    Parameters:
    diff --git a/main/output/botcore.utils.members.html b/main/output/botcore.utils.members.html index 57a0355f..c5965653 100644 --- a/main/output/botcore.utils.members.html +++ b/main/output/botcore.utils.members.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,7 +326,7 @@

    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:
    @@ -332,7 +340,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.

    diff --git a/main/output/botcore.utils.regex.html b/main/output/botcore.utils.regex.html index 47311ab3..1dd40790 100644 --- a/main/output/botcore.utils.regex.html +++ b/main/output/botcore.utils.regex.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,7 +326,7 @@

    Common regular expressions.

    -DISCORD_INVITE[source]#
    +DISCORD_INVITE[source]#

    Regex for Discord server invites.

    Warning

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

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

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

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

    diff --git a/main/output/botcore.utils.scheduling.html b/main/output/botcore.utils.scheduling.html index 28aa9097..4679c754 100644 --- a/main/output/botcore.utils.scheduling.html +++ b/main/output/botcore.utils.scheduling.html @@ -207,6 +207,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -318,7 +326,7 @@

    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 @@ -332,7 +340,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:
    @@ -349,7 +357,7 @@ the same ID used to schedule it.

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

    Initialize a new Scheduler instance.

    Parameters:
    @@ -360,7 +368,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:
    @@ -374,7 +382,7 @@ the same ID used to schedule it.

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

    Unschedule all known tasks.

    Return type:
    @@ -385,7 +393,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.

    @@ -404,7 +412,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.

    @@ -427,7 +435,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.

    @@ -449,7 +457,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.

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

    Parameters:
    diff --git a/main/py-modindex.html b/main/py-modindex.html index ec53ebc9..5c6ed1ba 100644 --- a/main/py-modindex.html +++ b/main/py-modindex.html @@ -205,6 +205,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • diff --git a/main/search.html b/main/search.html index 5d8b7283..f0b96416 100644 --- a/main/search.html +++ b/main/search.html @@ -204,6 +204,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • diff --git a/main/versions.html b/main/versions.html index 36f13183..14945281 100644 --- a/main/versions.html +++ b/main/versions.html @@ -206,6 +206,14 @@ main +
  • + v8.0.0-beta.4 +
  • + +
  • + v8.0.0-beta.3 +
  • +
  • v8.0.0-beta.2
  • @@ -325,6 +333,18 @@ - latest +
  • + v8.0.0-beta.4 + + +
  • + +
  • + v8.0.0-beta.3 + + +
  • +
  • v8.0.0-beta.2 -- cgit v1.2.3