Added abc for thread, thread manager, config, clients, and bot

This will make debugging future code easier as it introduced deeper type hints and more static types

Author: Taaku18

bot.py

@@ -46,6 +46,7 @@
 from core.thread import ThreadManager
 from core.config import ConfigManager
 from core.changelog import ChangeLog
+from core.objects import Bot
 
 
 colorama.init()
@@ -54,33 +55,65 @@
        Style.RESET_ALL
 
 
-class ModmailBot(commands.Bot):
+class ModmailBot(Bot):
 
     def __init__(self):
         super().__init__(command_prefix=None)  # implemented in `get_prefix`
-        self.version = __version__
-        self.start_time = datetime.utcnow()
-        self.threads = ThreadManager(self)
-        self.session = ClientSession(loop=self.loop)
-        self.config = ConfigManager(self)
-        self.self_hosted = bool(self.config.get('mongo_uri', ''))
+        self._threads = None
+        self._session = None
+        self._config = None
         self._connected = Event()
+        self._db = None
 
         if self.self_hosted:
-            self.db = AsyncIOMotorClient(self.config.mongo_uri).modmail_bot
-            self.modmail_api = SelfHostedClient(self)
+            self._db = AsyncIOMotorClient(self.config.mongo_uri).modmail_bot
+            self._api = SelfHostedClient(self)
         else:
-            self.modmail_api = ModmailApiClient(self)
+            self._api = ModmailApiClient(self)
 
         self.data_task = self.loop.create_task(self.data_loop())
         self.autoupdate_task = self.loop.create_task(self.autoupdate_loop())
-        self._add_commands()
+        self._load_extensions()
         self.owner = None
 
+    @property
+    def version(self):
+        return __version__
+
+    @property
+    def db(self):
+        return self._db
+
+    @property
+    def self_hosted(self):
+        return bool(self.config.get('mongo_uri', ''))
+
+    @property
+    def api(self):
+        return self._api
+
+    @property
+    def config(self):
+        if self._config is None:
+            self._config = ConfigManager(self)
+        return self._config
+
+    @property
+    def session(self):
+        if self._session is None:
+            self._session = ClientSession(loop=self.loop)
+        return self._session
+
+    @property
+    def threads(self):
+        if self._threads is None:
+            self._threads = ThreadManager(self)
+        return self._threads
+
     async def get_prefix(self, message=None):
         return [self.prefix, f'<@{self.user.id}> ', f'<@!{self.user.id}> ']
 
-    def _add_commands(self):
+    def _load_extensions(self):
         """Adds commands automatically"""
         self.remove_command('help')
 
@@ -397,7 +430,7 @@ async def on_message(self, message):
 
         thread = await self.threads.find(channel=ctx.channel)
         if thread is not None:
-            await self.modmail_api.append_log(message, type_='internal')
+            await self.api.append_log(message, type_='internal')
 
     async def on_guild_channel_delete(self, channel):
         if channel.guild != self.modmail_guild:
@@ -454,7 +487,8 @@ async def on_command_error(self, ctx, error):
         else:
             raise error
 
-    def overwrites(self, ctx):  # TODO: can this be static?
+    @staticmethod
+    def overwrites(ctx):
         """Permission overwrites for the guild."""
         overwrites = {
             ctx.guild.default_role: discord.PermissionOverwrite(
@@ -486,14 +520,14 @@ async def validate_api_token(self):
                   'if you are self-hosting logs.')
             return await self.logout()
         else:
-            valid = await self.modmail_api.validate_token()
+            valid = await self.api.validate_token()
             if not valid:
                 print(Fore.RED, end='')
                 print('Invalid MODMAIL_API_TOKEN - get one '
                       'from https://dashboard.modmail.tk')
                 return await self.logout()
 
-        user = await self.modmail_api.get_user_info()
+        user = await self.api.get_user_info()
         username = user['user']['username']
         print(Style.RESET_ALL + Fore.CYAN + 'Validated token.')
         print('GitHub user: ' + username + Style.RESET_ALL)
@@ -533,7 +567,7 @@ async def data_loop(self):
                 "last_updated": str(datetime.utcnow())
             }
 
-            await self.modmail_api.post_metadata(data)
+            await self.api.post_metadata(data)
             await sleep(3600)
 
     async def autoupdate_loop(self):
@@ -551,10 +585,10 @@ async def autoupdate_loop(self):
             return 
 
         while True:
-            metadata = await self.modmail_api.get_metadata()
+            metadata = await self.api.get_metadata()
 
             if metadata['latest_version'] != self.version:
-                data = await self.modmail_api.update_repository()
+                data = await self.api.update_repository()
 
                 embed = discord.Embed(color=discord.Color.green())
 
@@ -598,20 +632,6 @@ async def get_latest_updates(self, limit=3):
 
         return latest_commits
 
-    @property
-    def uptime(self):
-        now = datetime.utcnow()
-        delta = now - self.start_time
-        hours, remainder = divmod(int(delta.total_seconds()), 3600)
-        minutes, seconds = divmod(remainder, 60)
-        days, hours = divmod(hours, 24)
-
-        fmt = '{h}h {m}m {s}s'
-        if days:
-            fmt = '{d}d ' + fmt
-
-        return fmt.format(d=days, h=hours, m=minutes, s=seconds)
-
 
 if __name__ == '__main__':
     uvloop.install()

