From 4497a82c504818d61ab18c5251ae2bc42bae279e Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 23 Nov 2024 18:47:50 +0000 Subject: Deploying to docs from @ python-discord/bot-core@bdaaa2e76d4cb32843754757532ef8d73ac97761 πŸš€ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v9.0.0/output/pydis_core.async_stats.html | 28 ++++++---- v9.0.0/output/pydis_core.exts.html | 14 +++-- v9.0.0/output/pydis_core.html | 52 +++++++++++-------- v9.0.0/output/pydis_core.site_api.html | 64 +++++++++++++---------- v9.0.0/output/pydis_core.utils.caching.html | 24 ++++++--- v9.0.0/output/pydis_core.utils.channel.html | 20 ++++--- v9.0.0/output/pydis_core.utils.commands.html | 18 +++++-- v9.0.0/output/pydis_core.utils.cooldown.html | 26 ++++++---- v9.0.0/output/pydis_core.utils.function.html | 36 ++++++++----- v9.0.0/output/pydis_core.utils.html | 20 ++++--- v9.0.0/output/pydis_core.utils.interactions.html | 30 +++++++---- v9.0.0/output/pydis_core.utils.logging.html | 24 ++++++--- v9.0.0/output/pydis_core.utils.members.html | 22 +++++--- v9.0.0/output/pydis_core.utils.regex.html | 16 ++++-- v9.0.0/output/pydis_core.utils.scheduling.html | 66 +++++++++++++----------- 15 files changed, 290 insertions(+), 170 deletions(-) (limited to 'v9.0.0/output') diff --git a/v9.0.0/output/pydis_core.async_stats.html b/v9.0.0/output/pydis_core.async_stats.html index 1834bdeb..ea1322e8 100644 --- a/v9.0.0/output/pydis_core.async_stats.html +++ b/v9.0.0/output/pydis_core.async_stats.html @@ -5,13 +5,13 @@ - + async_stats - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -453,11 +461,11 @@
    Parameters:
    @@ -466,10 +474,10 @@
    async create_socket()[source]ΒΆ
    -

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

    +

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

    Return type:
    -

    None

    +

    None

    @@ -551,7 +559,7 @@ - + diff --git a/v9.0.0/output/pydis_core.exts.html b/v9.0.0/output/pydis_core.exts.html index 4b38ab5d..67ec0061 100644 --- a/v9.0.0/output/pydis_core.exts.html +++ b/v9.0.0/output/pydis_core.exts.html @@ -5,13 +5,13 @@ - + Exts - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -493,7 +501,7 @@ - + diff --git a/v9.0.0/output/pydis_core.html b/v9.0.0/output/pydis_core.html index dc0b75e5..83c2a731 100644 --- a/v9.0.0/output/pydis_core.html +++ b/v9.0.0/output/pydis_core.html @@ -5,13 +5,13 @@ - + Pydis Core - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -453,12 +461,12 @@
    Parameters:
    @@ -471,7 +479,7 @@ a dummy statsd client will be created.

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

    Return type:
    -

    None

    +

    None

    @@ -482,7 +490,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

    @@ -493,7 +501,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

    @@ -504,7 +512,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

    @@ -516,7 +524,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

    @@ -527,7 +535,7 @@ a dummy statsd client will be created.

    Log the given message to #dev-log.

    Return type:
    -

    None

    +

    None

    @@ -540,7 +548,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

    @@ -551,7 +559,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

    @@ -562,7 +570,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

    @@ -575,7 +583,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]

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

    Return type:
    -

    None

    +

    None

    @@ -602,7 +610,7 @@ and
    Return type:
    -

    None

    +

    None

    @@ -612,7 +620,7 @@ gateway event before giving up and thus not populating the cache for unavailable
    exception StartupError(base)[source]ΒΆ
    -

    Bases: Exception

    +

    Bases: Exception

    Exception class for startup errors.

    @@ -816,7 +824,7 @@ gateway event before giving up and thus not populating the cache for unavailable - + diff --git a/v9.0.0/output/pydis_core.site_api.html b/v9.0.0/output/pydis_core.site_api.html index c4df6983..b691a322 100644 --- a/v9.0.0/output/pydis_core.site_api.html +++ b/v9.0.0/output/pydis_core.site_api.html @@ -5,13 +5,13 @@ - + site_api - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -444,7 +452,7 @@
    class APIClient(site_api_url, site_api_token, **session_kwargs)[source]ΒΆ
    -

    Bases: object

    +

    Bases: object

    A wrapper for the Django Site API.

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

    @@ -467,7 +475,7 @@

    Close the aiohttp session.

    Return type:
    -

    None

    +

    None

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

    @@ -499,7 +507,7 @@

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

    Return type:
    -

    dict

    +

    dict

    @@ -511,15 +519,15 @@
    Parameters:
      -

    • response (aiohttp.ClientResponse) – The response to check.

      • -

    • should_raise (bool) – Whether or not to raise an exception.

      • +

    • response (aiohttp.ClientResponse) – The response to check.

      • +

    • should_raise (bool) – Whether or not to raise an exception.

    Raises:

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

    Return type:
    -

    None

    +

    None

    @@ -530,7 +538,7 @@

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

    Return type:
    -

    dict

    +

    dict

    @@ -541,7 +549,7 @@

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

    Return type:
    -

    dict

    +

    dict

    @@ -552,7 +560,7 @@

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

    Return type:
    -

    dict

    +

    dict

    @@ -564,14 +572,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.

    @@ -587,7 +595,7 @@
    exception ResponseCodeError(response, response_json=None, response_text=None)[source]ΒΆ
    -

    Bases: ValueError

    +

    Bases: ValueError

    Raised in APIClient.request() when a non-OK HTTP response is received.

    @@ -596,9 +604,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.

    @@ -699,7 +707,7 @@ - + diff --git a/v9.0.0/output/pydis_core.utils.caching.html b/v9.0.0/output/pydis_core.utils.caching.html index 99da6b18..989d90a2 100644 --- a/v9.0.0/output/pydis_core.utils.caching.html +++ b/v9.0.0/output/pydis_core.utils.caching.html @@ -5,13 +5,13 @@ - + caching - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -444,7 +452,7 @@
    class AsyncCache(max_size=128)[source]ΒΆ
    -

    Bases: object

    +

    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.

    @@ -454,10 +462,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.

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

    @@ -482,7 +490,7 @@

    Clear cache instance.

    Return type:
    -

    None

    +

    None

    @@ -565,7 +573,7 @@ - + diff --git a/v9.0.0/output/pydis_core.utils.channel.html b/v9.0.0/output/pydis_core.utils.channel.html index 30240e27..247b24d8 100644 --- a/v9.0.0/output/pydis_core.utils.channel.html +++ b/v9.0.0/output/pydis_core.utils.channel.html @@ -5,13 +5,13 @@ - + channel - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -449,7 +457,7 @@
    Parameters:

    • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

      • -

    • channel_id (int) – The channel to get/fetch.

      • +

    • channel_id (int) – The channel to get/fetch.

    Raises:
    @@ -477,11 +485,11 @@
    Parameters:

    • channel (TextChannel) – The channel to check.

      • -

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

      • +

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

    Return type:
    -

    bool

    +

    bool

    Returns:

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

    @@ -561,7 +569,7 @@ - + diff --git a/v9.0.0/output/pydis_core.utils.commands.html b/v9.0.0/output/pydis_core.utils.commands.html index 0ea14d63..7a5d74a0 100644 --- a/v9.0.0/output/pydis_core.utils.commands.html +++ b/v9.0.0/output/pydis_core.utils.commands.html @@ -5,13 +5,13 @@ - + commands - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -448,14 +456,14 @@
    Parameters:

    • ctx (Context) – The command’s context

      • -

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

      • +

    • 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.

    @@ -534,7 +542,7 @@ - + diff --git a/v9.0.0/output/pydis_core.utils.cooldown.html b/v9.0.0/output/pydis_core.utils.cooldown.html index b1d13004..66533e62 100644 --- a/v9.0.0/output/pydis_core.utils.cooldown.html +++ b/v9.0.0/output/pydis_core.utils.cooldown.html @@ -5,13 +5,13 @@ - + cooldown - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -444,7 +452,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]ΒΆ
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    @@ -457,7 +465,7 @@

    Run the command this cooldown blocked.

    Return type:
    -

    TypeVar(R)

    +

    TypeVar(R)

    Returns:

    The command’s return value.

    @@ -487,14 +495,14 @@
    Parameters:
      -

    • cooldown_duration (float) – Length of the cooldown in seconds.

      • -

    • send_notice (bool) – If True, notify the user about the cooldown with a reply.

      • -

    • args_preprocessor (Callable[[ParamSpec(P)], Iterable[object]] | None) – If specified, this function is called with the args and kwargs the function is called with, +

    • cooldown_duration (float) – Length of the cooldown in seconds.

      • +

    • send_notice (bool) – If True, notify the user about the cooldown with a reply.

      • +

    • args_preprocessor (Callable[[ParamSpec(P)], Iterable[object]] | None) – If specified, this function is called with the args and kwargs the function is called with, its return value is then used to check for the cooldown instead of the raw arguments.

    Return type:
    -

    Callable[[Callable[[ParamSpec(P)], Awaitable[TypeVar(R)]]], Callable[[ParamSpec(P)], Awaitable[TypeVar(R)]]]

    +

    Callable[[Callable[[ParamSpec(P)], Awaitable[TypeVar(R)]]], Callable[[ParamSpec(P)], Awaitable[TypeVar(R)]]]

    Returns:

    A decorator that adds a wrapper which applies the cooldowns.

    @@ -584,7 +592,7 @@ its return value is then used to check for the cooldown instead of the raw argum - + diff --git a/v9.0.0/output/pydis_core.utils.function.html b/v9.0.0/output/pydis_core.utils.function.html index 87e3caf8..ce74fdaa 100644 --- a/v9.0.0/output/pydis_core.utils.function.html +++ b/v9.0.0/output/pydis_core.utils.function.html @@ -5,13 +5,13 @@ - + function - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -444,7 +452,7 @@
    exception GlobalNameConflictError[source]ΒΆ
    -

    Bases: Exception

    +

    Bases: Exception

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

    @@ -456,17 +464,17 @@
    Parameters:
      -

    • wrapped (Callable[[ParamSpec(_P)], TypeVar(_R)]) – The function to wrap with.

      • -

    • assigned (Sequence[str]) – Sequence of attribute names that are directly assigned from wrapped to wrapper.

      • -

    • updated (Sequence[str]) – Sequence of attribute names that are .update``d on ``wrapper from the attributes on wrapped.

      • -

    • ignored_conflict_names (Set[str]) – A set of names to ignore if a conflict between them is found.

      • +

    • wrapped (Callable[[ParamSpec(_P)], TypeVar(_R)]) – The function to wrap with.

      • +

    • assigned (Sequence[str]) – Sequence of attribute names that are directly assigned from wrapped to wrapper.

      • +

    • updated (Sequence[str]) – Sequence of attribute names that are .update``d on ``wrapper from the attributes on wrapped.

      • +

    • ignored_conflict_names (Set[str]) – A set of names to ignore if a conflict between them is found.

    Return type:
    -

    Callable[[Callable[[ParamSpec(_P)], TypeVar(_R)]], Callable[[ParamSpec(_P)], TypeVar(_R)]]

    +

    Callable[[Callable[[ParamSpec(_P)], TypeVar(_R)]], Callable[[ParamSpec(_P)], TypeVar(_R)]]

    Returns:
    -

    A decorator that behaves like functools.wraps(), +

    A decorator that behaves like functools.wraps(), with the wrapper replaced with the function update_wrapper_globals() returned.

    @@ -487,9 +495,9 @@ changes won’t be reflected in the new function’s globals.

    Parameters:
    Raises:
    @@ -497,7 +505,7 @@ changes won’t be reflected in the new function’s globals.

    and is not in ignored_conflict_names.

    Return type:
    -

    Callable[[ParamSpec(_P)], TypeVar(_R)]

    +

    Callable[[ParamSpec(_P)], TypeVar(_R)]

    @@ -575,7 +583,7 @@ changes won’t be reflected in the new function’s globals.

    - + diff --git a/v9.0.0/output/pydis_core.utils.html b/v9.0.0/output/pydis_core.utils.html index f2541517..1042cab7 100644 --- a/v9.0.0/output/pydis_core.utils.html +++ b/v9.0.0/output/pydis_core.utils.html @@ -5,13 +5,13 @@ - + Utils - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -447,7 +455,7 @@

    Applies all common monkey patches for our bots.

    Return type:
    -

    None

    +

    None

    @@ -466,10 +474,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.

    @@ -639,7 +647,7 @@ that will act as top-level groups rather than being aliases of the command’s g - + diff --git a/v9.0.0/output/pydis_core.utils.interactions.html b/v9.0.0/output/pydis_core.utils.interactions.html index 3a6df197..91f06874 100644 --- a/v9.0.0/output/pydis_core.utils.interactions.html +++ b/v9.0.0/output/pydis_core.utils.interactions.html @@ -5,13 +5,13 @@ - + interactions - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -451,7 +459,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.

    @@ -466,7 +474,7 @@

    Delete the original message on button click.

    Return type:
    -

    None

    +

    None

    @@ -481,11 +489,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.

    @@ -504,7 +512,7 @@ If None

    interaction (Interaction) – The interaction that occurred.

    Return type:
    -

    bool

    +

    bool

    @@ -515,7 +523,7 @@ If None

    Remove the view from self.message if set.

    Return type:
    -

    None

    +

    None

    @@ -603,7 +611,7 @@ If None - + diff --git a/v9.0.0/output/pydis_core.utils.logging.html b/v9.0.0/output/pydis_core.utils.logging.html index 958a3821..9290bf67 100644 --- a/v9.0.0/output/pydis_core.utils.logging.html +++ b/v9.0.0/output/pydis_core.utils.logging.html @@ -5,13 +5,13 @@ - + logging - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -444,8 +452,8 @@
    class CustomLogger(name, level=0)[source]ΒΆ
    -

    Bases: Logger

    -

    Custom implementation of the logging.Logger class with an added trace method.

    +

    Bases: Logger

    +

    Custom implementation of the logging.Logger class with an added trace method.

    trace(msg, *args, **kwargs)[source]ΒΆ
    @@ -457,13 +465,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

    @@ -476,7 +484,7 @@

    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

    @@ -562,7 +570,7 @@ - + diff --git a/v9.0.0/output/pydis_core.utils.members.html b/v9.0.0/output/pydis_core.utils.members.html index 970f7657..aad58176 100644 --- a/v9.0.0/output/pydis_core.utils.members.html +++ b/v9.0.0/output/pydis_core.utils.members.html @@ -5,13 +5,13 @@ - + members - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -447,10 +455,10 @@

    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.

    +

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

    @@ -465,12 +473,12 @@
    Parameters:
    Return type:
    -

    None

    +

    None

    @@ -547,7 +555,7 @@ - + diff --git a/v9.0.0/output/pydis_core.utils.regex.html b/v9.0.0/output/pydis_core.utils.regex.html index 77d49812..b70009bc 100644 --- a/v9.0.0/output/pydis_core.utils.regex.html +++ b/v9.0.0/output/pydis_core.utils.regex.html @@ -5,13 +5,13 @@ - + regex - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -449,7 +457,7 @@

    Warning

    This regex pattern will capture until a whitespace, if you are to use the β€˜invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

    +such as urllib.parse.quote().

    @@ -544,7 +552,7 @@ such as - + diff --git a/v9.0.0/output/pydis_core.utils.scheduling.html b/v9.0.0/output/pydis_core.utils.scheduling.html index e54f888b..03485934 100644 --- a/v9.0.0/output/pydis_core.utils.scheduling.html +++ b/v9.0.0/output/pydis_core.utils.scheduling.html @@ -5,13 +5,13 @@ - + scheduling - Pydis Core v9.0.0 - + @@ -317,6 +317,14 @@ v9.0.0 +
  • + v11.5.0 +
    • + +
  • + v11.4.0 +
    • +
  • v11.3.1
    • @@ -444,7 +452,7 @@
    class Scheduler(name)[source]ΒΆ
    -

    Bases: object

    +

    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 instance’s log messages from other instances. Using the name of the class or module containing @@ -458,16 +466,16 @@ the same ID used to schedule it.

    __contains__(task_id)[source]ΒΆ
    -

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

    +

    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.

    +

    True if the task was found.

    @@ -478,7 +486,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.

    @@ -489,10 +497,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

    @@ -503,7 +511,7 @@ the same ID used to schedule it.

    Unschedule all known tasks.

    Return type:
    -

    None

    +

    None

    @@ -517,12 +525,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

    @@ -539,13 +547,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

    @@ -559,13 +567,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

    @@ -575,23 +583,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
    create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]ΒΆ
    -

    Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

    +

    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.

    Parameters:
    Returns:

    The wrapped task.

    Return type:
    -

    asyncio.Task

    +

    asyncio.Task

    @@ -677,7 +685,7 @@ otherwise the running loop is used.

    - + -- cgit v1.2.3