From eaad5d928c254438f70f1ac7634a418d4a686fad Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Thu, 10 Nov 2022 21:42:51 +0000 Subject: Deploying to docs from @ python-discord/bot-core@a6760a64bcec5ba77709492ba33b6bfba1f58e84 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/output/pydis_core.async_stats.html | 22 ++++++---- main/output/pydis_core.exts.html | 24 ++++++----- main/output/pydis_core.html | 60 ++++++++++++++------------ main/output/pydis_core.site_api.html | 42 ++++++++++-------- main/output/pydis_core.utils.caching.html | 28 ++++++------ main/output/pydis_core.utils.channel.html | 20 +++++---- main/output/pydis_core.utils.commands.html | 18 +++++--- main/output/pydis_core.utils.cooldown.html | 28 ++++++------ main/output/pydis_core.utils.function.html | 22 ++++++---- main/output/pydis_core.utils.html | 28 ++++++------ main/output/pydis_core.utils.interactions.html | 30 +++++++------ main/output/pydis_core.utils.logging.html | 22 ++++++---- main/output/pydis_core.utils.members.html | 20 +++++---- main/output/pydis_core.utils.regex.html | 22 ++++++---- main/output/pydis_core.utils.scheduling.html | 34 ++++++++------- 15 files changed, 240 insertions(+), 180 deletions(-) (limited to 'main/output') diff --git a/main/output/pydis_core.async_stats.html b/main/output/pydis_core.async_stats.html index 8bb51c18..9175520f 100644 --- a/main/output/pydis_core.async_stats.html +++ b/main/output/pydis_core.async_stats.html @@ -6,7 +6,7 @@ - async_stats - Bot Core Latest (9.0.0) + async_stats - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0)
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

-

Pydis_Core#

+

Pydis Core#

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:
@@ -372,7 +376,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:
@@ -383,7 +387,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:
@@ -394,7 +398,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:
@@ -405,7 +409,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:
@@ -416,7 +420,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.

@@ -428,7 +432,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:
@@ -439,7 +443,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.

@@ -452,7 +456,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:
@@ -463,7 +467,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:
@@ -474,7 +478,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.

@@ -487,7 +491,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 @@ -501,7 +505,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.

@@ -516,12 +520,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]#
@@ -530,8 +534,8 @@ gateway event before giving up and thus not populating the cache for unavailable

Subpackages#

@@ -688,7 +692,7 @@ gateway event before giving up and thus not populating the cache for unavailable
    -
  • Pydis_Core
      +
    • Pydis Core
      • BotBase
        • BotBase.__init__()
        • BotBase.add_cog()
          • diff --git a/main/output/pydis_core.site_api.html b/main/output/pydis_core.site_api.html index 88acd970..6ba3384b 100644 --- a/main/output/pydis_core.site_api.html +++ b/main/output/pydis_core.site_api.html @@ -6,7 +6,7 @@ - site_api - Bot Core Latest (9.0.0) + site_api - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis_Core
      -
    • Pydis_Core Exts
      • -
    • Pydis_Core Utils
        +
      • Pydis Core
          +
        • Exts
          • +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.0.0 +
            • +
          • v8.3.0-beta
            • @@ -348,12 +352,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:
            @@ -368,7 +372,7 @@
            -async close()[source]#
            +async close()[source]#

            Close the aiohttp session.

            Return type:
            @@ -379,7 +383,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:
            @@ -400,7 +404,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:
            @@ -411,7 +415,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:
            @@ -431,7 +435,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:
            @@ -442,7 +446,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:
            @@ -453,7 +457,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:
            @@ -464,7 +468,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:
            @@ -491,12 +495,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:
            @@ -511,7 +515,7 @@
            -__str__()[source]#
            +__str__()[source]#

            Return a string representation of the error.

            diff --git a/main/output/pydis_core.utils.caching.html b/main/output/pydis_core.utils.caching.html index 2d3a9475..3b4d8986 100644 --- a/main/output/pydis_core.utils.caching.html +++ b/main/output/pydis_core.utils.caching.html @@ -3,10 +3,10 @@ - + - caching - Bot Core Latest (9.0.0) + caching - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis_Core
      -
    • Pydis_Core Exts
      • -
    • Pydis_Core Utils
        +
      • Pydis Core
          +
        • Exts
          • +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.0.0 +
            • +
          • v8.3.0-beta
            • @@ -348,14 +352,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:
            @@ -372,7 +376,7 @@
            -__init__(max_size=128)[source]#
            +__init__(max_size=128)[source]#

            Initialise a new AsyncCache instance.

            Parameters:
            @@ -383,7 +387,7 @@
            -clear()[source]#
            +clear()[source]#

            Clear cache instance.

            Return type:
            @@ -417,7 +421,7 @@ Previous
