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.1/.buildinfo | 2 +- v7.3.1/.doctrees/changelog.doctree | Bin 82541 -> 82541 bytes v7.3.1/.doctrees/environment.pickle | Bin 2645799 -> 2646677 bytes v7.3.1/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.3.1/.doctrees/output/botcore.doctree | Bin 62401 -> 62337 bytes v7.3.1/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.3.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.3.1/.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.1/changelog.html | 4 +++ v7.3.1/genindex.html | 4 +++ v7.3.1/index.html | 4 +++ v7.3.1/output/botcore.async_stats.html | 4 +++ v7.3.1/output/botcore.exts.html | 4 +++ v7.3.1/output/botcore.html | 36 ++++++++++++--------- v7.3.1/output/botcore.site_api.html | 4 +++ v7.3.1/output/botcore.utils.caching.html | 4 +++ v7.3.1/output/botcore.utils.channel.html | 4 +++ v7.3.1/output/botcore.utils.html | 6 +++- v7.3.1/output/botcore.utils.interactions.html | 4 +++ v7.3.1/output/botcore.utils.logging.html | 4 +++ v7.3.1/output/botcore.utils.members.html | 4 +++ v7.3.1/output/botcore.utils.regex.html | 4 +++ v7.3.1/output/botcore.utils.scheduling.html | 4 +++ v7.3.1/py-modindex.html | 4 +++ v7.3.1/search.html | 4 +++ v7.3.1/versions.html | 10 ++++++ 34 files changed, 96 insertions(+), 18 deletions(-) (limited to 'v7.3.1') diff --git a/v7.3.1/.buildinfo b/v7.3.1/.buildinfo index 4585a83a..93e1b4b8 100644 --- a/v7.3.1/.buildinfo +++ b/v7.3.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: cd665afbd93ce8c7e59033080a29f350 +config: cdd1cd9116f400bc2c0d44a8b5138bf6 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.3.1/.doctrees/changelog.doctree b/v7.3.1/.doctrees/changelog.doctree index 330bde11..54f2587a 100644 Binary files a/v7.3.1/.doctrees/changelog.doctree and b/v7.3.1/.doctrees/changelog.doctree differ diff --git a/v7.3.1/.doctrees/environment.pickle b/v7.3.1/.doctrees/environment.pickle index 107d0b68..c5254066 100644 Binary files a/v7.3.1/.doctrees/environment.pickle and b/v7.3.1/.doctrees/environment.pickle differ diff --git a/v7.3.1/.doctrees/index.doctree b/v7.3.1/.doctrees/index.doctree index ec5769fa..6624126a 100644 Binary files a/v7.3.1/.doctrees/index.doctree and b/v7.3.1/.doctrees/index.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.async_stats.doctree b/v7.3.1/.doctrees/output/botcore.async_stats.doctree index 3b786fb6..f6664b92 100644 Binary files a/v7.3.1/.doctrees/output/botcore.async_stats.doctree and b/v7.3.1/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.doctree b/v7.3.1/.doctrees/output/botcore.doctree index c8f242b7..93ec00aa 100644 Binary files a/v7.3.1/.doctrees/output/botcore.doctree and b/v7.3.1/.doctrees/output/botcore.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.exts.doctree b/v7.3.1/.doctrees/output/botcore.exts.doctree index 8b385154..e9605bd5 100644 Binary files a/v7.3.1/.doctrees/output/botcore.exts.doctree and b/v7.3.1/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.site_api.doctree b/v7.3.1/.doctrees/output/botcore.site_api.doctree index 03f86c2f..64dd964b 100644 Binary files a/v7.3.1/.doctrees/output/botcore.site_api.doctree and b/v7.3.1/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.utils.caching.doctree b/v7.3.1/.doctrees/output/botcore.utils.caching.doctree index 1074776c..ce469d69 100644 Binary files a/v7.3.1/.doctrees/output/botcore.utils.caching.doctree and b/v7.3.1/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.utils.channel.doctree b/v7.3.1/.doctrees/output/botcore.utils.channel.doctree index d65223f4..5d9a3bc7 100644 Binary files a/v7.3.1/.doctrees/output/botcore.utils.channel.doctree and b/v7.3.1/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.utils.doctree b/v7.3.1/.doctrees/output/botcore.utils.doctree index 28fda39d..f4dc40bb 100644 Binary files a/v7.3.1/.doctrees/output/botcore.utils.doctree and b/v7.3.1/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.utils.interactions.doctree b/v7.3.1/.doctrees/output/botcore.utils.interactions.doctree index 64f99ee0..f3323d08 100644 Binary files a/v7.3.1/.doctrees/output/botcore.utils.interactions.doctree and b/v7.3.1/.doctrees/output/botcore.utils.interactions.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.utils.logging.doctree b/v7.3.1/.doctrees/output/botcore.utils.logging.doctree index 1c83b6d8..6991e2f6 100644 Binary files a/v7.3.1/.doctrees/output/botcore.utils.logging.doctree and b/v7.3.1/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.utils.members.doctree b/v7.3.1/.doctrees/output/botcore.utils.members.doctree index 670abb06..7600d865 100644 Binary files a/v7.3.1/.doctrees/output/botcore.utils.members.doctree and b/v7.3.1/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.utils.regex.doctree b/v7.3.1/.doctrees/output/botcore.utils.regex.doctree index bfce71f8..ccad488f 100644 Binary files a/v7.3.1/.doctrees/output/botcore.utils.regex.doctree and b/v7.3.1/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.3.1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.3.1/.doctrees/output/botcore.utils.scheduling.doctree index e349da98..27939505 100644 Binary files a/v7.3.1/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.3.1/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/v7.3.1/changelog.html b/v7.3.1/changelog.html index 4f5cb324..5b8e4584 100644 --- a/v7.3.1/changelog.html +++ b/v7.3.1/changelog.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/genindex.html b/v7.3.1/genindex.html index c1ebcba0..6fd1d76d 100644 --- a/v7.3.1/genindex.html +++ b/v7.3.1/genindex.html @@ -207,6 +207,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/index.html b/v7.3.1/index.html index ce368429..9e632142 100644 --- a/v7.3.1/index.html +++ b/v7.3.1/index.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.async_stats.html b/v7.3.1/output/botcore.async_stats.html index bbfad144..fb0132d2 100644 --- a/v7.3.1/output/botcore.async_stats.html +++ b/v7.3.1/output/botcore.async_stats.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.exts.html b/v7.3.1/output/botcore.exts.html index 03b3b609..3a258884 100644 --- a/v7.3.1/output/botcore.exts.html +++ b/v7.3.1/output/botcore.exts.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.html b/v7.3.1/output/botcore.html index bf83db6c..57be4a07 100644 --- a/v7.3.1/output/botcore.html +++ b/v7.3.1/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.1/output/botcore.site_api.html b/v7.3.1/output/botcore.site_api.html index 9ae36745..dbad2974 100644 --- a/v7.3.1/output/botcore.site_api.html +++ b/v7.3.1/output/botcore.site_api.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.utils.caching.html b/v7.3.1/output/botcore.utils.caching.html index 465df7a6..3fd69984 100644 --- a/v7.3.1/output/botcore.utils.caching.html +++ b/v7.3.1/output/botcore.utils.caching.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.utils.channel.html b/v7.3.1/output/botcore.utils.channel.html index dd689cf7..76222a2a 100644 --- a/v7.3.1/output/botcore.utils.channel.html +++ b/v7.3.1/output/botcore.utils.channel.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.utils.html b/v7.3.1/output/botcore.utils.html index 0fba2e3f..66d25bc7 100644 --- a/v7.3.1/output/botcore.utils.html +++ b/v7.3.1/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.1/output/botcore.utils.interactions.html b/v7.3.1/output/botcore.utils.interactions.html index 464c605a..04dbdb07 100644 --- a/v7.3.1/output/botcore.utils.interactions.html +++ b/v7.3.1/output/botcore.utils.interactions.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.utils.logging.html b/v7.3.1/output/botcore.utils.logging.html index a007b827..52086675 100644 --- a/v7.3.1/output/botcore.utils.logging.html +++ b/v7.3.1/output/botcore.utils.logging.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.utils.members.html b/v7.3.1/output/botcore.utils.members.html index 97802b61..adf75c81 100644 --- a/v7.3.1/output/botcore.utils.members.html +++ b/v7.3.1/output/botcore.utils.members.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.utils.regex.html b/v7.3.1/output/botcore.utils.regex.html index 4f84df44..271756e6 100644 --- a/v7.3.1/output/botcore.utils.regex.html +++ b/v7.3.1/output/botcore.utils.regex.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/output/botcore.utils.scheduling.html b/v7.3.1/output/botcore.utils.scheduling.html index 10b99076..6c8f3c44 100644 --- a/v7.3.1/output/botcore.utils.scheduling.html +++ b/v7.3.1/output/botcore.utils.scheduling.html @@ -209,6 +209,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/py-modindex.html b/v7.3.1/py-modindex.html index 618e1623..d97d02d1 100644 --- a/v7.3.1/py-modindex.html +++ b/v7.3.1/py-modindex.html @@ -207,6 +207,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/search.html b/v7.3.1/search.html index 5c186c43..015c46bb 100644 --- a/v7.3.1/search.html +++ b/v7.3.1/search.html @@ -206,6 +206,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.3.1/versions.html b/v7.3.1/versions.html index c569d2f8..f981c1f5 100644 --- a/v7.3.1/versions.html +++ b/v7.3.1/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