From b0b758e95eda7e44451abd1b782644ff5d9e03a3 Mon Sep 17 00:00:00 2001 From: shtlrs Date: Sun, 18 Feb 2024 11:34:01 +0100 Subject: document the instance attributes of BotBase --- pydis_core/_bot.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'pydis_core') 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, -- cgit v1.2.3