From 7a1270a3782f04548c8c9527006cd1ae6a04b51b Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Sat, 23 Jul 2022 15:20:09 +0000 Subject: Deploying to docs from @ python-discord/bot-core@94c4b408f1afa604ae6907aa28ab694870af20f2 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/botcore.async_stats.html | 7 +++--- main/output/botcore.exts.html | 1 + main/output/botcore.html | 35 +++++++++++++++-------------- main/output/botcore.site_api.html | 33 ++++++++++++++------------- main/output/botcore.utils.caching.html | 9 ++++---- main/output/botcore.utils.channel.html | 5 +++-- main/output/botcore.utils.commands.html | 3 ++- main/output/botcore.utils.html | 5 +++-- main/output/botcore.utils.interactions.html | 15 +++++++------ main/output/botcore.utils.logging.html | 7 +++--- main/output/botcore.utils.members.html | 5 +++-- main/output/botcore.utils.regex.html | 7 +++--- main/output/botcore.utils.scheduling.html | 19 ++++++++-------- 13 files changed, 82 insertions(+), 69 deletions(-) (limited to 'main/output') diff --git a/main/output/botcore.async_stats.html b/main/output/botcore.async_stats.html index 3562838f..7b85006a 100644 --- a/main/output/botcore.async_stats.html +++ b/main/output/botcore.async_stats.html @@ -183,6 +183,7 @@

Other:

@@ -309,12 +310,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:
@@ -331,7 +332,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 70de4fc8..4e6f29bc 100644 --- a/main/output/botcore.exts.html +++ b/main/output/botcore.exts.html @@ -183,6 +183,7 @@

Other:

diff --git a/main/output/botcore.html b/main/output/botcore.html index e56f876b..a632fa24 100644 --- a/main/output/botcore.html +++ b/main/output/botcore.html @@ -183,6 +183,7 @@

Other:

@@ -309,17 +310,17 @@

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:
    -

  • guild_id (int) – The ID of the guild use for wait_until_guild_available().

    • +

  • guild_id (int) – The ID of the guild used for wait_until_guild_available().

  • allowed_roles (list) – A list of role IDs that the bot is allowed to mention.

  • http_session (aiohttp.ClientSession) – The session to use for the bot.

  • redis_session (Optional[RedisSession]) – The async_rediscache.RedisSession to use for the bot.

    • @@ -333,7 +334,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:
    @@ -344,7 +345,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:
    @@ -355,7 +356,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:
    @@ -366,7 +367,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:
    @@ -377,7 +378,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.

    @@ -389,7 +390,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:
    @@ -400,7 +401,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.

    @@ -413,7 +414,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:
    @@ -424,7 +425,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:
    @@ -435,7 +436,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.

    @@ -448,7 +449,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 @@ -462,7 +463,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.

    @@ -477,12 +478,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 9252f0ea..71182234 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -3,7 +3,7 @@ - + site_api - Bot Core Latest (7.5.0) @@ -183,6 +183,7 @@

Other:

@@ -309,12 +310,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:
@@ -329,7 +330,7 @@
-async close()[source]#
+async close()[source]#

Close the aiohttp session.

Return type:
@@ -340,7 +341,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:
@@ -361,7 +362,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:
@@ -372,7 +373,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:
@@ -392,7 +393,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:
@@ -403,7 +404,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:
@@ -414,7 +415,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:
@@ -425,7 +426,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:
@@ -452,12 +453,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:
@@ -472,7 +473,7 @@
-__str__()[source]#
+__str__()[source]#

Return a string representation of the error.

@@ -485,12 +486,12 @@