-
Pydis_Core Utils
+
Utils
diff --git a/main/output/pydis_core.utils.channel.html b/main/output/pydis_core.utils.channel.html index 9b2b04c1..66059b37 100644 --- a/main/output/pydis_core.utils.channel.html +++ b/main/output/pydis_core.utils.channel.html @@ -6,7 +6,7 @@ - channel - Bot Core Latest (9.0.0) + channel - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis_Core
      -
    • Pydis_Core Exts
      • -
    • Pydis_Core Utils
        +
      • Pydis Core
          +
        • Exts
          • +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.0.0 +
            • +
          • v8.3.0-beta
            • @@ -348,7 +352,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:
            @@ -376,7 +380,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/pydis_core.utils.commands.html b/main/output/pydis_core.utils.commands.html index 8699dd21..e6d85580 100644 --- a/main/output/pydis_core.utils.commands.html +++ b/main/output/pydis_core.utils.commands.html @@ -6,7 +6,7 @@ - commands - Bot Core Latest (9.0.0) + commands - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis_Core
      -
    • Pydis_Core Exts
      • -
    • Pydis_Core Utils
        +
      • Pydis Core
          +
        • Exts
          • +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.0.0 +
            • +
          • v8.3.0-beta
            • @@ -347,7 +351,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/pydis_core.utils.cooldown.html b/main/output/pydis_core.utils.cooldown.html index c002b20e..6a738846 100644 --- a/main/output/pydis_core.utils.cooldown.html +++ b/main/output/pydis_core.utils.cooldown.html @@ -6,7 +6,7 @@ - cooldown - Bot Core Latest (9.0.0) + cooldown - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis_Core
      -
    • Pydis_Core Exts
      • -
    • Pydis_Core Utils
        +
      • Pydis Core
          +
        • Exts
          • +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.0.0 +
            • +
          • v8.3.0-beta
            • @@ -348,17 +352,17 @@

            Helpers for setting a cooldown on commands.

            -exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]#
            +exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]#

            Bases: CommandError, Generic[P, R]

            Raised when a command is invoked while on cooldown.

            -__init__(message, function, /, *args, **kwargs)[source]#
            +__init__(message, function, /, *args, **kwargs)[source]#
            -async call_without_cooldown()[source]#
            +async call_without_cooldown()[source]#

            Run the command this cooldown blocked.

            Return type:
            @@ -374,20 +378,20 @@
            -P = ~P[source]#
            +P = ~P[source]#

            The command’s signature.

            -R[source]#
            +R[source]#

            The command’s return value.

            alias of TypeVar(‘R’)

            -block_duplicate_invocations(*, cooldown_duration=5, send_notice=False, args_preprocessor=None)[source]#
            +block_duplicate_invocations(*, cooldown_duration=5, send_notice=False, args_preprocessor=None)[source]#

            Prevent duplicate invocations of a command with the same arguments in a channel for cooldown_duration seconds.

            Parameters:
            diff --git a/main/output/pydis_core.utils.function.html b/main/output/pydis_core.utils.function.html index 4a7faa70..bf2ef150 100644 --- a/main/output/pydis_core.utils.function.html +++ b/main/output/pydis_core.utils.function.html @@ -6,7 +6,7 @@ - function - Bot Core Latest (9.0.0) + function - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis_Core
      -
    • Pydis_Core Exts
      • -
    • Pydis_Core Utils
        +
      • Pydis Core
          +
        • Exts
          • +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.0.0 +
            • +
          • v8.3.0-beta
            • @@ -348,14 +352,14 @@

            Utils for manipulating functions.

            -exception GlobalNameConflictError[source]#
            +exception GlobalNameConflictError[source]#

            Bases: Exception

            Raised on a conflict between the globals used to resolve annotations of a wrapped function and its wrapper.

            -command_wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__',), *, ignored_conflict_names=frozenset({}))[source]#
            +command_wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__',), *, ignored_conflict_names=frozenset({}))[source]#

            Update the decorated function to look like wrapped, and update globals for discord.py forwardref evaluation.

            See update_wrapper_globals() for more details on how the globals are updated.

            @@ -379,7 +383,7 @@ with the wrapper replaced with the function
            -update_wrapper_globals(wrapper, wrapped, *, ignored_conflict_names=frozenset({}))[source]#
            +update_wrapper_globals(wrapper, wrapped, *, ignored_conflict_names=frozenset({}))[source]#

            Create a copy of wrapper, the copy’s globals are updated with wrapped's globals.

            For forwardrefs in command annotations, discord.py uses the __global__ attribute of the function to resolve their values. This breaks for decorators that replace the function because they have diff --git a/main/output/pydis_core.utils.html b/main/output/pydis_core.utils.html index e079175c..ac94ea8e 100644 --- a/main/output/pydis_core.utils.html +++ b/main/output/pydis_core.utils.html @@ -3,10 +3,10 @@ - + - Pydis_Core Utils - Bot Core Latest (9.0.0) + Utils - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@