cogs/modmail.py

@@ -9,13 +9,14 @@
 from core.decorators import trigger_typing
 from core.paginator import PaginatorSession
 from core.time import UserFriendlyTime, human_timedelta
-from core.utils import User, truncate
+from core.utils import truncate, User
+from core.objects import Bot
 
 
 class Modmail:
     """Commands directly related to Modmail functionality."""
 
-    def __init__(self, bot):
+    def __init__(self, bot: Bot):
         self.bot = bot
 
     @commands.command()
@@ -140,7 +141,8 @@ async def move(self, ctx, *, category: discord.CategoryChannel):
         await thread.channel.edit(category=category, sync_permissions=True)
         await ctx.message.add_reaction('✅')
 
-    async def send_scheduled_close_message(self, ctx, after, silent=False):
+    @staticmethod
+    async def send_scheduled_close_message(ctx, after, silent=False):
         human_delta = human_timedelta(after.dt)
 
         silent = '*silently* ' if silent else ''
@@ -354,7 +356,7 @@ async def logs(self, ctx, *, member: User = None):
         icon_url = getattr(user, 'avatar_url', default_avatar)
         username = str(user) if hasattr(user, 'name') else str(user.id)
 
-        logs = await self.bot.modmail_api.get_user_logs(user.id)
+        logs = await self.bot.api.get_user_logs(user.id)
 
         if not any(not log['open'] for log in logs):
             embed = discord.Embed(color=discord.Color.red(),

cogs/utility.py

@@ -18,12 +18,13 @@
 from core.decorators import auth_required, owner_only, trigger_typing
 from core.changelog import ChangeLog
 from core.utils import cleanup_code
+from core.objects import Bot
 
 
 class Utility:
     """General commands that provide utility"""
 
-    def __init__(self, bot):
+    def __init__(self, bot: Bot):
         self.bot = bot
 
     def format_cog_help(self, ctx, cog):
@@ -57,7 +58,7 @@ def format_cog_help(self, ctx, cog):
             embeds.append(embed)
         return embeds
 
-    def format_command_help(self, ctx, cmd):
+    def format_command_help(self, cmd):
         """Formats command help."""
         prefix = self.bot.prefix
         embed = Embed(
@@ -114,7 +115,7 @@ async def help(self, ctx, *, command: str = None):
             cmd = self.bot.get_command(command)
             cog = self.bot.cogs.get(command)
             if cmd is not None:
-                embeds = [self.format_command_help(ctx, cmd)]
+                embeds = [self.format_command_help(cmd)]
             elif cog is not None:
                 embeds = self.format_cog_help(ctx, cog)
             else:
@@ -198,7 +199,7 @@ async def github(self, ctx):
         if ctx.invoked_subcommand:
             return
 
-        data = await self.bot.modmail_api.get_user_info()
+        data = await self.bot.api.get_user_info()
 
         embed = Embed(
             title='Github',
@@ -218,7 +219,8 @@ async def github(self, ctx):
     @trigger_typing
     async def update(self, ctx):
         """Updates the bot, this only works with heroku users."""
-        metadata = await self.bot.modmail_api.get_metadata()
+        # TODO: Should return if user is self hosting
+        metadata = await self.bot.api.get_metadata()
 
         desc = (f'The latest version is [`{self.bot.version}`]'
                 '(https://github.com/kyb3r/modmail/blob/master/bot.py#L25)')
@@ -230,14 +232,14 @@ async def update(self, ctx):
         )
 
         if metadata['latest_version'] == self.bot.version:
-            data = await self.bot.modmail_api.get_user_info()
+            data = await self.bot.api.get_user_info()
             if not data.get('error'):
                 user = data['user']
                 embed.set_author(name=user['username'],
                                  icon_url=user['avatar_url'],
                                  url=user['url'])
         else:
-            data = await self.bot.modmail_api.update_repository()
+            data = await self.bot.api.update_repository()
 
             commit_data = data['data']
             user = data['user']

core/changelog.py

@@ -4,9 +4,11 @@
 from typing import List
 from collections import defaultdict
 
+from core.objects import Bot
+
 
 class Version:
-    def __init__(self, bot, version: str, lines: str):
+    def __init__(self, bot: Bot, version: str, lines: str):
         self.bot = bot 
         self.version = version
         self.lines = [x for x in lines.splitlines() if x]
@@ -49,7 +51,7 @@ class ChangeLog:
                      'kyb3r/modmail/master/CHANGELOG.md')
     regex = re.compile(r'# (v\d+\.\d+\.\d+)([\S\s]*?(?=# v|$))')
 
-    def __init__(self, bot, text: str):
+    def __init__(self, bot: Bot, text: str):
         self.bot = bot
         self.text = text 
         self.versions = [Version(bot, *m) for m in self.regex.findall(text)]
@@ -63,7 +65,7 @@ def embeds(self) -> List[Embed]:
         return [v.embed for v in self.versions]
 
     @classmethod
-    async def from_repo(cls, bot, url: str = ''):
+    async def from_repo(cls, bot, url: str = '') -> 'ChangeLog':
         url = url or cls.changelog_url
         resp = await bot.session.get(url)
         return cls(bot, await resp.text())