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.3.0/.buildinfo | 2 +- v7.3.0/.doctrees/changelog.doctree | Bin 80039 -> 80039 bytes v7.3.0/.doctrees/environment.pickle | Bin 2645799 -> 2646677 bytes v7.3.0/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.3.0/.doctrees/output/botcore.doctree | Bin 62401 -> 62337 bytes v7.3.0/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.3.0/.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.3.0/.doctrees/output/botcore.utils.doctree | Bin 14009 -> 14012 bytes .../output/botcore.utils.interactions.doctree | Bin 30300 -> 30300 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.3.0/changelog.html | 4 +++ v7.3.0/genindex.html | 4 +++ v7.3.0/index.html | 4 +++ v7.3.0/output/botcore.async_stats.html | 4 +++ v7.3.0/output/botcore.exts.html | 4 +++ v7.3.0/output/botcore.html | 36 ++++++++++++--------- v7.3.0/output/botcore.site_api.html | 4 +++ v7.3.0/output/botcore.utils.caching.html | 4 +++ v7.3.0/output/botcore.utils.channel.html | 4 +++ v7.3.0/output/botcore.utils.html | 6 +++- v7.3.0/output/botcore.utils.interactions.html | 4 +++ v7.3.0/output/botcore.utils.logging.html | 4 +++ v7.3.0/output/botcore.utils.members.html | 4 +++ v7.3.0/output/botcore.utils.regex.html | 4 +++ v7.3.0/output/botcore.utils.scheduling.html | 4 +++ v7.3.0/py-modindex.html | 4 +++ v7.3.0/search.html | 4 +++ v7.3.0/versions.html | 10 ++++++ 34 files changed, 96 insertions(+), 18 deletions(-) (limited to 'v7.3.0') diff --git a/v7.3.0/.buildinfo b/v7.3.0/.buildinfo index 93d553b0..e7faeea1 100644 --- a/v7.3.0/.buildinfo +++ b/v7.3.0/.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: f33bc593295c6d2d262df12ed7498cfc +config: 9e7103b75c7d14b6bf71437d6a4cb7b7 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.3.0/.doctrees/changelog.doctree b/v7.3.0/.doctrees/changelog.doctree index 23b098f7..18ec76fd 100644 Binary files a/v7.3.0/.doctrees/changelog.doctree and b/v7.3.0/.doctrees/changelog.doctree differ diff --git a/v7.3.0/.doctrees/environment.pickle b/v7.3.0/.doctrees/environment.pickle index 63388e37..3d001677 100644 Binary files a/v7.3.0/.doctrees/environment.pickle and b/v7.3.0/.doctrees/environment.pickle differ diff --git a/v7.3.0/.doctrees/index.doctree b/v7.3.0/.doctrees/index.doctree index aabae443..68665df0 100644 Binary files a/v7.3.0/.doctrees/index.doctree and b/v7.3.0/.doctrees/index.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.async_stats.doctree b/v7.3.0/.doctrees/output/botcore.async_stats.doctree index 72b2161a..f6e1d4f5 100644 Binary files a/v7.3.0/.doctrees/output/botcore.async_stats.doctree and b/v7.3.0/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.doctree b/v7.3.0/.doctrees/output/botcore.doctree index fc12fccb..9a8f7011 100644 Binary files a/v7.3.0/.doctrees/output/botcore.doctree and b/v7.3.0/.doctrees/output/botcore.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.exts.doctree b/v7.3.0/.doctrees/output/botcore.exts.doctree index dea2e523..16630f7d 100644 Binary files a/v7.3.0/.doctrees/output/botcore.exts.doctree and b/v7.3.0/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.site_api.doctree b/v7.3.0/.doctrees/output/botcore.site_api.doctree index 13b870d5..90c10615 100644 Binary files a/v7.3.0/.doctrees/output/botcore.site_api.doctree and b/v7.3.0/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.utils.caching.doctree b/v7.3.0/.doctrees/output/botcore.utils.caching.doctree index 3c91220f..1a8e96c6 100644 Binary files a/v7.3.0/.doctrees/output/botcore.utils.caching.doctree and b/v7.3.0/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.utils.channel.doctree b/v7.3.0/.doctrees/output/botcore.utils.channel.doctree index d291162d..fa08ab92 100644 Binary files a/v7.3.0/.doctrees/output/botcore.utils.channel.doctree and b/v7.3.0/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.utils.doctree b/v7.3.0/.doctrees/output/botcore.utils.doctree index 11350d96..b8e725bf 100644 Binary files a/v7.3.0/.doctrees/output/botcore.utils.doctree and b/v7.3.0/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.utils.interactions.doctree b/v7.3.0/.doctrees/output/botcore.utils.interactions.doctree index 9e105fe4..410300a1 100644 Binary files a/v7.3.0/.doctrees/output/botcore.utils.interactions.doctree and b/v7.3.0/.doctrees/output/botcore.utils.interactions.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.utils.logging.doctree b/v7.3.0/.doctrees/output/botcore.utils.logging.doctree index 84bea44f..a4c8af1e 100644 Binary files a/v7.3.0/.doctrees/output/botcore.utils.logging.doctree and b/v7.3.0/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.utils.members.doctree b/v7.3.0/.doctrees/output/botcore.utils.members.doctree index 93b090e4..11e24fcc 100644 Binary files a/v7.3.0/.doctrees/output/botcore.utils.members.doctree and b/v7.3.0/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.utils.regex.doctree b/v7.3.0/.doctrees/output/botcore.utils.regex.doctree index ecd13cef..2b5fb462 100644 Binary files a/v7.3.0/.doctrees/output/botcore.utils.regex.doctree and b/v7.3.0/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.3.0/.doctrees/output/botcore.utils.scheduling.doctree b/v7.3.0/.doctrees/output/botcore.utils.scheduling.doctree index 04dd25a0..10328321 100644 Binary files a/v7.3.0/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.3.0/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/v7.3.0/changelog.html b/v7.3.0/changelog.html index 808e5c42..518c5dc0 100644 --- a/v7.3.0/changelog.html +++ b/v7.3.0/changelog.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/genindex.html b/v7.3.0/genindex.html index 1de75b33..f8ee6b04 100644 --- a/v7.3.0/genindex.html +++ b/v7.3.0/genindex.html @@ -207,6 +207,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/index.html b/v7.3.0/index.html index 17ae366b..910ee795 100644 --- a/v7.3.0/index.html +++ b/v7.3.0/index.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.async_stats.html b/v7.3.0/output/botcore.async_stats.html index 28771bc0..64b22125 100644 --- a/v7.3.0/output/botcore.async_stats.html +++ b/v7.3.0/output/botcore.async_stats.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.exts.html b/v7.3.0/output/botcore.exts.html index 9b809de9..ac0e4249 100644 --- a/v7.3.0/output/botcore.exts.html +++ b/v7.3.0/output/botcore.exts.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.html b/v7.3.0/output/botcore.html index bd039cd8..e2a999b1 100644 --- a/v7.3.0/output/botcore.html +++ b/v7.3.0/output/botcore.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -300,12 +304,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:
    @@ -324,7 +328,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:
    @@ -335,7 +339,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:
    @@ -346,7 +350,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:
    @@ -357,7 +361,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:
    @@ -368,7 +372,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.

    @@ -380,7 +384,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:
    @@ -391,7 +395,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.

    @@ -404,7 +408,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:
    @@ -415,7 +419,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:
    @@ -426,7 +430,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.

    @@ -439,7 +443,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 @@ -453,7 +457,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.

    @@ -468,12 +472,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.3.0/output/botcore.site_api.html b/v7.3.0/output/botcore.site_api.html index 1c82ab14..d96bb93c 100644 --- a/v7.3.0/output/botcore.site_api.html +++ b/v7.3.0/output/botcore.site_api.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.utils.caching.html b/v7.3.0/output/botcore.utils.caching.html index 5931632c..bc3b782d 100644 --- a/v7.3.0/output/botcore.utils.caching.html +++ b/v7.3.0/output/botcore.utils.caching.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.utils.channel.html b/v7.3.0/output/botcore.utils.channel.html index fd66e046..471406a3 100644 --- a/v7.3.0/output/botcore.utils.channel.html +++ b/v7.3.0/output/botcore.utils.channel.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.utils.html b/v7.3.0/output/botcore.utils.html index 87497bf5..256124f5 100644 --- a/v7.3.0/output/botcore.utils.html +++ b/v7.3.0/output/botcore.utils.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -319,7 +323,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.3.0/output/botcore.utils.interactions.html b/v7.3.0/output/botcore.utils.interactions.html index 9c3e1ff2..66bfe38f 100644 --- a/v7.3.0/output/botcore.utils.interactions.html +++ b/v7.3.0/output/botcore.utils.interactions.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.utils.logging.html b/v7.3.0/output/botcore.utils.logging.html index d79f14c3..82861843 100644 --- a/v7.3.0/output/botcore.utils.logging.html +++ b/v7.3.0/output/botcore.utils.logging.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.utils.members.html b/v7.3.0/output/botcore.utils.members.html index 97741141..ec5a3d45 100644 --- a/v7.3.0/output/botcore.utils.members.html +++ b/v7.3.0/output/botcore.utils.members.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.utils.regex.html b/v7.3.0/output/botcore.utils.regex.html index 009d1467..4b925483 100644 --- a/v7.3.0/output/botcore.utils.regex.html +++ b/v7.3.0/output/botcore.utils.regex.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/output/botcore.utils.scheduling.html b/v7.3.0/output/botcore.utils.scheduling.html index 6c8daad8..8f2f5b5f 100644 --- a/v7.3.0/output/botcore.utils.scheduling.html +++ b/v7.3.0/output/botcore.utils.scheduling.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/py-modindex.html b/v7.3.0/py-modindex.html index 1e1fbcd9..ada05bbd 100644 --- a/v7.3.0/py-modindex.html +++ b/v7.3.0/py-modindex.html @@ -207,6 +207,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/search.html b/v7.3.0/search.html index a7483c68..29ae49fc 100644 --- a/v7.3.0/search.html +++ b/v7.3.0/search.html @@ -206,6 +206,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.0/versions.html b/v7.3.0/versions.html index 3b878ccc..007637ba 100644 --- a/v7.3.0/versions.html +++ b/v7.3.0/versions.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -311,6 +315,12 @@ v7.4.0-beta1 + + +
  • + v7.4.0 + +
  • -- cgit v1.2.3