From 05394fec96b65e6f97d53a5b4d5fe47b07fcebc2 Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Tue, 28 Jun 2022 12:11:54 +0000 Subject: Deploying to docs from @ python-discord/bot-core@28be7e1e8b712084a883a9199028c0cab876361c πŸš€ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v7.1.3/.buildinfo | 2 +- v7.1.3/.doctrees/changelog.doctree | Bin 65755 -> 65755 bytes v7.1.3/.doctrees/environment.pickle | Bin 2634220 -> 707028 bytes v7.1.3/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.1.3/.doctrees/output/botcore.doctree | Bin 62401 -> 62401 bytes v7.1.3/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.1.3/.doctrees/output/botcore.site_api.doctree | Bin 65271 -> 65271 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.1.3/.doctrees/output/botcore.utils.doctree | Bin 13965 -> 13965 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.1.3/changelog.html | 2 +- v7.1.3/genindex.html | 2 +- v7.1.3/index.html | 2 +- v7.1.3/output/botcore.async_stats.html | 16 +++--- v7.1.3/output/botcore.exts.html | 2 +- v7.1.3/output/botcore.html | 38 +++++++-------- v7.1.3/output/botcore.site_api.html | 40 +++++++-------- v7.1.3/output/botcore.utils.caching.html | 12 ++--- v7.1.3/output/botcore.utils.channel.html | 8 +-- v7.1.3/output/botcore.utils.html | 8 +-- v7.1.3/output/botcore.utils.logging.html | 12 ++--- v7.1.3/output/botcore.utils.members.html | 10 ++-- v7.1.3/output/botcore.utils.regex.html | 4 +- v7.1.3/output/botcore.utils.scheduling.html | 54 ++++++++++----------- v7.1.3/py-modindex.html | 2 +- v7.1.3/search.html | 2 +- v7.1.3/versions.html | 4 +- 32 files changed, 110 insertions(+), 110 deletions(-) (limited to 'v7.1.3') diff --git a/v7.1.3/.buildinfo b/v7.1.3/.buildinfo index 07f5f5f0..f185ad5b 100644 --- a/v7.1.3/.buildinfo +++ b/v7.1.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: 30d5f34d6b98d8f4ebf7e07ca5883674 +config: 4a10d9d1b81c70c7be4cc7612cf5efd3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.3/.doctrees/changelog.doctree b/v7.1.3/.doctrees/changelog.doctree index db53bd00..d1665e96 100644 Binary files a/v7.1.3/.doctrees/changelog.doctree and b/v7.1.3/.doctrees/changelog.doctree differ diff --git a/v7.1.3/.doctrees/environment.pickle b/v7.1.3/.doctrees/environment.pickle index 01e1cd1b..e66f8113 100644 Binary files a/v7.1.3/.doctrees/environment.pickle and b/v7.1.3/.doctrees/environment.pickle differ diff --git a/v7.1.3/.doctrees/index.doctree b/v7.1.3/.doctrees/index.doctree index c65a52a7..5e509eb3 100644 Binary files a/v7.1.3/.doctrees/index.doctree and b/v7.1.3/.doctrees/index.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.async_stats.doctree b/v7.1.3/.doctrees/output/botcore.async_stats.doctree index 12a60ff3..2dd3d27d 100644 Binary files a/v7.1.3/.doctrees/output/botcore.async_stats.doctree and b/v7.1.3/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.doctree b/v7.1.3/.doctrees/output/botcore.doctree index b74434ae..5b164d1d 100644 Binary files a/v7.1.3/.doctrees/output/botcore.doctree and b/v7.1.3/.doctrees/output/botcore.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.exts.doctree b/v7.1.3/.doctrees/output/botcore.exts.doctree index 6fb32019..0d60ec98 100644 Binary files a/v7.1.3/.doctrees/output/botcore.exts.doctree and b/v7.1.3/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.site_api.doctree b/v7.1.3/.doctrees/output/botcore.site_api.doctree index 7133fa53..558f6f58 100644 Binary files a/v7.1.3/.doctrees/output/botcore.site_api.doctree and b/v7.1.3/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.caching.doctree b/v7.1.3/.doctrees/output/botcore.utils.caching.doctree index 54e49665..63382ccf 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.caching.doctree and b/v7.1.3/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.channel.doctree b/v7.1.3/.doctrees/output/botcore.utils.channel.doctree index 0b894ad2..a9a141d2 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.channel.doctree and b/v7.1.3/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.doctree b/v7.1.3/.doctrees/output/botcore.utils.doctree index e840d1d1..06bb7320 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.doctree and b/v7.1.3/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.logging.doctree b/v7.1.3/.doctrees/output/botcore.utils.logging.doctree index 73002236..a16789f5 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.logging.doctree and b/v7.1.3/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.members.doctree b/v7.1.3/.doctrees/output/botcore.utils.members.doctree index ca0a7a0b..affbf146 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.members.doctree and b/v7.1.3/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.regex.doctree b/v7.1.3/.doctrees/output/botcore.utils.regex.doctree index a7810118..b4ac3154 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.regex.doctree and b/v7.1.3/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree index 56935b5a..9e7d0863 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/v7.1.3/changelog.html b/v7.1.3/changelog.html index c14268f1..9a3e3202 100644 --- a/v7.1.3/changelog.html +++ b/v7.1.3/changelog.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • diff --git a/v7.1.3/genindex.html b/v7.1.3/genindex.html index a39741b9..62aa0607 100644 --- a/v7.1.3/genindex.html +++ b/v7.1.3/genindex.html @@ -203,7 +203,7 @@
  • - v7.2.0-alpha + v7.2.0
  • diff --git a/v7.1.3/index.html b/v7.1.3/index.html index c123af39..382f694b 100644 --- a/v7.1.3/index.html +++ b/v7.1.3/index.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • diff --git a/v7.1.3/output/botcore.async_stats.html b/v7.1.3/output/botcore.async_stats.html index 354b5452..c3c298b9 100644 --- a/v7.1.3/output/botcore.async_stats.html +++ b/v7.1.3/output/botcore.async_stats.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -289,11 +289,11 @@
    Parameters:
      -

    • loop (asyncio.AbstractEventLoop) – The event loop to use when creating the -asyncio.loop.create_datagram_endpoint.

      • -

    • host (str) – The host to connect to.

      • -

    • port (int) – The port to connect to.

      • -

    • prefix (Optional[str]) – The prefix to use for all stats.

      • +

    • loop (asyncio.AbstractEventLoop) – The event loop to use when creating the +asyncio.loop.create_datagram_endpoint.

      • +

    • host (str) – The host to connect to.

      • +

    • port (int) – The port to connect to.

      • +

    • prefix (Optional[str]) – The prefix to use for all stats.

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

    diff --git a/v7.1.3/output/botcore.exts.html b/v7.1.3/output/botcore.exts.html index 14f8de9a..95c59a69 100644 --- a/v7.1.3/output/botcore.exts.html +++ b/v7.1.3/output/botcore.exts.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • diff --git a/v7.1.3/output/botcore.html b/v7.1.3/output/botcore.html index 349d0ee8..be0d9b38 100644 --- a/v7.1.3/output/botcore.html +++ b/v7.1.3/output/botcore.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -289,12 +289,12 @@
    Parameters:
    @@ -307,7 +307,7 @@ a dummy statsd client will be created.

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

    Return type:
    -

    None

    +

    None

    @@ -318,7 +318,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

    @@ -329,7 +329,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

    @@ -340,7 +340,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

    @@ -352,7 +352,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

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

    Log the given message to #dev-log.

    Return type:
    -

    None

    +

    None

    @@ -376,7 +376,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

    @@ -387,7 +387,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

    @@ -398,7 +398,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

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

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

    Return type:
    -

    None

    +

    None

    @@ -438,7 +438,7 @@ and
    Return type:
    -

    None

    +

    None

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

    diff --git a/v7.1.3/output/botcore.site_api.html b/v7.1.3/output/botcore.site_api.html index 0ed91557..224af374 100644 --- a/v7.1.3/output/botcore.site_api.html +++ b/v7.1.3/output/botcore.site_api.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -280,7 +280,7 @@
    class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
    -

    Bases: object

    +

    Bases: object

    A wrapper for the Django Site API.

    @@ -289,8 +289,8 @@
    Parameters:
      -

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

      • -

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

      • +

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

    @@ -303,7 +303,7 @@

    Close the aiohttp session.

    Return type:
    -

    None

    +

    None

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

      • +

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

    @@ -335,7 +335,7 @@

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

    Return type:
    -

    dict

    +

    dict

    @@ -348,14 +348,14 @@
    Parameters:

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

      • -

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

      • +

    • 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

    @@ -366,7 +366,7 @@

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

    Return type:
    -

    dict

    +

    dict

    • @@ -377,7 +377,7 @@

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

    Return type:
    -

    dict

    +

    dict

    @@ -388,7 +388,7 @@

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

    Return type:
    -

    dict

    +

    dict

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

      • +

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

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

    @@ -433,7 +433,7 @@
    Parameters:

    • response (aiohttp.ClientResponse) – The response object from the request. And then reverted in 7.1.3.

      • -

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

      • +

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

    • request_text – The text of the request, if any.

    diff --git a/v7.1.3/output/botcore.utils.caching.html b/v7.1.3/output/botcore.utils.caching.html index e9b394c7..c647a897 100644 --- a/v7.1.3/output/botcore.utils.caching.html +++ b/v7.1.3/output/botcore.utils.caching.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -280,7 +280,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.

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

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

    @@ -318,7 +318,7 @@

    Clear cache instance.

    Return type:
    -

    None

    +

    None

    diff --git a/v7.1.3/output/botcore.utils.channel.html b/v7.1.3/output/botcore.utils.channel.html index 2b64c006..0c4cb277 100644 --- a/v7.1.3/output/botcore.utils.channel.html +++ b/v7.1.3/output/botcore.utils.channel.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -285,7 +285,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:
    @@ -313,11 +313,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.

    diff --git a/v7.1.3/output/botcore.utils.html b/v7.1.3/output/botcore.utils.html index 5b372970..85ecd232 100644 --- a/v7.1.3/output/botcore.utils.html +++ b/v7.1.3/output/botcore.utils.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -291,7 +291,7 @@ that will act as top-level groups rather than being aliases of the command’s g
    • Return type:
    -

    None

    +

    None

    @@ -302,10 +302,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/v7.1.3/output/botcore.utils.logging.html b/v7.1.3/output/botcore.utils.logging.html index 8aaaf2b3..a2063ec9 100644 --- a/v7.1.3/output/botcore.utils.logging.html +++ b/v7.1.3/output/botcore.utils.logging.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -280,8 +280,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]#
    @@ -293,13 +293,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

    @@ -312,7 +312,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

    diff --git a/v7.1.3/output/botcore.utils.members.html b/v7.1.3/output/botcore.utils.members.html index 448ebe0f..0d1e1504 100644 --- a/v7.1.3/output/botcore.utils.members.html +++ b/v7.1.3/output/botcore.utils.members.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -283,10 +283,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.

    • @@ -301,11 +301,11 @@
    Parameters:
    Return type:
    -

    None

    +

    None

    diff --git a/v7.1.3/output/botcore.utils.regex.html b/v7.1.3/output/botcore.utils.regex.html index f16688ac..3c4b7b51 100644 --- a/v7.1.3/output/botcore.utils.regex.html +++ b/v7.1.3/output/botcore.utils.regex.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -285,7 +285,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().

    diff --git a/v7.1.3/output/botcore.utils.scheduling.html b/v7.1.3/output/botcore.utils.scheduling.html index 5fca6407..57640d83 100644 --- a/v7.1.3/output/botcore.utils.scheduling.html +++ b/v7.1.3/output/botcore.utils.scheduling.html @@ -205,7 +205,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -280,7 +280,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 @@ -294,16 +294,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.

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

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

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

    Unschedule all known tasks.

    Return type:
    -

    None

    +

    None

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

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

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

    @@ -411,23 +411,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:
      -

    • coro (Awaitable) – The function to call.

      • -

    • suppressed_exceptions (tuple[Type[Exception]]) – Exceptions to be handled by the task.

      • -

    • event_loop (asyncio.AbstractEventLoop) – The loop to create the task from.

      • -

    • kwargs – Passed to asyncio.create_task().

      • +

    • coro (Awaitable) – The function to call.

      • +

    • suppressed_exceptions (tuple[Type[Exception]]) – Exceptions to be handled by the task.

      • +

    • event_loop (asyncio.AbstractEventLoop) – The loop to create the task from.

      • +

    • kwargs – Passed to asyncio.create_task().

    Returns:

    The wrapped task.

    Return type:
    -

    asyncio.Task

    +

    asyncio.Task

    diff --git a/v7.1.3/py-modindex.html b/v7.1.3/py-modindex.html index fd26c28a..9f2444cb 100644 --- a/v7.1.3/py-modindex.html +++ b/v7.1.3/py-modindex.html @@ -203,7 +203,7 @@
  • - v7.2.0-alpha + v7.2.0
  • diff --git a/v7.1.3/search.html b/v7.1.3/search.html index b5343960..177a4fc6 100644 --- a/v7.1.3/search.html +++ b/v7.1.3/search.html @@ -202,7 +202,7 @@
  • - v7.2.0-alpha + v7.2.0
  • diff --git a/v7.1.3/versions.html b/v7.1.3/versions.html index 95cd230f..260ad994 100644 --- a/v7.1.3/versions.html +++ b/v7.1.3/versions.html @@ -204,7 +204,7 @@
  • - v7.2.0-alpha + v7.2.0
  • @@ -287,7 +287,7 @@
  • - v7.2.0-alpha + v7.2.0
    • -- cgit v1.2.3