diff options
author | 2019-10-05 10:20:24 +0200 | |
---|---|---|
committer | 2019-10-05 10:20:24 +0200 | |
commit | 8a8ab1924496560b2f66ff56bd8c9a419d2adb84 (patch) | |
tree | fd15b31312db8118cb3d15fdee00e17f613a0dfa | |
parent | Prepare cogs on cog init & wait for bot ready flag (diff) |
Specify names of "prepare_cog" methods
-rw-r--r-- | bot/cogs/antispam.py | 4 | ||||
-rw-r--r-- | bot/cogs/defcon.py | 4 | ||||
-rw-r--r-- | bot/cogs/doc.py | 6 | ||||
-rw-r--r-- | bot/cogs/logging.py | 4 | ||||
-rw-r--r-- | bot/cogs/moderation.py | 4 | ||||
-rw-r--r-- | bot/cogs/off_topic_names.py | 4 | ||||
-rw-r--r-- | bot/cogs/reddit.py | 4 | ||||
-rw-r--r-- | bot/cogs/reminders.py | 4 | ||||
-rw-r--r-- | bot/cogs/sync/cog.py | 4 |
9 files changed, 19 insertions, 19 deletions
diff --git a/bot/cogs/antispam.py b/bot/cogs/antispam.py index 68b3cf91b..f51804ad3 100644 --- a/bot/cogs/antispam.py +++ b/bot/cogs/antispam.py @@ -107,14 +107,14 @@ class AntiSpam(Cog): self.message_deletion_queue = dict() self.queue_consumption_tasks = dict() - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.alert_on_validation_error()) @property def mod_log(self) -> ModLog: """Allows for easy access of the ModLog cog.""" return self.bot.get_cog("ModLog") - async def prepare_cog(self) -> None: + async def alert_on_validation_error(self) -> None: """Unloads the cog and alerts admins if configuration validation failed.""" await self.bot.wait_until_ready() if self.validation_errors: diff --git a/bot/cogs/defcon.py b/bot/cogs/defcon.py index 93d84e6b5..abbf8c770 100644 --- a/bot/cogs/defcon.py +++ b/bot/cogs/defcon.py @@ -35,14 +35,14 @@ class Defcon(Cog): self.channel = None self.days = timedelta(days=0) - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.sync_settings()) @property def mod_log(self) -> ModLog: """Get currently loaded ModLog cog instance.""" return self.bot.get_cog("ModLog") - async def prepare_cog(self) -> None: + async def sync_settings(self) -> None: """On cog load, try to synchronize DEFCON settings to the API.""" self.bot.wait_until_ready() self.channel = await self.bot.fetch_channel(Channels.defcon) diff --git a/bot/cogs/doc.py b/bot/cogs/doc.py index d503ea4c1..2b0869f04 100644 --- a/bot/cogs/doc.py +++ b/bot/cogs/doc.py @@ -126,10 +126,10 @@ class Doc(commands.Cog): self.bot = bot self.inventories = {} - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.init_refresh_inventory()) - async def prepare_cog(self) -> None: - """Refresh documentation inventory.""" + async def init_refresh_inventory(self) -> None: + """Refresh documentation inventory on cog initialization.""" await self.bot.wait_until_ready() await self.refresh_inventory() diff --git a/bot/cogs/logging.py b/bot/cogs/logging.py index 25b7d77cc..959e185f9 100644 --- a/bot/cogs/logging.py +++ b/bot/cogs/logging.py @@ -15,9 +15,9 @@ class Logging(Cog): def __init__(self, bot: Bot): self.bot = bot - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.startup_greeting()) - async def prepare_cog(self) -> None: + async def startup_greeting(self) -> None: """Announce our presence to the configured devlog channel.""" await self.bot.wait_until_ready() log.info("Bot connected!") diff --git a/bot/cogs/moderation.py b/bot/cogs/moderation.py index 79502ee1c..8a5cb5853 100644 --- a/bot/cogs/moderation.py +++ b/bot/cogs/moderation.py @@ -64,14 +64,14 @@ class Moderation(Scheduler, Cog): self._muted_role = Object(constants.Roles.muted) super().__init__() - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.schedule_infractions()) @property def mod_log(self) -> ModLog: """Get currently loaded ModLog cog instance.""" return self.bot.get_cog("ModLog") - async def prepare_cog(self) -> None: + async def schedule_infractions(self) -> None: """Schedule expiration for previous infractions.""" await self.bot.wait_until_ready() # Schedule expiration for previous infractions diff --git a/bot/cogs/off_topic_names.py b/bot/cogs/off_topic_names.py index eb966c737..ca943e73f 100644 --- a/bot/cogs/off_topic_names.py +++ b/bot/cogs/off_topic_names.py @@ -75,14 +75,14 @@ class OffTopicNames(Cog): self.bot = bot self.updater_task = None - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.init_offtopic_updater()) def cog_unload(self) -> None: """Cancel any running updater tasks on cog unload.""" if self.updater_task is not None: self.updater_task.cancel() - async def prepare_cog(self) -> None: + async def init_offtopic_updater(self) -> None: """Start off-topic channel updating event loop if it hasn't already started.""" self.bot.wait_until_ready() if self.updater_task is None: diff --git a/bot/cogs/reddit.py b/bot/cogs/reddit.py index ba926e166..c7ed01aa1 100644 --- a/bot/cogs/reddit.py +++ b/bot/cogs/reddit.py @@ -33,7 +33,7 @@ class Reddit(Cog): self.new_posts_task = None self.top_weekly_posts_task = None - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.init_reddit_polling()) async def fetch_posts(self, route: str, *, amount: int = 25, params: dict = None) -> List[dict]: """A helper method to fetch a certain amount of Reddit posts at a given route.""" @@ -255,7 +255,7 @@ class Reddit(Cog): max_lines=15 ) - async def prepare_cog(self) -> None: + async def init_reddit_polling(self) -> None: """Initiate reddit post event loop.""" self.bot.wait_until_ready() self.reddit_channel = await self.bot.fetch_channel(Channels.reddit) diff --git a/bot/cogs/reminders.py b/bot/cogs/reminders.py index dc5536b12..eb6e49ba9 100644 --- a/bot/cogs/reminders.py +++ b/bot/cogs/reminders.py @@ -30,9 +30,9 @@ class Reminders(Scheduler, Cog): self.bot = bot super().__init__() - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.reschedule_reminders()) - async def prepare_cog(self) -> None: + async def reschedule_reminders(self) -> None: """Get all current reminders from the API and reschedule them.""" self.bot.wait_until_ready() response = await self.bot.api_client.get( diff --git a/bot/cogs/sync/cog.py b/bot/cogs/sync/cog.py index 15e671ab3..b61b089fc 100644 --- a/bot/cogs/sync/cog.py +++ b/bot/cogs/sync/cog.py @@ -29,9 +29,9 @@ class Sync(Cog): def __init__(self, bot: Bot) -> None: self.bot = bot - bot.loop.create_task(self.prepare_cog()) + bot.loop.create_task(self.sync_guild()) - async def prepare_cog(self) -> None: + async def sync_guild(self) -> None: """Syncs the roles/users of the guild with the database.""" self.bot.wait_until_ready() guild = self.bot.get_guild(self.SYNC_SERVER_ID) |