aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_core
diff options
context:
space:
mode:
authorGravatar shtlrs <[email protected]>2024-02-18 11:34:01 +0100
committerGravatar shtlrs <[email protected]>2024-02-18 11:34:01 +0100
commitb0b758e95eda7e44451abd1b782644ff5d9e03a3 (patch)
tree89a7403303ed712461af6f60a417c2db06ee5faf /pydis_core
parentbump version to 1.7.0 in pyproject.toml (#203) (diff)
document the instance attributes of BotBase
Diffstat (limited to 'pydis_core')
-rw-r--r--pydis_core/_bot.py15
1 files changed, 14 insertions, 1 deletions
diff --git a/pydis_core/_bot.py b/pydis_core/_bot.py
index 2c876d69..56cedb28 100644
--- a/pydis_core/_bot.py
+++ b/pydis_core/_bot.py
@@ -33,7 +33,20 @@ class StartupError(Exception):
class BotBase(commands.Bot):
- """A sub-class that implements many common features that Python Discord bots use."""
+ """
+ A sub-class that implements many common features that Python Discord bots use.
+
+ Attributes:
+ guild_id (int): ID of the guild that the bot belongs to.
+ http_session (aiohttp.ClientSession): The http session used for sending out HTTP requests.
+ api_client (pydis_core.site_api.APIClient): The API client used for communications with the site service.
+ statsd_url (str): The url that statsd sends metrics to.
+ redis_session (async_rediscache.RedisSession): The redis session used to communicate with the Redis instance.
+ stats (pydis_core.async_stats.AsyncStatsClient): The statsd client that sends metrics.
+ all_extensions (frozenset[str]): All extensions that were found within the ``module`` passed to
+ ``self.load_extensions``. Use ``self.extensions`` to get the loaded extensions.
+
+ """
def __init__(
self,