bot.utils

Internal utilites.

Submodules

• bot.utils.commands
• bot.utils.exceptions
• bot.utils.extensions
• bot.utils.function
• bot.utils.helpers
• bot.utils.lock
• bot.utils.messages
• bot.utils.services

Package Contents

Classes

CogABCMeta

Metaclass for ABCs meant to be implemented as Cogs.

Functions

find_nth_occurrence(→ int | None)	Return index of n`th occurrence of `substring in string, or None if not found.
has_lines(→ bool)	Return True if string has at least count lines.
pad_base64(→ str)	Return base64 data with padding characters to ensure its length is a multiple of 4.
send_to_paste_service(→ str)	Upload contents to the paste service.

class bot.utils.CogABCMeta(*args: Any, **kwargs: Any)

Bases: discord.ext.commands.CogMeta, abc.ABCMeta

Metaclass for ABCs meant to be implemented as Cogs.

bot.utils.find_nth_occurrence(string: str, substring: str, n: int) → int | None

Return index of n`th occurrence of `substring in string, or None if not found.

bot.utils.has_lines(string: str, count: int) → bool

Return True if string has at least count lines.

bot.utils.pad_base64(data: str) → str

Return base64 data with padding characters to ensure its length is a multiple of 4.

exception bot.utils.PasteTooLongError

Bases: Exception

Raised when content is too large to upload to the paste service.

exception bot.utils.PasteUploadError

Bases: Exception

Raised when an error is encountered uploading to the paste service.

async bot.utils.send_to_paste_service(http_session: aiohttp.ClientSession, contents: str, *, extension: str = '', max_length: int = MAX_PASTE_LENGTH) → str

Upload contents to the paste service.

Add extension to the output URL. Use max_length to limit the allowed contents length to lower than the maximum allowed by the paste service.

Raise ValueError if max_length is greater than the maximum allowed by the paste service. Raise PasteTooLongError if contents is too long to upload, and PasteUploadError if uploading fails.

Return the generated URL with the extension.