From 1f79f064678ac72a62c34046121386fe8a992a31 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Wed, 1 Jun 2022 17:10:26 +0000 Subject: Deploying to docs from @ python-discord/bot-core@6659680429eec1dd0d45a6332a329a8b5e5a0d0b 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/.buildinfo | 2 +- main/.doctrees/changelog.doctree | Bin 68173 -> 68173 bytes main/.doctrees/environment.pickle | Bin 2606331 -> 2607335 bytes main/.doctrees/index.doctree | Bin 5471 -> 5471 bytes main/.doctrees/output/botcore.async_stats.doctree | Bin 19595 -> 19595 bytes main/.doctrees/output/botcore.doctree | Bin 64337 -> 64337 bytes main/.doctrees/output/botcore.exts.doctree | Bin 3092 -> 3092 bytes main/.doctrees/output/botcore.site_api.doctree | Bin 67547 -> 67547 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16971 -> 16971 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 18442 -> 18442 bytes main/.doctrees/output/botcore.utils.doctree | Bin 14576 -> 14576 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18750 -> 18750 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17389 -> 17389 bytes main/.doctrees/output/botcore.utils.regex.doctree | Bin 9322 -> 9322 bytes .../output/botcore.utils.scheduling.doctree | Bin 56864 -> 56864 bytes main/changelog.html | 4 + main/genindex.html | 4 + main/index.html | 4 + main/output/botcore.async_stats.html | 4 + main/output/botcore.exts.html | 4 + main/output/botcore.html | 4 + main/output/botcore.site_api.html | 4 + main/output/botcore.utils.caching.html | 4 + main/output/botcore.utils.channel.html | 4 + main/output/botcore.utils.html | 4 + main/output/botcore.utils.logging.html | 4 + main/output/botcore.utils.members.html | 4 + main/output/botcore.utils.regex.html | 4 + main/output/botcore.utils.scheduling.html | 4 + main/py-modindex.html | 4 + main/search.html | 4 + main/versions.html | 10 + v7.1.1/.buildinfo | 4 + v7.1.1/.doctrees/changelog.doctree | Bin 0 -> 68173 bytes v7.1.1/.doctrees/environment.pickle | Bin 0 -> 2607339 bytes v7.1.1/.doctrees/index.doctree | Bin 0 -> 5471 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 0 -> 19595 bytes v7.1.1/.doctrees/output/botcore.doctree | Bin 0 -> 64337 bytes v7.1.1/.doctrees/output/botcore.exts.doctree | Bin 0 -> 3092 bytes v7.1.1/.doctrees/output/botcore.site_api.doctree | Bin 0 -> 67547 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 0 -> 16971 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 0 -> 18442 bytes v7.1.1/.doctrees/output/botcore.utils.doctree | Bin 0 -> 14576 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 0 -> 18750 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 0 -> 17389 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 0 -> 9322 bytes .../output/botcore.utils.scheduling.doctree | Bin 0 -> 56864 bytes v7.1.1/.nojekyll | 0 v7.1.1/_sources/changelog.rst.txt | 125 + v7.1.1/_sources/index.rst.txt | 29 + v7.1.1/_sources/output/botcore.async_stats.rst.txt | 7 + v7.1.1/_sources/output/botcore.exts.rst.txt | 7 + v7.1.1/_sources/output/botcore.rst.txt | 25 + v7.1.1/_sources/output/botcore.site_api.rst.txt | 7 + .../_sources/output/botcore.utils.caching.rst.txt | 7 + .../_sources/output/botcore.utils.channel.rst.txt | 7 + .../_sources/output/botcore.utils.logging.rst.txt | 7 + .../_sources/output/botcore.utils.members.rst.txt | 7 + v7.1.1/_sources/output/botcore.utils.regex.rst.txt | 7 + v7.1.1/_sources/output/botcore.utils.rst.txt | 20 + .../output/botcore.utils.scheduling.rst.txt | 7 + v7.1.1/_static/basic.css | 906 ++ v7.1.1/_static/changelog.css | 11 + v7.1.1/_static/changelog.js | 41 + v7.1.1/_static/doctools.js | 358 + v7.1.1/_static/documentation_options.js | 14 + v7.1.1/_static/file.png | Bin 0 -> 286 bytes v7.1.1/_static/index.css | 3 + v7.1.1/_static/jquery-3.5.1.js | 10872 +++++++++++++++++++ v7.1.1/_static/jquery.js | 2 + v7.1.1/_static/language_data.js | 297 + v7.1.1/_static/logo.css | 3 + v7.1.1/_static/minus.png | Bin 0 -> 90 bytes v7.1.1/_static/plus.png | Bin 0 -> 90 bytes v7.1.1/_static/pygments.css | 252 + v7.1.1/_static/scripts/furo-extensions.js | 0 v7.1.1/_static/scripts/furo.js | 3 + v7.1.1/_static/scripts/furo.js.LICENSE.txt | 7 + v7.1.1/_static/scripts/furo.js.map | 1 + v7.1.1/_static/searchtools.js | 525 + v7.1.1/_static/statsd_additional_objects.inv | Bin 0 -> 308 bytes v7.1.1/_static/styles/furo-extensions.css | 2 + v7.1.1/_static/styles/furo-extensions.css.map | 1 + v7.1.1/_static/styles/furo.css | 2 + v7.1.1/_static/styles/furo.css.map | 1 + v7.1.1/_static/underscore-1.13.1.js | 2042 ++++ v7.1.1/_static/underscore.js | 6 + v7.1.1/changelog.html | 466 + v7.1.1/genindex.html | 698 ++ v7.1.1/index.html | 371 + v7.1.1/index_redirect.html | 64 + v7.1.1/objects.inv | Bin 0 -> 1115 bytes v7.1.1/output/botcore.async_stats.html | 359 + v7.1.1/output/botcore.exts.html | 327 + v7.1.1/output/botcore.html | 540 + v7.1.1/output/botcore.site_api.html | 485 + v7.1.1/output/botcore.utils.caching.html | 371 + v7.1.1/output/botcore.utils.channel.html | 373 + v7.1.1/output/botcore.utils.html | 393 + v7.1.1/output/botcore.utils.logging.html | 370 + v7.1.1/output/botcore.utils.members.html | 358 + v7.1.1/output/botcore.utils.regex.html | 354 + v7.1.1/output/botcore.utils.scheduling.html | 473 + v7.1.1/py-modindex.html | 383 + v7.1.1/search.html | 316 + v7.1.1/searchindex.js | 1 + v7.1.1/versions.html | 325 + 107 files changed, 22717 insertions(+), 1 deletion(-) create mode 100644 v7.1.1/.buildinfo create mode 100644 v7.1.1/.doctrees/changelog.doctree create mode 100644 v7.1.1/.doctrees/environment.pickle create mode 100644 v7.1.1/.doctrees/index.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.async_stats.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.exts.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.site_api.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.utils.caching.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.utils.channel.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.utils.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.utils.logging.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.utils.members.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.utils.regex.doctree create mode 100644 v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree create mode 100644 v7.1.1/.nojekyll create mode 100644 v7.1.1/_sources/changelog.rst.txt create mode 100644 v7.1.1/_sources/index.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.async_stats.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.exts.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.site_api.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.utils.caching.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.utils.channel.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.utils.logging.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.utils.members.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.utils.regex.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.utils.rst.txt create mode 100644 v7.1.1/_sources/output/botcore.utils.scheduling.rst.txt create mode 100644 v7.1.1/_static/basic.css create mode 100644 v7.1.1/_static/changelog.css create mode 100644 v7.1.1/_static/changelog.js create mode 100644 v7.1.1/_static/doctools.js create mode 100644 v7.1.1/_static/documentation_options.js create mode 100644 v7.1.1/_static/file.png create mode 100644 v7.1.1/_static/index.css create mode 100644 v7.1.1/_static/jquery-3.5.1.js create mode 100644 v7.1.1/_static/jquery.js create mode 100644 v7.1.1/_static/language_data.js create mode 100644 v7.1.1/_static/logo.css create mode 100644 v7.1.1/_static/minus.png create mode 100644 v7.1.1/_static/plus.png create mode 100644 v7.1.1/_static/pygments.css create mode 100644 v7.1.1/_static/scripts/furo-extensions.js create mode 100644 v7.1.1/_static/scripts/furo.js create mode 100644 v7.1.1/_static/scripts/furo.js.LICENSE.txt create mode 100644 v7.1.1/_static/scripts/furo.js.map create mode 100644 v7.1.1/_static/searchtools.js create mode 100644 v7.1.1/_static/statsd_additional_objects.inv create mode 100644 v7.1.1/_static/styles/furo-extensions.css create mode 100644 v7.1.1/_static/styles/furo-extensions.css.map create mode 100644 v7.1.1/_static/styles/furo.css create mode 100644 v7.1.1/_static/styles/furo.css.map create mode 100644 v7.1.1/_static/underscore-1.13.1.js create mode 100644 v7.1.1/_static/underscore.js create mode 100644 v7.1.1/changelog.html create mode 100644 v7.1.1/genindex.html create mode 100644 v7.1.1/index.html create mode 100644 v7.1.1/index_redirect.html create mode 100644 v7.1.1/objects.inv create mode 100644 v7.1.1/output/botcore.async_stats.html create mode 100644 v7.1.1/output/botcore.exts.html create mode 100644 v7.1.1/output/botcore.html create mode 100644 v7.1.1/output/botcore.site_api.html create mode 100644 v7.1.1/output/botcore.utils.caching.html create mode 100644 v7.1.1/output/botcore.utils.channel.html create mode 100644 v7.1.1/output/botcore.utils.html create mode 100644 v7.1.1/output/botcore.utils.logging.html create mode 100644 v7.1.1/output/botcore.utils.members.html create mode 100644 v7.1.1/output/botcore.utils.regex.html create mode 100644 v7.1.1/output/botcore.utils.scheduling.html create mode 100644 v7.1.1/py-modindex.html create mode 100644 v7.1.1/search.html create mode 100644 v7.1.1/searchindex.js create mode 100644 v7.1.1/versions.html diff --git a/main/.buildinfo b/main/.buildinfo index 704af30a..024ac7f9 100644 --- a/main/.buildinfo +++ b/main/.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: dfb7f9b06ece6930392df78b45ec74be +config: 12a943b524c7791d8b3e0c0c5f1f6647 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/changelog.doctree b/main/.doctrees/changelog.doctree index 820e6533..408a5954 100644 Binary files a/main/.doctrees/changelog.doctree and b/main/.doctrees/changelog.doctree differ diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle index 704cb762..04c403ad 100644 Binary files a/main/.doctrees/environment.pickle and b/main/.doctrees/environment.pickle differ diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree index 86783d36..f6c7581b 100644 Binary files a/main/.doctrees/index.doctree and b/main/.doctrees/index.doctree differ diff --git a/main/.doctrees/output/botcore.async_stats.doctree b/main/.doctrees/output/botcore.async_stats.doctree index 35e1144f..3d1c5d1c 100644 Binary files a/main/.doctrees/output/botcore.async_stats.doctree and b/main/.doctrees/output/botcore.async_stats.doctree differ diff --git a/main/.doctrees/output/botcore.doctree b/main/.doctrees/output/botcore.doctree index a7dc26d1..a88628f0 100644 Binary files a/main/.doctrees/output/botcore.doctree and b/main/.doctrees/output/botcore.doctree differ diff --git a/main/.doctrees/output/botcore.exts.doctree b/main/.doctrees/output/botcore.exts.doctree index 46e7c79c..e838914b 100644 Binary files a/main/.doctrees/output/botcore.exts.doctree and b/main/.doctrees/output/botcore.exts.doctree differ diff --git a/main/.doctrees/output/botcore.site_api.doctree b/main/.doctrees/output/botcore.site_api.doctree index 8f07b207..a81e619d 100644 Binary files a/main/.doctrees/output/botcore.site_api.doctree and b/main/.doctrees/output/botcore.site_api.doctree differ diff --git a/main/.doctrees/output/botcore.utils.caching.doctree b/main/.doctrees/output/botcore.utils.caching.doctree index 59d63135..fcb61ad7 100644 Binary files a/main/.doctrees/output/botcore.utils.caching.doctree and b/main/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/main/.doctrees/output/botcore.utils.channel.doctree b/main/.doctrees/output/botcore.utils.channel.doctree index 8c39a44e..54009bd1 100644 Binary files a/main/.doctrees/output/botcore.utils.channel.doctree and b/main/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/main/.doctrees/output/botcore.utils.doctree b/main/.doctrees/output/botcore.utils.doctree index a5a99b44..d0805501 100644 Binary files a/main/.doctrees/output/botcore.utils.doctree and b/main/.doctrees/output/botcore.utils.doctree differ diff --git a/main/.doctrees/output/botcore.utils.logging.doctree b/main/.doctrees/output/botcore.utils.logging.doctree index 52fbf4fe..057d71da 100644 Binary files a/main/.doctrees/output/botcore.utils.logging.doctree and b/main/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/main/.doctrees/output/botcore.utils.members.doctree b/main/.doctrees/output/botcore.utils.members.doctree index cd3405bc..97c3a61b 100644 Binary files a/main/.doctrees/output/botcore.utils.members.doctree and b/main/.doctrees/output/botcore.utils.members.doctree differ diff --git a/main/.doctrees/output/botcore.utils.regex.doctree b/main/.doctrees/output/botcore.utils.regex.doctree index 8be9efd3..5051faf8 100644 Binary files a/main/.doctrees/output/botcore.utils.regex.doctree and b/main/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/main/.doctrees/output/botcore.utils.scheduling.doctree b/main/.doctrees/output/botcore.utils.scheduling.doctree index 2d00a5d7..643bf214 100644 Binary files a/main/.doctrees/output/botcore.utils.scheduling.doctree and b/main/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/main/changelog.html b/main/changelog.html index 324ce18d..a0e5d794 100644 --- a/main/changelog.html +++ b/main/changelog.html @@ -204,6 +204,10 @@ main +
  • + v7.1.1 +
    • + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    Changelog#

    +
    +

    Next 7.x feature release

    +
    +
    +

    7.1.0 24th May 2022

      +

    • [Feature] #78: Bump Discord.py to 4cbe8f5:

      +
        +

      • This fixes a bug with permission resolution when dealing with timed out members.

        • +
      +
      • +
    +
    +
    +

    7.0.0 10th May 2022

      +

    • [Breaking] #75: Discord invite regex no longer returns a URL safe result, refer to documentation for safely handling it.

      • +

    • [Bug] #75: Capture all characters up to a whitespace in the Discord Invite regex.

      • +
    +
    +
    +

    6.4.0 26th April 2022

      +

    • [Feature] #72: Bump discord.py to 5a06fa5:

      +
        +

      • Notably, one of the commits in this bump dynamically extends the timeout of Guild.chunk() based on the number or members, so it should actually work on our guild now.

        • +
      +
      • +
    +
    +
    +

    6.3.2 25th April 2022

      +

    • [Bug] #69: Actually use statsd_url when it gets passed to BotBase.

      • +
    +
    +
    +

    6.3.1 21st April 2022

      +

    • [Bug] #68: Correct version number in pyproject.toml

      • +
    +
    +
    +

    6.3.0 21st April 2022

      +

    • [Feature]: (Committed directly to main) Don’t load modules starting with _

      • +
    +
    +
    +

    6.2.0 21st April 2022

      +

    • [Feature] #66: Load each cog in it’s own task to avoid a single cog crashing entire load process.

      • +
    +
    +
    +

    6.1.0 20th April 2022

      +

    • [Feature] #65: Add unqualify to the botcore.utils namespace for use in bots that manipulate extensions.

      • +
    +
    +
    +

    6.0.0 19th April 2022

      +

    • [Breaking] #64: Bump discord.py to 987235d:

      +
        +

      • This reverts a change to help command behaviour that broke our custom pagination

        • +

      • This also adds basic forum channel support to discord.py

        • +
      +
      • +
    +
    +
    +

    5.0.4 18th April 2022

      +

    • [Feature] #63: Allow passing an api_client to BotBase.__init__ to specify the botcore.site_api.APIClient instance to use.

      • +
    +
    +
    +

    5.0.3 18th April 2022

      +

    • [Bug] #61: Reconnect to redis session on setup if it is closed.

      • +
    +
    +
    +

    5.0.2 5th April 2022

      +

    • [Bug] #56: Move the creation of the asyncio.Event, BotBase._guild_available to within the setup hook, to avoid a deprecation notice.

      • +

    • [Bug] #56: Create a dummy AsyncstatsdClient before connecting to real url, in case a connection cannot be made on init.

      • +
    +
    +
    +

    5.0.1 2nd April 2022

      +

    • [Bug] #54: Move creation of BotBase’s aiohttp.AsyncResolver to the async setup hook, to avoid deprecation notice

      • +
    +
    +
    +

    5.0.0 2nd April 2022

      +

    • [Breaking] #42: Remove public extensions util.

      • +

    • [Feature] #42: Add async statsd client.

      • +

    • [Feature] #42: Add BotBase, a discord.ext.commands.Bot sub-class, which abstracts a lot of logic shared between our bots.

      • +

    • [Support] #42: Bump Discord.py to latest alpha commit.

      • +
    +
    +
    +

    4.0.0 14th March 2022

      +

    • [Breaking] #39: Migrate back to Discord.py 2.0.

      • +
    +
    +
    +

    3.0.1 5th March 2022

      +

    • [Bug] #37: Setup log tracing when botcore.utils.logging is imported so that it can be used within botcore functions.

      • +
    +
    +
    +

    3.0.0 3rd March 2022

      +

    • [Breaking] #35: Move apply_monkey_patches() directly to botcore.utils namespace.

      • +
    +
    +
    +

    2.1.0 24th February 2022

      +

    • [Feature] #34: Port the Site API wrapper from the bot repo.

      • +
    +
    +
    +

    2.0.0 22nd February 2022

      +

    • [Breaking] #32: Migrate from discord.py 2.0a0 to disnake.

      • +

    • [Breaking] #35: Moved regex to botcore.utils namespace

      • +

    • [Feature] #29: Port many common utilities from our bots:

      +
        +

      • caching

        • +

      • channel

        • +

      • extensions

        • +

      • loggers

        • +

      • members

        • +

      • scheduling

        • +
      +
      • +

    • [Feature] #32: Add common monkey patches.

      • +

    • [Support] #2: Added intersphinx to docs.

      • +
    +
    +
    +

    1.2.0 9th January 2022

      +

    • [Feature] #12: Code block detection regex.

      • +
    +
    +
    +

    1.1.0 2nd December 2021

      +

    • [Feature] #2: Regex utility.

      • +

    • [Support] #2: Autogenerated docs.

      • +
    +
    +
    +

    1.0.0 17th November 2021

      +

    • [Feature] #1: Core package, poetry, and linting CI.

      • +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/genindex.html b/v7.1.1/genindex.html new file mode 100644 index 00000000..fd234697 --- /dev/null +++ b/v7.1.1/genindex.html @@ -0,0 +1,698 @@ + + + + + + + Index - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    + +
    +

    Index

    +
    _ | A | B | C | D | F | G | H | I | L | M | O | P | R | S | T | U | W
    +
    +
    +

    _

    + + + +
    +
    + +
    +

    A

    + + + +
    +
    + +
    +

    B

    + + + +
      +
    • + botcore.utils.caching + +
      • +
    • + botcore.utils.channel + +
      • +
    • + botcore.utils.logging + +
      • +
    • + botcore.utils.members + +
      • +
    • + botcore.utils.regex + +
      • +
    • + botcore.utils.scheduling + +
      • +
    +
    + +
    +

    C

    + + + +
    +
    + +
    +

    D

    + + + +
    +
    + +
    +

    F

    + + +
    +
    + +
    +

    G

    + + + +
    +
    + +
    +

    H

    + + +
    +
    + +
    +

    I

    + + +
    +
    + +
    +

    L

    + + + +
    +
    + +
    +

    M

    + + +
    +
    + +
    +

    O

    + + + +
    +
    + +
    +

    P

    + + + +
    +
    + +
    +

    R

    + + + +
    +
    + +
    +

    S

    + + + +
    +
    + +
    +

    T

    + + +
    +
    + +
    +

    U

    + + +
    +
    + +
    +

    W

    + + +
    +
    + + +
    +
    +
    + +
    + + +
    +
    +
    +
    + Copyright © 2021, Python Discord +
    + Made with Sphinx and @pradyunsg's + + Furo + +
    +
    +
    + +
    +
    +
    + +
    +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/index.html b/v7.1.1/index.html new file mode 100644 index 00000000..5cf46a27 --- /dev/null +++ b/v7.1.1/index.html @@ -0,0 +1,371 @@ + + + + + + + + + Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    + +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/index_redirect.html b/v7.1.1/index_redirect.html new file mode 100644 index 00000000..7e5ad1ed --- /dev/null +++ b/v7.1.1/index_redirect.html @@ -0,0 +1,64 @@ + + + + + + + + + + + + Bot Core v7.1.1 + + + + + + + + + + + + + + + + +
    +

    + Please click here if you were not redirected to the latest build. +

    +
    + + + + + + + + \ No newline at end of file diff --git a/v7.1.1/objects.inv b/v7.1.1/objects.inv new file mode 100644 index 00000000..7d6ef188 Binary files /dev/null and b/v7.1.1/objects.inv differ diff --git a/v7.1.1/output/botcore.async_stats.html b/v7.1.1/output/botcore.async_stats.html new file mode 100644 index 00000000..b518cf31 --- /dev/null +++ b/v7.1.1/output/botcore.async_stats.html @@ -0,0 +1,359 @@ + + + + + + + + + async_stats - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    async_stats#

    +

    An async transport method for statsd communication.

    +
    +
    +class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]#
    +

    Bases: statsd.client.base.StatsClientBase

    +

    An async implementation of statsd.client.base.StatsClientBase that supports async stat communication.

    +
    +
    +__init__(loop, host='localhost', port=8125, prefix=None)[source]#
    +

    Create a new AsyncStatsClient.

    +
    +
    Parameters
    +
    +
    +
    +
    +
    +
    +async create_socket()[source]#
    +

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

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.exts.html b/v7.1.1/output/botcore.exts.html new file mode 100644 index 00000000..7f9b3a57 --- /dev/null +++ b/v7.1.1/output/botcore.exts.html @@ -0,0 +1,327 @@ + + + + + + + + + Exts - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    Exts#

    +

    Reusable Discord cogs.

    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.html b/v7.1.1/output/botcore.html new file mode 100644 index 00000000..3a102868 --- /dev/null +++ b/v7.1.1/output/botcore.html @@ -0,0 +1,540 @@ + + + + + + + + + Botcore - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    Botcore#

    +

    Useful utilities and tools for Discord bot development.

    +
    +
    +class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#
    +

    Bases: discord.ext.commands.bot.Bot

    +

    A sub-class that implements many common features that Python Discord bots use.

    +
    +
    +__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#
    +

    Initialise the base bot instance.

    +
    +
    Parameters
    +
    +
    +
    +
    +
    +
    +async add_cog(cog)[source]#
    +

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

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +add_command(command)[source]#
    +

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

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +clear()[source]#
    +

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

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +async close()[source]#
    +

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

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +async load_extensions(module)[source]#
    +

    Load all the extensions within the given module and save them to self.all_extensions.

    +

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

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +async log_to_dev_log(message)[source]#
    +

    Log the given message to #dev-log.

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +async on_guild_available(guild)[source]#
    +

    Set the internal guild available event when self.guild_id becomes available.

    +

    If the cache appears to still be empty (no members, no channels, or no roles), the event +will not be set and guild_available_but_cache_empty event will be emitted.

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +async on_guild_unavailable(guild)[source]#
    +

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

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +async ping_services()[source]#
    +

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

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +remove_command(name)[source]#
    +

    Remove a command/alias as normal and then remove its root aliases from the bot.

    +

    Individual root aliases cannot be removed by this function. +To remove them, either remove the entire command or manually edit bot.all_commands.

    +
    +
    Return type
    +

    Optional[Command]

    +
    +
    +
    +
    +
    +async setup_hook()[source]#
    +

    An async init to startup generic services.

    +

    Connects to statsd, and calls +AsyncStatsClient.create_socket +and ping_services().

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +async wait_until_guild_available()[source]#
    +

    Wait until the guild that matches the guild_id given at init is available (and the cache is ready).

    +

    The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE +gateway event before giving up and thus not populating the cache for unavailable guilds.

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +
    +exception StartupError(base)[source]#
    +

    Bases: Exception

    +

    Exception class for startup errors.

    +
    +
    +__init__(base)[source]#
    +
    +
    +
    +

    Subpackages#

    +
    + +
    +
    +
    +

    Submodules#

    +
    + +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.site_api.html b/v7.1.1/output/botcore.site_api.html new file mode 100644 index 00000000..c78ef95a --- /dev/null +++ b/v7.1.1/output/botcore.site_api.html @@ -0,0 +1,485 @@ + + + + + + + + + site_api - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    site_api#

    +

    An API wrapper around the Site API.

    +
    +
    +class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
    +

    Bases: object

    +

    A wrapper for the Django Site API.

    +
    +
    +__init__(site_api_url, site_api_token, **session_kwargs)[source]#
    +

    Initialize a new APIClient instance.

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

      • +
    +
    +
    +
    +
    +
    +async close()[source]#
    +

    Close the aiohttp session.

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +

    Send a DELETE request to the site API and return the JSON response.

    +
    +
    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().

      • +
    +
    +
    Return type
    +

    Optional[dict]

    +
    +
    Returns
    +

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

    +
    +
    +
    +
    +
    +async get(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +

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

    +
    +
    Return type
    +

    dict

    +
    +
    +
    +
    +
    +async maybe_raise_for_status(response, should_raise)[source]#
    +

    Raise ResponseCodeError for non-OK response if an exception should be raised.

    +
    +
    Parameters
    +
      +

    • 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

    +
    +
    +
    +
    +
    +async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +

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

    +
    +
    Return type
    +

    dict

    +
    +
    +
    +
    +
    +async post(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +

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

    +
    +
    Return type
    +

    dict

    +
    +
    +
    +
    +
    +async put(endpoint, *, raise_for_status=True, **kwargs)[source]#
    +

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

    +
    +
    Return type
    +

    dict

    +
    +
    +
    +
    +
    +async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#
    +

    Send an HTTP request to the site API and return the JSON response.

    +
    +
    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().

      • +
    +
    +
    Return type
    +

    dict

    +
    +
    Returns
    +

    The JSON response the API returns.

    +
    +
    Raises
    +

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

    +
    +
    +
    +
    +
    +
    +exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
    +

    Bases: ValueError

    +

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

    +
    +
    +__init__(response, response_json=None, response_text=None)[source]#
    +

    Initialize a new ResponseCodeError instance.

    +
    +
    Parameters
    +
      +

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

      • +

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

      • +

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

      • +
    +
    +
    +
    +
    +
    +__str__()[source]#
    +

    Return a string representation of the error.

    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.utils.caching.html b/v7.1.1/output/botcore.utils.caching.html new file mode 100644 index 00000000..0f2272ee --- /dev/null +++ b/v7.1.1/output/botcore.utils.caching.html @@ -0,0 +1,371 @@ + + + + + + + + + caching - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    caching#

    +

    Utilities related to custom caches.

    +
    +
    +class AsyncCache(max_size=128)[source]#
    +

    Bases: object

    +

    LRU cache implementation for coroutines.

    +

    Once the cache exceeds the maximum size, keys are deleted in FIFO order.

    +

    An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.

    +
    +
    +__call__(arg_offset=0)[source]#
    +

    Decorator for async cache.

    +
    +
    Parameters
    +

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

    +
    +
    Return type
    +

    Callable

    +
    +
    Returns
    +

    A decorator to wrap the target function.

    +
    +
    +
    +
    +
    +__init__(max_size=128)[source]#
    +

    Initialise a new AsyncCache instance.

    +
    +
    Parameters
    +

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

    +
    +
    +
    +
    +
    +clear()[source]#
    +

    Clear cache instance.

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.utils.channel.html b/v7.1.1/output/botcore.utils.channel.html new file mode 100644 index 00000000..4c3c3c07 --- /dev/null +++ b/v7.1.1/output/botcore.utils.channel.html @@ -0,0 +1,373 @@ + + + + + + + + + channel - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    channel#

    +

    Useful helper functions for interacting with various discord channel objects.

    +
    +
    +async get_or_fetch_channel(bot, channel_id)[source]#
    +

    Attempt to get or fetch the given channel_id from the bots cache, and return it.

    +
    +
    Parameters
    +
    +
    +
    Raises
    +
    +
    +
    Return type
    +

    GuildChannel

    +
    +
    Returns
    +

    The channel from the ID.

    +
    +
    +
    +
    +
    +is_in_category(channel, category_id)[source]#
    +

    Return whether the given channel in the the category with the id category_id.

    +
    +
    Parameters
    +
      +

    • channel (TextChannel) – The channel to check.

      • +

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

      • +
    +
    +
    Return type
    +

    bool

    +
    +
    Returns
    +

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

    +
    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.utils.html b/v7.1.1/output/botcore.utils.html new file mode 100644 index 00000000..11253a20 --- /dev/null +++ b/v7.1.1/output/botcore.utils.html @@ -0,0 +1,393 @@ + + + + + + + + + Utils - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    Utils#

    +

    Useful utilities and tools for Discord bot development.

    +
    +
    +apply_monkey_patches()[source]#
    +

    Applies all common monkey patches for our bots.

    +
    +
    Patches discord.ext.commands.Command and discord.ext.commands.Group to support root aliases.

    A root_aliases keyword argument is added to these two objects, which is a sequence of alias names +that will act as top-level groups rather than being aliases of the command’s group.

    +

    It’s stored as an attribute also named root_aliases

    +
    +
    Patches discord’s internal send_typing method so that it ignores 403 errors from Discord.

    When under heavy load Discord has added a CloudFlare worker to this route, which causes 403 errors to be thrown.

    +
    +
    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +unqualify(name)[source]#
    +

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

    +
    +
    Parameters
    +

    name (str) – The module name to unqualify.

    +
    +
    Return type
    +

    str

    +
    +
    Returns
    +

    The unqualified module name.

    +
    +
    +
    +
    +

    Submodules#

    +
    + +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.utils.logging.html b/v7.1.1/output/botcore.utils.logging.html new file mode 100644 index 00000000..ec28999f --- /dev/null +++ b/v7.1.1/output/botcore.utils.logging.html @@ -0,0 +1,370 @@ + + + + + + + + + logging - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    logging#

    +

    Common logging related functions.

    +
    +
    +class CustomLogger(name, level=0)[source]#
    +

    Bases: logging.Logger

    +

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

    +
    +
    +trace(msg, *args, **kwargs)[source]#
    +

    Log the given message with the severity "TRACE".

    +

    To pass exception information, use the keyword argument exc_info with a true value:

    +
    logger.trace("Houston, we have an %s", "interesting problem", exc_info=1)
+
    +
    +
    +
    Parameters
    +
      +

    • 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

    +
    +
    +
    +
    +
    +
    +get_logger(name=None)[source]#
    +

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

    +
    +
    Parameters
    +

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

    +
    +
    Return type
    +

    CustomLogger

    +
    +
    Returns
    +

    An instance of the CustomLogger class.

    +
    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.utils.members.html b/v7.1.1/output/botcore.utils.members.html new file mode 100644 index 00000000..ef721598 --- /dev/null +++ b/v7.1.1/output/botcore.utils.members.html @@ -0,0 +1,358 @@ + + + + + + + + + members - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    members#

    +

    Useful helper functions for interactin with discord.Member objects.

    +
    +
    +async get_or_fetch_member(guild, member_id)[source]#
    +

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

    +
    +
    Return type
    +

    Optional[Member]

    +
    +
    Returns
    +

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

    +
    +
    +
    +
    +
    +async handle_role_change(member, coro, role)[source]#
    +

    Await the given coro with member as the sole argument.

    +

    Handle errors that we expect to be raised from +discord.Member.add_roles and discord.Member.remove_roles.

    +
    +
    Parameters
    +
    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.utils.regex.html b/v7.1.1/output/botcore.utils.regex.html new file mode 100644 index 00000000..90f0ce23 --- /dev/null +++ b/v7.1.1/output/botcore.utils.regex.html @@ -0,0 +1,354 @@ + + + + + + + + + regex - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    regex#

    +

    Common regular expressions.

    +
    +
    +DISCORD_INVITE[source]#
    +

    Regex for Discord server invites.

    +
    +

    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().

    +
    +
    +
    +
    +
    +
    +FORMATTED_CODE_REGEX[source]#
    +

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

    +
    +
    +
    +
    +
    +RAW_CODE_REGEX[source]#
    +

    Regex for raw code, not using Discord’s code blocks.

    +
    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/output/botcore.utils.scheduling.html b/v7.1.1/output/botcore.utils.scheduling.html new file mode 100644 index 00000000..c01080f4 --- /dev/null +++ b/v7.1.1/output/botcore.utils.scheduling.html @@ -0,0 +1,473 @@ + + + + + + + + + scheduling - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    +
    +

    scheduling#

    +

    Generic python scheduler.

    +
    +
    +class Scheduler(name)[source]#
    +

    Bases: object

    +

    Schedule the execution of coroutines and keep track of them.

    +

    When instantiating a Scheduler, a name must be provided. This name is used to distinguish the +instance’s log messages from other instances. Using the name of the class or module containing +the instance is suggested.

    +

    Coroutines can be scheduled immediately with schedule or in the future with schedule_at +or schedule_later. A unique ID is required to be given in order to keep track of the +resulting Tasks. Any scheduled task can be cancelled prematurely using cancel by providing +the same ID used to schedule it.

    +

    The in operator is supported for checking if a task with a given ID is currently scheduled.

    +

    Any exception raised in a scheduled task is logged when the task is done.

    +
    +
    +__contains__(task_id)[source]#
    +

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

    +
    +
    Parameters
    +

    task_id (Hashable) – The task to look for.

    +
    +
    Return type
    +

    bool

    +
    +
    Returns
    +

    True if the task was found.

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

    Initialize a new Scheduler instance.

    +
    +
    Parameters
    +

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

    +
    +
    +
    +
    +
    +cancel(task_id)[source]#
    +

    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.

    +
    +
    Return type
    +

    None

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

    Unschedule all known tasks.

    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +schedule(task_id, coroutine)[source]#
    +

    Schedule the execution of a coroutine.

    +

    If a task with task_id already exists, close coroutine instead of scheduling it. This +prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

    +
    +
    Parameters
    +
      +

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

      • +

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

      • +
    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +schedule_at(time, task_id, coroutine)[source]#
    +

    Schedule coroutine to be executed at the given time.

    +

    If time is timezone aware, then use that timezone to calculate now() when subtracting. +If time is naïve, then use UTC.

    +

    If time is in the past, schedule coroutine immediately.

    +

    If a task with task_id already exists, close coroutine instead of scheduling it. This +prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

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

      • +
    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +schedule_later(delay, task_id, coroutine)[source]#
    +

    Schedule coroutine to be executed after delay seconds.

    +

    If a task with task_id already exists, close coroutine instead of scheduling it. This +prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

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

      • +
    +
    +
    Return type
    +

    None

    +
    +
    +
    +
    +
    +
    +create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
    +

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

    +

    If the event_loop kwarg is provided, the task is created from that event loop, +otherwise the running loop is used.

    +
    +
    Parameters
    +
    +
    +
    Returns
    +

    The wrapped task.

    +
    +
    Return type
    +

    asyncio.Task

    +
    +
    +
    +
    + +
    +
    + +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/py-modindex.html b/v7.1.1/py-modindex.html new file mode 100644 index 00000000..79e43acb --- /dev/null +++ b/v7.1.1/py-modindex.html @@ -0,0 +1,383 @@ + + + + + + + Python Module Index - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    + +
    +
    + +
    + + +
    +
    +
    +
    + Copyright © 2021, Python Discord +
    + Made with Sphinx and @pradyunsg's + + Furo + +
    +
    +
    + +
    +
    +
    + +
    +
    + +
    +
    + + + + + + + \ No newline at end of file diff --git a/v7.1.1/search.html b/v7.1.1/search.html new file mode 100644 index 00000000..f5884867 --- /dev/null +++ b/v7.1.1/search.html @@ -0,0 +1,316 @@ + + + + + + + Search - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    + + + +
    + +
    +
    +
    + +
    + + +
    +
    +
    +
    + Copyright © 2021, Python Discord +
    + Made with Sphinx and @pradyunsg's + + Furo + +
    +
    +
    + +
    +
    +
    + +
    +
    + +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/v7.1.1/searchindex.js b/v7.1.1/searchindex.js new file mode 100644 index 00000000..5141746f --- /dev/null +++ b/v7.1.1/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["changelog","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.logging","output/botcore.utils.members","output/botcore.utils.regex","output/botcore.utils.scheduling"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["changelog.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.logging.rst","output/botcore.utils.members.rst","output/botcore.utils.regex.rst","output/botcore.utils.scheduling.rst"],objects:{"":[[2,0,0,"-","botcore"]],"botcore.BotBase":[[2,2,1,"","__init__"],[2,2,1,"","add_cog"],[2,2,1,"","add_command"],[2,2,1,"","clear"],[2,2,1,"","close"],[2,2,1,"","load_extensions"],[2,2,1,"","log_to_dev_log"],[2,2,1,"","on_guild_available"],[2,2,1,"","on_guild_unavailable"],[2,2,1,"","ping_services"],[2,2,1,"","remove_command"],[2,2,1,"","setup_hook"],[2,2,1,"","wait_until_guild_available"]],"botcore.StartupError":[[2,2,1,"","__init__"]],"botcore.async_stats":[[3,1,1,"","AsyncStatsClient"]],"botcore.async_stats.AsyncStatsClient":[[3,2,1,"","__init__"],[3,2,1,"","create_socket"]],"botcore.site_api":[[5,1,1,"","APIClient"],[5,3,1,"","ResponseCodeError"]],"botcore.site_api.APIClient":[[5,2,1,"","__init__"],[5,2,1,"","close"],[5,2,1,"","delete"],[5,2,1,"","get"],[5,2,1,"","maybe_raise_for_status"],[5,2,1,"","patch"],[5,2,1,"","post"],[5,2,1,"","put"],[5,2,1,"","request"]],"botcore.site_api.ResponseCodeError":[[5,2,1,"","__init__"],[5,2,1,"","__str__"]],"botcore.utils":[[6,4,1,"","apply_monkey_patches"],[7,0,0,"-","caching"],[8,0,0,"-","channel"],[9,0,0,"-","logging"],[10,0,0,"-","members"],[11,0,0,"-","regex"],[12,0,0,"-","scheduling"],[6,4,1,"","unqualify"]],"botcore.utils.caching":[[7,1,1,"","AsyncCache"]],"botcore.utils.caching.AsyncCache":[[7,2,1,"","__call__"],[7,2,1,"","__init__"],[7,2,1,"","clear"]],"botcore.utils.channel":[[8,4,1,"","get_or_fetch_channel"],[8,4,1,"","is_in_category"]],"botcore.utils.logging":[[9,1,1,"","CustomLogger"],[9,4,1,"","get_logger"]],"botcore.utils.logging.CustomLogger":[[9,2,1,"","trace"]],"botcore.utils.members":[[10,4,1,"","get_or_fetch_member"],[10,4,1,"","handle_role_change"]],"botcore.utils.regex":[[11,5,1,"","DISCORD_INVITE"],[11,5,1,"","FORMATTED_CODE_REGEX"],[11,5,1,"","RAW_CODE_REGEX"]],"botcore.utils.scheduling":[[12,1,1,"","Scheduler"],[12,4,1,"","create_task"]],"botcore.utils.scheduling.Scheduler":[[12,2,1,"","__contains__"],[12,2,1,"","__init__"],[12,2,1,"","cancel"],[12,2,1,"","cancel_all"],[12,2,1,"","schedule"],[12,2,1,"","schedule_at"],[12,2,1,"","schedule_later"]],botcore:[[2,1,1,"","BotBase"],[2,3,1,"","StartupError"],[3,0,0,"-","async_stats"],[4,0,0,"-","exts"],[5,0,0,"-","site_api"],[6,0,0,"-","utils"]]},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"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:exception","4":"py:function","5":"py:data"},terms:{"0":[0,7,9],"0a0":0,"1":[0,9],"10th":0,"12":0,"128":7,"14th":0,"17th":0,"18th":0,"19th":0,"2":[0,2],"2021":0,"2022":0,"204":5,"20th":0,"21st":0,"22nd":0,"24th":0,"25th":0,"26th":0,"29":0,"2nd":0,"3":0,"32":0,"34":0,"35":0,"37":0,"39":0,"3rd":0,"4":0,"403":6,"42":0,"4cbe8f5":0,"5":0,"54":0,"56":0,"5a06fa5":0,"5th":0,"6":0,"61":0,"63":0,"64":0,"65":0,"66":0,"68":0,"69":0,"7":0,"72":0,"75":0,"78":0,"79":0,"8125":3,"987235d":0,"9th":0,"abstract":0,"break":0,"case":0,"class":[0,2,3,5,7,9,12],"do":8,"float":12,"function":[0,2,7,8,9,10,12],"import":0,"int":[2,3,7,8,12],"long":12,"na\u00efv":12,"new":[3,5,7,12],"public":0,"return":[0,2,3,5,6,7,8,9,10,12],"true":[5,9,12],A:[2,5,6,7,8,12],If:[2,5,12],It:6,No:5,Not:2,The:[2,3,5,6,7,8,9,10,12],To:[2,9],_:0,__call__:7,__contains__:12,__init__:[0,2,3,5,7,12],__str__:5,_guild_avail:0,abstracteventloop:[3,12],act:6,actual:0,ad:[0,6,9],add:[0,2],add_cog:2,add_command:2,add_rol:10,after:12,aiohttp:[0,2,5],alia:[2,6],alias:[2,6],all:[0,2,3,6,12],all_command:2,all_extens:2,allow:[0,2],allowed_rol:2,alpha:0,alreadi:12,also:[0,6],an:[0,2,3,5,6,7,8,9,12],ani:[5,11,12],api:[0,5,10],api_cli:[0,2],apicli:[0,2,5],appear:2,appli:[6,7],apply_monkey_patch:[0,6],april:0,ar:[2,7,11],arg:[2,9],arg_offset:7,argument:[5,6,7,9,10],around:5,async:[0,2,3,5,7,8,10],async_rediscach:2,async_stat:[1,2],asynccach:7,asyncio:[0,3,12],asyncresolv:0,asyncstatscli:[2,3],asyncstatsdcli:0,attempt:[2,8,10],attribut:6,authent:5,autogener:0,avail:[0,2],avoid:[0,2],await:[10,12],awar:12,back:0,base:[0,2,3,5,7,9,12],basic:0,becaus:2,becom:2,befor:[0,2,12],behaviour:0,being:6,between:0,block:[0,11],bool:[5,8,12],bot:[0,2,6,8],botbas:[0,2],botcor:[0,1],broke:0,bug:0,bump:0,cach:[0,2,6,8,10],calcul:12,call:[2,12],callabl:[7,10],can:[0,12],cancel:12,cancel_al:12,cannot:[0,2],captur:[0,11],categori:8,category_id:8,caus:[2,6],chang:0,changelog:1,channel:[0,2,6],channel_id:8,charact:0,check:[5,8,12],chunk:0,ci:0,clear:[2,7],client:[0,2,3],clientrespons:5,clientsess:[2,5],close:[0,2,5,12],cloudflar:6,code:[0,11],cog:[0,2,4],command:[0,2,6,8],commit:0,common:[0,2,6,9,11],commun:3,connect:[0,2,3],connector:2,constructor:5,contain:12,content:5,core:0,coro:[10,12],coroutin:[7,10,12],correct:0,could:10,crash:0,creat:[0,2,3,7,12],create_datagram_endpoint:3,create_socket:[2,3],create_task:12,creation:0,current:12,custom:[0,7,9],customlogg:9,datetim:12,deadlock:2,deal:0,decemb:0,decor:7,delai:12,delet:[5,7],depend:8,deprec:0,detect:0,dev:2,develop:[2,6],dict:5,directli:0,discord:[0,2,4,6,8,10,11],discord_invit:11,disnak:0,distinguish:12,django:5,doc:0,document:0,doesn:12,don:[0,12],done:12,dummi:[0,2],dynam:0,each:0,edit:2,either:2,elsewher:12,emit:2,empti:2,endpoint:5,ensur:[2,11],entir:[0,2],equival:5,error:[2,5,6,10],event:[0,2,3,12],event_loop:12,exc_info:9,exce:7,except:[2,5,9,12],execut:12,exist:12,expect:10,express:11,ext:[0,1,2,6,8],extend:0,extens:[0,2],extra:5,fail:8,failur:10,featur:[0,2],februari:0,fetch:[8,10],fifo:7,fix:0,forbidden:8,format:11,formatted_code_regex:11,forum:0,found:[10,12],from:[0,2,3,5,6,8,10,12],futur:12,gatewai:2,gener:[2,12],get:[0,5,8,10],get_logg:9,get_or_fetch_channel:8,get_or_fetch_memb:10,give:2,given:[2,3,6,8,9,10,12],group:[6,11],guild:[0,2,10],guild_available_but_cache_empti:2,guild_creat:2,guild_id:2,guildchannel:8,ha:6,handl:[0,10,12],handle_role_chang:10,hashabl:12,have:[8,9],heavi:6,help:0,helper:[8,10],hook:0,host:3,houston:9,how:[7,12],http:[5,11],http_session:2,httpexcept:8,id:[2,8,12],identifi:12,ignor:6,immedi:12,implement:[2,3,7,9],inadequ:2,index:1,indic:10,individu:2,inform:[1,9],init:[0,2,3],initi:[5,12],initialis:[2,7],instanc:[0,2,5,7,8,9,12],instanti:[2,12],instead:[2,12],intend:10,interact:8,interactin:10,interest:9,intern:[2,6],intersphinx:0,invalid:8,invaliddata:8,invit:[0,11],is_in_categori:8,item:7,its:2,januari:0,json:5,keep:12,kei:7,keyword:[5,6,9],known:12,kwarg:[2,5,9,12],latest:0,level:[6,9],lint:0,list:2,ll:12,load:[0,2,6],load_extens:2,localhost:3,log:[0,2,6,12],log_to_dev_log:2,logger:[0,9],logic:0,longer:0,look:12,loop:[2,3,12],lot:0,lru:7,made:0,mai:[0,7],main:0,make:[0,9],mani:[0,2,7],manipul:0,manual:2,march:0,match:2,max_siz:7,maximum:7,maybe_raise_for_statu:5,member:[0,2,6],member_id:10,mention:2,messag:[2,9,12],method:[3,5,6,9],migrat:0,modul:[0,2,6,12],monkei:[0,6],move:0,msg:9,multivers:0,must:12,mypi:9,name:[2,6,9,12],namespac:[0,12],next:0,non:5,none:[2,3,5,6,7,9,10,12],normal:2,notabl:0,notfound:8,notic:0,novemb:0,now:[0,12],number:0,object:[5,6,7,8,10,12],offset:7,ok:5,older:0,on_guild_avail:2,on_guild_unavail:2,on_readi:2,onc:7,one:[0,2],onli:2,oper:[2,12],option:[2,3,5,7,9,10],order:[7,12],other:12,otherwis:12,our:[0,6],out:0,output:11,own:0,packag:[0,6],page:1,pagin:0,paramet:[2,3,5,6,7,8,9,10,12],pars:11,pass:[0,5,9,10,12],past:12,patch:[0,5,6],pattern:11,permiss:[0,8],ping:2,ping_servic:2,pleas:11,poetri:0,popul:2,port:[0,3],posit:7,post:5,prefix:3,prematur:12,prevent:12,problem:9,process:0,provid:[7,12],put:5,py:0,pyproject:0,python:[2,12],qualifi:6,quot:11,rais:[5,8,10,12],raise_for_statu:5,ran:2,rather:6,raw:11,raw_code_regex:11,re:[2,12],readi:2,real:0,receiv:[5,8],recognis:9,reconnect:0,redi:0,redis_sess:2,redissess:2,refer:0,regex:[0,2,6],regular:11,relat:[7,9],releas:0,remov:[0,2],remove_command:2,remove_rol:10,repo:0,represent:5,request:[5,11],request_text:5,requir:[2,12],resolut:0,resolv:2,respons:5,response_json:5,response_text:5,responsecodeerror:5,restor:0,result:[0,12],retriev:8,reusabl:4,revert:0,role:[2,10],root:[2,6],root_alias:6,rout:6,run:12,s:[0,6,7,9,11,12],safe:0,same:12,sanitis:11,save:2,schedul:[0,2,6],schedule_at:12,schedule_lat:12,search:1,second:[2,12],self:2,send:5,send_typ:6,sequenc:6,server:[2,11],servic:2,session:[0,2,5],session_kwarg:5,set:2,setup:[0,2],setup_hook:2,sever:9,share:0,should:[0,2,5],should_rais:5,similar:11,singl:0,site:[0,5],site_api:[0,1,2],site_api_token:5,site_api_url:5,size:7,so:[0,6],socket:3,sole:10,someth:11,sourc:[2,3,5,6,7,8,9,10,11,12],specifi:0,sphinx:0,start:[0,2,12],startup:2,startuperror:2,stat:3,statsclientbas:3,statsd:[0,2,3],statsd_url:[0,2],still:2,store:[6,7],str:[2,3,5,6,9,12],string:5,sub:[0,2],submodul:1,subpackag:1,subtract:12,suggest:12,support:[0,3,6,12],suppressed_except:12,t:[0,12],target:7,task:[0,2,12],task_id:12,text:5,textchannel:8,than:6,thei:2,them:[2,12],thi:[0,2,6,8,10,11,12],thrown:6,thu:2,time:[0,12],timeout:0,timezon:12,token:5,toml:0,tool:[2,6],top:6,trace:[0,9],track:12,transport:3,tupl:12,two:6,type:[2,3,5,6,7,8,9,10,12],unavail:2,unawait:12,under:6,union:12,uniqu:12,unknown:8,unqualifi:[0,6],unschedul:12,until:[2,11],up:[0,2],url:[0,2,5],urllib:11,us:[0,2,3,5,6,8,9,10,11,12],utc:12,util:[0,1,2,7,9],valu:9,valueerror:5,variou:8,version:0,wa:[8,12],wait:[2,12],wait_for:2,wait_until_guild_avail:2,warn:12,we:[9,10],when:[0,2,3,5,6,7,12],whether:[5,8],which:[0,6,12],whitespac:[0,11],within:[0,2],work:0,worker:6,wrap:[7,12],wrapper:[0,5,12],x:0,you:[8,11]},titles:["Changelog","Bot Core Project Documentation","Botcore","async_stats","Exts","site_api","Utils","caching","channel","logging","members","regex","scheduling"],titleterms:{async_stat:3,bot:1,botcor:2,cach:7,changelog:0,channel:8,core:1,document:1,ext:4,extra:1,log:9,member:10,modul:1,project:1,refer:1,regex:11,schedul:12,site_api:5,submodul:[2,6],subpackag:2,util:6}}) \ No newline at end of file diff --git a/v7.1.1/versions.html b/v7.1.1/versions.html new file mode 100644 index 00000000..b896d333 --- /dev/null +++ b/v7.1.1/versions.html @@ -0,0 +1,325 @@ + + + + + + + + Versions - Bot Core v7.1.1 + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Bot Core v7.1.1
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    + +
    + +
    +
    + +

    Versions

    +
    +
    Documentation is available for the following versions:
    +
      + + +
    • + main + + - latest +
      • + +
    • + v7.1.1 + (current) + +
      • + +
    +
    + +
    +
    +
    + +
    + + +
    +
    +
    +
    + Copyright © 2021, Python Discord +
    + Made with Sphinx and @pradyunsg's + + Furo + +
    +
    +
    + +
    +
    +
    + +
    +
    + +
    +
    + + + + + + + \ No newline at end of file -- cgit v1.2.3