From 98fe8707d983ef4b9f10cab28a1a540b8dafc078 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sun, 10 Dec 2023 16:00:28 +0000 Subject: Deploying to docs from @ python-discord/bot-core@3ed1d4be2328b59577afde058105fd071184bd95 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v8.0.0-beta.3/.buildinfo | 2 +- v8.0.0-beta.3/changelog.html | 6 ++- v8.0.0-beta.3/development.html | 6 ++- v8.0.0-beta.3/genindex.html | 6 ++- v8.0.0-beta.3/index.html | 6 ++- v8.0.0-beta.3/index_redirect.html | 2 +- v8.0.0-beta.3/output/botcore.async_stats.html | 14 +++--- v8.0.0-beta.3/output/botcore.exts.html | 6 ++- v8.0.0-beta.3/output/botcore.html | 42 +++++++++-------- v8.0.0-beta.3/output/botcore.site_api.html | 52 ++++++++++++---------- v8.0.0-beta.3/output/botcore.utils.caching.html | 14 +++--- v8.0.0-beta.3/output/botcore.utils.channel.html | 18 +++++--- v8.0.0-beta.3/output/botcore.utils.commands.html | 12 +++-- v8.0.0-beta.3/output/botcore.utils.html | 12 +++-- .../output/botcore.utils.interactions.html | 24 +++++----- v8.0.0-beta.3/output/botcore.utils.logging.html | 14 +++--- v8.0.0-beta.3/output/botcore.utils.members.html | 16 ++++--- v8.0.0-beta.3/output/botcore.utils.regex.html | 6 ++- v8.0.0-beta.3/output/botcore.utils.scheduling.html | 44 +++++++++--------- v8.0.0-beta.3/py-modindex.html | 6 ++- v8.0.0-beta.3/search.html | 6 ++- v8.0.0-beta.3/searchindex.js | 2 +- v8.0.0-beta.3/versions.html | 12 ++++- 23 files changed, 207 insertions(+), 121 deletions(-) (limited to 'v8.0.0-beta.3') diff --git a/v8.0.0-beta.3/.buildinfo b/v8.0.0-beta.3/.buildinfo index de8261e9..11064c9f 100644 --- a/v8.0.0-beta.3/.buildinfo +++ b/v8.0.0-beta.3/.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: b6fa613a236325324ac9f5f579dd643c +config: 44db5070d99d152323e65e9c56b64aee tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.0.0-beta.3/changelog.html b/v8.0.0-beta.3/changelog.html index 482d50f7..494921e5 100644 --- a/v8.0.0-beta.3/changelog.html +++ b/v8.0.0-beta.3/changelog.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • diff --git a/v8.0.0-beta.3/development.html b/v8.0.0-beta.3/development.html index fe454769..b0e29ed9 100644 --- a/v8.0.0-beta.3/development.html +++ b/v8.0.0-beta.3/development.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • diff --git a/v8.0.0-beta.3/genindex.html b/v8.0.0-beta.3/genindex.html index 4652a890..0b6a5458 100644 --- a/v8.0.0-beta.3/genindex.html +++ b/v8.0.0-beta.3/genindex.html @@ -8,9 +8,9 @@ - + @@ -349,6 +349,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • diff --git a/v8.0.0-beta.3/index.html b/v8.0.0-beta.3/index.html index 5bf871e7..905cb3aa 100644 --- a/v8.0.0-beta.3/index.html +++ b/v8.0.0-beta.3/index.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • diff --git a/v8.0.0-beta.3/index_redirect.html b/v8.0.0-beta.3/index_redirect.html index e938d690..b6d5bfa5 100644 --- a/v8.0.0-beta.3/index_redirect.html +++ b/v8.0.0-beta.3/index_redirect.html @@ -13,9 +13,9 @@ - + diff --git a/v8.0.0-beta.3/output/botcore.async_stats.html b/v8.0.0-beta.3/output/botcore.async_stats.html index dc9e0146..e0ac091e 100644 --- a/v8.0.0-beta.3/output/botcore.async_stats.html +++ b/v8.0.0-beta.3/output/botcore.async_stats.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -439,9 +443,9 @@
    @@ -453,7 +457,7 @@

    Use asyncio.loop.create_datagram_endpoint from the loop given on init to create a socket.

    Return type:
    -

    None

    +

    None

    diff --git a/v8.0.0-beta.3/output/botcore.exts.html b/v8.0.0-beta.3/output/botcore.exts.html index ad6a687a..5ac0be46 100644 --- a/v8.0.0-beta.3/output/botcore.exts.html +++ b/v8.0.0-beta.3/output/botcore.exts.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • diff --git a/v8.0.0-beta.3/output/botcore.html b/v8.0.0-beta.3/output/botcore.html index bb3a776b..9bd0ae71 100644 --- a/v8.0.0-beta.3/output/botcore.html +++ b/v8.0.0-beta.3/output/botcore.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -437,12 +441,12 @@
    Parameters:
    @@ -455,7 +459,7 @@ a dummy statsd client will be created.

    Add the given cog to the bot and log the operation.

    Return type:
    -

    None

    +

    None

    @@ -466,7 +470,7 @@ a dummy statsd client will be created.

    Add command as normal and then add its root aliases to the bot.

    Return type:
    -

    None

    +

    None

    @@ -477,7 +481,7 @@ a dummy statsd client will be created.

    Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.

    Return type:
    -

    None

    +

    None

    @@ -488,7 +492,7 @@ a dummy statsd client will be created.

    Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.

    Return type:
    -

    None

    +

    None

    @@ -500,7 +504,7 @@ a dummy statsd client will be created.

    This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

    Return type:
    -

    None

    +

    None

    @@ -511,7 +515,7 @@ a dummy statsd client will be created.

    Log the given message to #dev-log.

    Return type:
    -

    None

    +

    None

    @@ -524,7 +528,7 @@ a dummy statsd client will be created.

    will not be set and guild_available_but_cache_empty event will be emitted.

    Return type:
    -

    None

    +

    None

    @@ -535,7 +539,7 @@ will not be set and guild_available_but_cache_empty event will be e

    Clear the internal guild available event when self.guild_id becomes unavailable.

    Return type:
    -

    None

    +

    None

    @@ -546,7 +550,7 @@ will not be set and guild_available_but_cache_empty event will be e

    Ping all required services on setup to ensure they are up before starting.

    Return type:
    -

    None

    +

    None

    @@ -559,7 +563,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    @@ -573,7 +577,7 @@ To remove them, either remove the entire command or manually edit bot.all_ and ping_services().

    Return type:
    -

    None

    +

    None

    @@ -586,7 +590,7 @@ and
    Return type:
    -

    None

    +

    None

    diff --git a/v8.0.0-beta.3/output/botcore.site_api.html b/v8.0.0-beta.3/output/botcore.site_api.html index d78ca346..67a23923 100644 --- a/v8.0.0-beta.3/output/botcore.site_api.html +++ b/v8.0.0-beta.3/output/botcore.site_api.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -437,9 +441,9 @@
    Parameters:
      -

    • site_api_url (str) – The URL of the site API.

      • -

    • site_api_token (str) – The token to use for authentication.

      • -

    • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

      • +

    • site_api_url (str) – The URL of the site API.

      • +

    • site_api_token (str) – The token to use for authentication.

      • +

    • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

    @@ -451,7 +455,7 @@

    Close the aiohttp session.

    Return type:
    -

    None

    +

    None

    @@ -463,13 +467,13 @@
    Parameters:
      -

    • endpoint (str) – The endpoint to send the request to.

      • -

    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

      • -

    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

      • +

    • endpoint (str) – The endpoint to send the request to.

      • +

    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

      • +

    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

    Return type:
    -

    Optional[dict]

    +

    Optional[dict]

    Returns:

    The JSON response the API returns, or None if the response is 204 No Content.

    @@ -483,7 +487,7 @@

    Equivalent to APIClient.request() with GET passed as the method.

    Return type:
    -

    dict

    +

    dict

    @@ -495,15 +499,15 @@
    Parameters:
    Raises:

    ResponseCodeError – If the response is not OK and should_raise is True.

    Return type:
    -

    None

    +

    None

    @@ -514,7 +518,7 @@

    Equivalent to APIClient.request() with PATCH passed as the method.

    Return type:
    -

    dict

    +

    dict

    @@ -525,7 +529,7 @@

    Equivalent to APIClient.request() with POST passed as the method.

    Return type:
    -

    dict

    +

    dict

    @@ -536,7 +540,7 @@

    Equivalent to APIClient.request() with PUT passed as the method.

    Return type:
    -

    dict

    +

    dict

    @@ -548,14 +552,14 @@
    Parameters:
      -

    • method (str) – The HTTP method to use.

      • -

    • endpoint (str) – The endpoint to send the request to.

      • -

    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

      • -

    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

      • +

    • method (str) – The HTTP method to use.

      • +

    • endpoint (str) – The endpoint to send the request to.

      • +

    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

      • +

    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

    Return type:
    -

    dict

    +

    dict

    Returns:

    The JSON response the API returns.

    @@ -580,9 +584,9 @@
    Parameters:
      -

    • response (aiohttp.ClientResponse) – The response object from the request.

      • -

    • response_json (Optional[dict]) – The JSON response returned from the request, if any.

      • -

    • response_text (Optional[str]) – The text of the request, if any.

      • +

    • response (aiohttp.ClientResponse) – The response object from the request.

      • +

    • response_json (Optional[dict]) – The JSON response returned from the request, if any.

      • +

    • response_text (Optional[str]) – The text of the request, if any.

    diff --git a/v8.0.0-beta.3/output/botcore.utils.caching.html b/v8.0.0-beta.3/output/botcore.utils.caching.html index 14994822..0aaf598b 100644 --- a/v8.0.0-beta.3/output/botcore.utils.caching.html +++ b/v8.0.0-beta.3/output/botcore.utils.caching.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -438,10 +442,10 @@

    Decorator for async cache.

    Parameters:
    -

    arg_offset (int) – The offset for the position of the key argument.

    +

    arg_offset (int) – The offset for the position of the key argument.

    Return type:
    -

    Callable

    +

    Callable

    Returns:

    A decorator to wrap the target function.

    @@ -455,7 +459,7 @@

    Initialise a new AsyncCache instance.

    Parameters:
    -

    max_size (int) – How many items to store in the cache.

    +

    max_size (int) – How many items to store in the cache.

    @@ -466,7 +470,7 @@

    Clear cache instance.

    Return type:
    -

    None

    +

    None

    diff --git a/v8.0.0-beta.3/output/botcore.utils.channel.html b/v8.0.0-beta.3/output/botcore.utils.channel.html index a291e5e4..775a09f6 100644 --- a/v8.0.0-beta.3/output/botcore.utils.channel.html +++ b/v8.0.0-beta.3/output/botcore.utils.channel.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -432,8 +436,8 @@
    Parameters:
    Raises:
    @@ -445,7 +449,7 @@
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -460,12 +464,12 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • -

    • category_id (int) – The category to check for.

      • +

    • channel (TextChannel) – The channel to check.

      • +

    • category_id (int) – The category to check for.

    Return type:
    -

    bool

    +

    bool

    Returns:

    A bool depending on whether the channel is in the category.

    diff --git a/v8.0.0-beta.3/output/botcore.utils.commands.html b/v8.0.0-beta.3/output/botcore.utils.commands.html index 643dc2ad..e65977a7 100644 --- a/v8.0.0-beta.3/output/botcore.utils.commands.html +++ b/v8.0.0-beta.3/output/botcore.utils.commands.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -431,15 +435,15 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • -

    • text (Optional[str]) – The provided text argument of the command (if given)

      • +

    • ctx (Context) – The command’s context

      • +

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:
    -

    str

    +

    str

    Returns:

    The cleaned version of text, if given, else replied message.

    diff --git a/v8.0.0-beta.3/output/botcore.utils.html b/v8.0.0-beta.3/output/botcore.utils.html index b036a61b..68af2db1 100644 --- a/v8.0.0-beta.3/output/botcore.utils.html +++ b/v8.0.0-beta.3/output/botcore.utils.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -431,7 +435,7 @@

    Applies all common monkey patches for our bots.

    Return type:
    -

    None

    +

    None

    @@ -450,10 +454,10 @@ that will act as top-level groups rather than being aliases of the command’s g

    Return an unqualified name given a qualified module/package name.

    Parameters:
    -

    name (str) – The module name to unqualify.

    +

    name (str) – The module name to unqualify.

    Return type:
    -

    str

    +

    str

    Returns:

    The unqualified module name.

    diff --git a/v8.0.0-beta.3/output/botcore.utils.interactions.html b/v8.0.0-beta.3/output/botcore.utils.interactions.html index e7638d73..1e75a109 100644 --- a/v8.0.0-beta.3/output/botcore.utils.interactions.html +++ b/v8.0.0-beta.3/output/botcore.utils.interactions.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -435,7 +439,7 @@
    Parameters:

    • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

      • -

    • label (str) – The label of the button, set to “Delete” if not specified.

      • +

    • label (str) – The label of the button, set to “Delete” if not specified.

    @@ -450,7 +454,7 @@

    Delete the original message on button click.

    Return type:
    -

    None

    +

    None

    @@ -465,11 +469,11 @@
    Parameters:
      -

    • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

      • -

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

      • -

    • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. +

    • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

      • +

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

      • +

    • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

      • -

    • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

    • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    @@ -485,10 +489,10 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:
    -

    bool

    +

    bool

    @@ -499,7 +503,7 @@ If None

    Remove the view from self.message if set.

    Return type:
    -

    None

    +

    None

    diff --git a/v8.0.0-beta.3/output/botcore.utils.logging.html b/v8.0.0-beta.3/output/botcore.utils.logging.html index b4f94b45..45f99d4e 100644 --- a/v8.0.0-beta.3/output/botcore.utils.logging.html +++ b/v8.0.0-beta.3/output/botcore.utils.logging.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -441,13 +445,13 @@
    Parameters:
      -

    • msg (str) – The message to be logged.

      • +

    • msg (str) – The message to be logged.

    • args – Passed to the base log function as is.

    • kwargs – Passed to the base log function as is.

    Return type:
    -

    None

    +

    None

    @@ -460,10 +464,10 @@

    Utility to make mypy recognise that logger is of type CustomLogger.

    Parameters:
    -

    name (Optional[str]) – The name given to the logger.

    +

    name (Optional[str]) – The name given to the logger.

    Return type:
    -

    CustomLogger

    +

    CustomLogger

    Returns:

    An instance of the CustomLogger class.

    diff --git a/v8.0.0-beta.3/output/botcore.utils.members.html b/v8.0.0-beta.3/output/botcore.utils.members.html index c01feab4..3d54b30a 100644 --- a/v8.0.0-beta.3/output/botcore.utils.members.html +++ b/v8.0.0-beta.3/output/botcore.utils.members.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -431,7 +435,7 @@

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Optional[Member]

    +

    Optional[Member]

    Returns:

    The discord.Member or None to indicate the member could not be found.

    @@ -448,13 +452,13 @@
    Parameters:
    Return type:
    -

    None

    +

    None

    diff --git a/v8.0.0-beta.3/output/botcore.utils.regex.html b/v8.0.0-beta.3/output/botcore.utils.regex.html index e035d64c..7356c875 100644 --- a/v8.0.0-beta.3/output/botcore.utils.regex.html +++ b/v8.0.0-beta.3/output/botcore.utils.regex.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • diff --git a/v8.0.0-beta.3/output/botcore.utils.scheduling.html b/v8.0.0-beta.3/output/botcore.utils.scheduling.html index 78500e67..d1b45dc1 100644 --- a/v8.0.0-beta.3/output/botcore.utils.scheduling.html +++ b/v8.0.0-beta.3/output/botcore.utils.scheduling.html @@ -10,9 +10,9 @@ - + @@ -351,6 +351,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -445,10 +449,10 @@ the same ID used to schedule it.

    Return True if a task with the given task_id is currently scheduled.

    Parameters:
    -

    task_id (Hashable) – The task to look for.

    +

    task_id (Hashable) – The task to look for.

    Return type:
    -

    bool

    +

    bool

    Returns:

    True if the task was found.

    @@ -462,7 +466,7 @@ the same ID used to schedule it.

    Initialize a new Scheduler instance.

    Parameters:
    -

    name (str) – The name of the Scheduler. Used in logging, and namespacing.

    +

    name (str) – The name of the Scheduler. Used in logging, and namespacing.

    @@ -473,10 +477,10 @@ the same ID used to schedule it.

    Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

    Parameters:
    -

    task_id (Hashable) – The task’s unique ID.

    +

    task_id (Hashable) – The task’s unique ID.

    Return type:
    -

    None

    +

    None

    @@ -487,7 +491,7 @@ the same ID used to schedule it.

    Unschedule all known tasks.

    Return type:
    -

    None

    +

    None

    @@ -501,12 +505,12 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
    Parameters:
      -

    • task_id (Hashable) – A unique ID to create the task with.

      • -

    • coroutine (Coroutine) – The function to be called.

      • +

    • task_id (Hashable) – A unique ID to create the task with.

      • +

    • coroutine (Coroutine) – The function to be called.

    Return type:
    -

    None

    +

    None

    @@ -523,13 +527,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
    Parameters:
      -

    • time (datetime) – The time to start the task.

      • -

    • task_id (Hashable) – A unique ID to create the task with.

      • -

    • coroutine (Coroutine) – The function to be called.

      • +

    • time (datetime) – The time to start the task.

      • +

    • task_id (Hashable) – A unique ID to create the task with.

      • +

    • coroutine (Coroutine) – The function to be called.

    Return type:
    -

    None

    +

    None

    @@ -543,13 +547,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
    Parameters:
      -

    • delay (Union[int, float]) – How long to wait before starting the task.

      • -

    • task_id (Hashable) – A unique ID to create the task with.

      • -

    • coroutine (Coroutine) – The function to be called.

      • +

    • delay (Union[int, float]) – How long to wait before starting the task.

      • +

    • task_id (Hashable) – A unique ID to create the task with.

      • +

    • coroutine (Coroutine) – The function to be called.

    Return type:
    -

    None

    +

    None

    @@ -565,8 +569,8 @@ otherwise the running loop is used.

    Parameters:
    diff --git a/v8.0.0-beta.3/py-modindex.html b/v8.0.0-beta.3/py-modindex.html index 73bb18d9..ea1a3320 100644 --- a/v8.0.0-beta.3/py-modindex.html +++ b/v8.0.0-beta.3/py-modindex.html @@ -8,9 +8,9 @@ - + @@ -349,6 +349,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • diff --git a/v8.0.0-beta.3/search.html b/v8.0.0-beta.3/search.html index b52dc48c..b779ea68 100644 --- a/v8.0.0-beta.3/search.html +++ b/v8.0.0-beta.3/search.html @@ -7,9 +7,9 @@ Search - Pydis Core v8.0.0-beta.3 - + @@ -348,6 +348,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • diff --git a/v8.0.0-beta.3/searchindex.js b/v8.0.0-beta.3/searchindex.js index 6bd634ee..27af8e73 100644 --- a/v8.0.0-beta.3/searchindex.js +++ b/v8.0.0-beta.3/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "0": [0, 8, 11, 12], "rc2": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "buttonstyl": 11, "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [3, 2, 1, "", "load_extensions"], [3, 2, 1, "", "log_to_dev_log"], [3, 2, 1, "", "on_guild_available"], [3, 2, 1, "", "on_guild_unavailable"], [3, 2, 1, "", "ping_services"], [3, 2, 1, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "close"], [6, 2, 1, "", "delete"], [6, 2, 1, "", "get"], [6, 2, 1, "", "maybe_raise_for_status"], [6, 2, 1, "", "patch"], [6, 2, 1, "", "post"], [6, 2, 1, "", "put"], [6, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 60}, "alltitles": {"Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Submodules": [[3, "submodules"], [7, "submodules"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "async_stats": [[4, "module-botcore.async_stats"]], "Utils": [[7, "module-botcore.utils"]], "site_api": [[6, "module-botcore.site_api"]], "Changelog": [[0, "changelog"]], "Exts": [[5, "module-botcore.exts"]], "caching": [[8, "module-botcore.utils.caching"]], "logging": [[12, "module-botcore.utils.logging"]], "members": [[13, "module-botcore.utils.members"]], "channel": [[9, "module-botcore.utils.channel"]], "interactions": [[11, "module-botcore.utils.interactions"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "regex": [[14, "module-botcore.utils.regex"]], "commands": [[10, "module-botcore.utils.commands"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "0": [0, 8, 11, 12], "rc2": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "buttonstyl": 11, "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [3, 2, 1, "", "load_extensions"], [3, 2, 1, "", "log_to_dev_log"], [3, 2, 1, "", "on_guild_available"], [3, 2, 1, "", "on_guild_unavailable"], [3, 2, 1, "", "ping_services"], [3, 2, 1, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "close"], [6, 2, 1, "", "delete"], [6, 2, 1, "", "get"], [6, 2, 1, "", "maybe_raise_for_status"], [6, 2, 1, "", "patch"], [6, 2, 1, "", "post"], [6, 2, 1, "", "put"], [6, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 60}, "alltitles": {"Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Exts": [[5, "module-botcore.exts"]], "site_api": [[6, "module-botcore.site_api"]], "async_stats": [[4, "module-botcore.async_stats"]], "regex": [[14, "module-botcore.utils.regex"]], "logging": [[12, "module-botcore.utils.logging"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "members": [[13, "module-botcore.utils.members"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Changelog": [[0, "changelog"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "caching": [[8, "module-botcore.utils.caching"]], "commands": [[10, "module-botcore.utils.commands"]], "interactions": [[11, "module-botcore.utils.interactions"]], "channel": [[9, "module-botcore.utils.channel"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.0.0-beta.3/versions.html b/v8.0.0-beta.3/versions.html index 324e8fe8..9d3c5a73 100644 --- a/v8.0.0-beta.3/versions.html +++ b/v8.0.0-beta.3/versions.html @@ -9,9 +9,9 @@ - + @@ -350,6 +350,10 @@ v7.1.1 +
  • + v10.4.0 +
    • +
  • v10.3.0
    • @@ -647,6 +651,12 @@ v7.1.1 + + +
  • + v10.4.0 + +
  • -- cgit v1.2.3