-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

-

Pydis_Core Utils#

+

Utils#

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 @@ -367,7 +371,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:
@@ -494,7 +498,7 @@ that will act as top-level groups rather than being aliases of the command’s g Previous
-
Pydis_Core Exts
+
Exts
@@ -530,7 +534,7 @@ that will act as top-level groups rather than being aliases of the command’s g
    -
  • Pydis_Core Utils
      +
    • Utils
      • apply_monkey_patches()
      • unqualify()
      • Submodules
        • diff --git a/main/output/pydis_core.utils.interactions.html b/main/output/pydis_core.utils.interactions.html index ea3d12c7..66e1fd6a 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -6,7 +6,7 @@ - interactions - Bot Core Latest (9.0.0) + interactions - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis_Core
      -
    • Pydis_Core Exts
      • -
    • Pydis_Core Utils
        +
      • Pydis Core
          +
        • Exts
          • +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.0.0 +
            • +
          • v8.3.0-beta
            • @@ -347,7 +351,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.

            @@ -362,12 +366,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:
            @@ -380,7 +384,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.

            @@ -397,12 +401,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:
            @@ -416,7 +420,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/pydis_core.utils.logging.html b/main/output/pydis_core.utils.logging.html index bc052023..93f08aad 100644 --- a/main/output/pydis_core.utils.logging.html +++ b/main/output/pydis_core.utils.logging.html @@ -6,7 +6,7 @@ - logging - Bot Core Latest (9.0.0) + logging - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (9.0.0)
 +
Pydis Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

Modules:

    -
  • Pydis_Core
      -
    • Pydis_Core Exts
      • -
    • Pydis_Core Utils
        +
      • Pydis Core
          +
        • Exts
          • +
        • Utils
          • caching
          • channel
          • commands
            • @@ -209,6 +209,10 @@ main +
          • + v9.0.0 +
            • +
          • v8.3.0-beta
            • @@ -348,12 +352,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)
