From 2e165e673111c448ed1983c5747cc8f483a72732 Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Sat, 23 Jul 2022 13:29:55 +0000 Subject: Deploying to docs from @ python-discord/bot-core@7f8d2abcc0830268774a8b90c12da8b52be1398b 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v7.2.1/.buildinfo | 2 +- v7.2.1/.doctrees/changelog.doctree | Bin 73393 -> 73393 bytes v7.2.1/.doctrees/environment.pickle | Bin 2642397 -> 2643275 bytes v7.2.1/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.2.1/.doctrees/output/botcore.doctree | Bin 62401 -> 62337 bytes v7.2.1/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.2.1/.doctrees/output/botcore.site_api.doctree | Bin 66223 -> 66223 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.2.1/.doctrees/output/botcore.utils.doctree | Bin 13965 -> 13968 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17681 -> 17681 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 55106 -> 55106 bytes v7.2.1/changelog.html | 4 +++ v7.2.1/genindex.html | 4 +++ v7.2.1/index.html | 4 +++ v7.2.1/output/botcore.async_stats.html | 4 +++ v7.2.1/output/botcore.exts.html | 4 +++ v7.2.1/output/botcore.html | 36 ++++++++++++--------- v7.2.1/output/botcore.site_api.html | 4 +++ v7.2.1/output/botcore.utils.caching.html | 4 +++ v7.2.1/output/botcore.utils.channel.html | 4 +++ v7.2.1/output/botcore.utils.html | 6 +++- v7.2.1/output/botcore.utils.logging.html | 4 +++ v7.2.1/output/botcore.utils.members.html | 4 +++ v7.2.1/output/botcore.utils.regex.html | 4 +++ v7.2.1/output/botcore.utils.scheduling.html | 4 +++ v7.2.1/py-modindex.html | 4 +++ v7.2.1/search.html | 4 +++ v7.2.1/versions.html | 10 ++++++ 32 files changed, 92 insertions(+), 18 deletions(-) (limited to 'v7.2.1') diff --git a/v7.2.1/.buildinfo b/v7.2.1/.buildinfo index 31bed099..2b0ca1f8 100644 --- a/v7.2.1/.buildinfo +++ b/v7.2.1/.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: 33f213b20eb945a18aa54a64cfa77cbc +config: cc9e5d4c230dbf99567559b2c22e1940 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.1/.doctrees/changelog.doctree b/v7.2.1/.doctrees/changelog.doctree index 90aff240..901fd02a 100644 Binary files a/v7.2.1/.doctrees/changelog.doctree and b/v7.2.1/.doctrees/changelog.doctree differ diff --git a/v7.2.1/.doctrees/environment.pickle b/v7.2.1/.doctrees/environment.pickle index e96e7030..ab0404e6 100644 Binary files a/v7.2.1/.doctrees/environment.pickle and b/v7.2.1/.doctrees/environment.pickle differ diff --git a/v7.2.1/.doctrees/index.doctree b/v7.2.1/.doctrees/index.doctree index 54040aa3..0acde841 100644 Binary files a/v7.2.1/.doctrees/index.doctree and b/v7.2.1/.doctrees/index.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.async_stats.doctree b/v7.2.1/.doctrees/output/botcore.async_stats.doctree index 9d942b15..814fbae3 100644 Binary files a/v7.2.1/.doctrees/output/botcore.async_stats.doctree and b/v7.2.1/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.doctree b/v7.2.1/.doctrees/output/botcore.doctree index c1fd822b..b526f2b7 100644 Binary files a/v7.2.1/.doctrees/output/botcore.doctree and b/v7.2.1/.doctrees/output/botcore.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.exts.doctree b/v7.2.1/.doctrees/output/botcore.exts.doctree index d4e8bda0..9c6e755c 100644 Binary files a/v7.2.1/.doctrees/output/botcore.exts.doctree and b/v7.2.1/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.site_api.doctree b/v7.2.1/.doctrees/output/botcore.site_api.doctree index dccf0878..a6362fed 100644 Binary files a/v7.2.1/.doctrees/output/botcore.site_api.doctree and b/v7.2.1/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.utils.caching.doctree b/v7.2.1/.doctrees/output/botcore.utils.caching.doctree index 7d37a046..6f621bbc 100644 Binary files a/v7.2.1/.doctrees/output/botcore.utils.caching.doctree and b/v7.2.1/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.utils.channel.doctree b/v7.2.1/.doctrees/output/botcore.utils.channel.doctree index 39da71f6..dfc096c6 100644 Binary files a/v7.2.1/.doctrees/output/botcore.utils.channel.doctree and b/v7.2.1/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.utils.doctree b/v7.2.1/.doctrees/output/botcore.utils.doctree index b8de9a4a..b3bfd463 100644 Binary files a/v7.2.1/.doctrees/output/botcore.utils.doctree and b/v7.2.1/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.utils.logging.doctree b/v7.2.1/.doctrees/output/botcore.utils.logging.doctree index c5e9e466..9068ecf1 100644 Binary files a/v7.2.1/.doctrees/output/botcore.utils.logging.doctree and b/v7.2.1/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.utils.members.doctree b/v7.2.1/.doctrees/output/botcore.utils.members.doctree index 31f5ecd8..83bd739a 100644 Binary files a/v7.2.1/.doctrees/output/botcore.utils.members.doctree and b/v7.2.1/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.utils.regex.doctree b/v7.2.1/.doctrees/output/botcore.utils.regex.doctree index 129828ae..22014d49 100644 Binary files a/v7.2.1/.doctrees/output/botcore.utils.regex.doctree and b/v7.2.1/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree index 2568edf3..6aee7ac1 100644 Binary files a/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/v7.2.1/changelog.html b/v7.2.1/changelog.html index b91632bf..02b30416 100644 --- a/v7.2.1/changelog.html +++ b/v7.2.1/changelog.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/genindex.html b/v7.2.1/genindex.html index eb27fe85..249c449a 100644 --- a/v7.2.1/genindex.html +++ b/v7.2.1/genindex.html @@ -206,6 +206,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/index.html b/v7.2.1/index.html index 9cc30afd..7d2d5225 100644 --- a/v7.2.1/index.html +++ b/v7.2.1/index.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.async_stats.html b/v7.2.1/output/botcore.async_stats.html index 48e8651a..c812fa08 100644 --- a/v7.2.1/output/botcore.async_stats.html +++ b/v7.2.1/output/botcore.async_stats.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.exts.html b/v7.2.1/output/botcore.exts.html index 283ea9de..7f12ac8b 100644 --- a/v7.2.1/output/botcore.exts.html +++ b/v7.2.1/output/botcore.exts.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.html b/v7.2.1/output/botcore.html index 8800c0ab..6b48bfea 100644 --- a/v7.2.1/output/botcore.html +++ b/v7.2.1/output/botcore.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -299,12 +303,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:
    @@ -323,7 +327,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:
    @@ -334,7 +338,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:
    @@ -345,7 +349,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:
    @@ -356,7 +360,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:
    @@ -367,7 +371,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.

    @@ -379,7 +383,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:
    @@ -390,7 +394,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.

    @@ -403,7 +407,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:
    @@ -414,7 +418,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:
    @@ -425,7 +429,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.

    @@ -438,7 +442,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 @@ -452,7 +456,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.

    @@ -467,12 +471,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/v7.2.1/output/botcore.site_api.html b/v7.2.1/output/botcore.site_api.html index d7ff0774..0b333900 100644 --- a/v7.2.1/output/botcore.site_api.html +++ b/v7.2.1/output/botcore.site_api.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.utils.caching.html b/v7.2.1/output/botcore.utils.caching.html index 75cfdbf3..3527b237 100644 --- a/v7.2.1/output/botcore.utils.caching.html +++ b/v7.2.1/output/botcore.utils.caching.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.utils.channel.html b/v7.2.1/output/botcore.utils.channel.html index e3671927..e8bcfce9 100644 --- a/v7.2.1/output/botcore.utils.channel.html +++ b/v7.2.1/output/botcore.utils.channel.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.utils.html b/v7.2.1/output/botcore.utils.html index 5ebbe5a2..721dba12 100644 --- a/v7.2.1/output/botcore.utils.html +++ b/v7.2.1/output/botcore.utils.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -318,7 +322,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/v7.2.1/output/botcore.utils.logging.html b/v7.2.1/output/botcore.utils.logging.html index 90ef5153..0e5bd87d 100644 --- a/v7.2.1/output/botcore.utils.logging.html +++ b/v7.2.1/output/botcore.utils.logging.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.utils.members.html b/v7.2.1/output/botcore.utils.members.html index c01556ed..eb6d1872 100644 --- a/v7.2.1/output/botcore.utils.members.html +++ b/v7.2.1/output/botcore.utils.members.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.utils.regex.html b/v7.2.1/output/botcore.utils.regex.html index e3d2faa0..afa30947 100644 --- a/v7.2.1/output/botcore.utils.regex.html +++ b/v7.2.1/output/botcore.utils.regex.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/output/botcore.utils.scheduling.html b/v7.2.1/output/botcore.utils.scheduling.html index 66b87331..c42e7db6 100644 --- a/v7.2.1/output/botcore.utils.scheduling.html +++ b/v7.2.1/output/botcore.utils.scheduling.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/py-modindex.html b/v7.2.1/py-modindex.html index 247dcfcd..38a4b814 100644 --- a/v7.2.1/py-modindex.html +++ b/v7.2.1/py-modindex.html @@ -206,6 +206,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/search.html b/v7.2.1/search.html index 3e11ca85..dc388edc 100644 --- a/v7.2.1/search.html +++ b/v7.2.1/search.html @@ -205,6 +205,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.1/versions.html b/v7.2.1/versions.html index 2a1b511c..b079b61d 100644 --- a/v7.2.1/versions.html +++ b/v7.2.1/versions.html @@ -207,6 +207,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -310,6 +314,12 @@ v7.4.0-beta1 + + +
  • + v7.4.0 + +
  • -- cgit v1.2.3