@@ -377,7 +381,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/pydis_core.utils.members.html b/main/output/pydis_core.utils.members.html
index 0a65f35b..4ddbc341 100644
--- a/main/output/pydis_core.utils.members.html
+++ b/main/output/pydis_core.utils.members.html
@@ -6,7 +6,7 @@
 
 
     
-        members - Bot Core Latest (9.0.0)
+        members - Pydis Core Latest (9.0.0)
       
     
     
@@ -127,7 +127,7 @@
            -
            Bot Core Latest (9.0.0)
             +
            Pydis Core Latest (9.0.0)
            @@ -153,7 +153,7 @@
            - Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

            Modules:

              -
            • Pydis_Core
                -
              • Pydis_Core Exts
                • -
              • Pydis_Core Utils
                  +
                • Pydis Core
                    +
                  • Exts
                    • +
                  • Utils
                    • caching
                    • channel
                    • commands
                      • @@ -209,6 +209,10 @@ main +
                    • + v9.0.0 +
                      • +
                    • v8.3.0-beta
                      • @@ -348,7 +352,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:
                      @@ -362,7 +366,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/pydis_core.utils.regex.html b/main/output/pydis_core.utils.regex.html index 1e7947da..42f057c9 100644 --- a/main/output/pydis_core.utils.regex.html +++ b/main/output/pydis_core.utils.regex.html @@ -6,7 +6,7 @@ - regex - Bot Core Latest (9.0.0) + regex - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
            -
            Bot Core Latest (9.0.0)
             +
            Pydis Core Latest (9.0.0)
            @@ -153,7 +153,7 @@
            - Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

            Modules:

              -
            • Pydis_Core
                -
              • Pydis_Core Exts
                • -
              • Pydis_Core Utils
                  +
                • Pydis Core
                    +
                  • Exts
                    • +
                  • Utils
                    • caching
                    • channel
                    • commands
                      • @@ -209,6 +209,10 @@ main +
                    • + v9.0.0 +
                      • +
                    • v8.3.0-beta
                      • @@ -348,7 +352,7 @@

                      Common regular expressions.

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

                      Regex for Discord server invites.

                      Warning

                      @@ -362,7 +366,7 @@ such as
                      -FORMATTED_CODE_REGEX[source]#
                      +FORMATTED_CODE_REGEX[source]#

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

                      @@ -370,7 +374,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/pydis_core.utils.scheduling.html b/main/output/pydis_core.utils.scheduling.html index 15e7e0fa..011eb156 100644 --- a/main/output/pydis_core.utils.scheduling.html +++ b/main/output/pydis_core.utils.scheduling.html @@ -6,7 +6,7 @@ - scheduling - Bot Core Latest (9.0.0) + scheduling - Pydis Core Latest (9.0.0) @@ -127,7 +127,7 @@
            -
            Bot Core Latest (9.0.0)
             +
            Pydis Core Latest (9.0.0)
            @@ -153,7 +153,7 @@
            - Bot Core Latest (9.0.0) + Pydis Core Latest (9.0.0) @@ -163,9 +163,9 @@

            Modules:

              -
            • Pydis_Core
                -
              • Pydis_Core Exts
                • -
              • Pydis_Core Utils
                  +
                • Pydis Core
                    +
                  • Exts
                    • +
                  • Utils
                    • caching
                    • channel
                    • commands
                      • @@ -209,6 +209,10 @@ main +
                    • + v9.0.0 +
                      • +
                    • v8.3.0-beta
                      • @@ -348,7 +352,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 @@ -362,7 +366,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:
                      @@ -379,7 +383,7 @@ the same ID used to schedule it.

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

                      Initialize a new Scheduler instance.

                      Parameters:
                      @@ -390,7 +394,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:
                      @@ -404,7 +408,7 @@ the same ID used to schedule it.

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

                      Unschedule all known tasks.

                      Return type:
                      @@ -415,7 +419,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.

                      @@ -434,7 +438,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.

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

                      @@ -479,7 +483,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.

                      -- cgit v1.2.3