Update to dpy@97fe07edb2f3d0f5a980917fb6ee479bf396fd94 & async changes

Author: fourjr

CHANGELOG.md

@@ -10,8 +10,10 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 
 ### Breaking
 
+- Modmail now requires [`Message Content` privileged intent](https://support-dev.discord.com/hc/en-us/articles/4404772028055-Message-Content-Privileged-Intent-for-Verified-Bots).
 - Upgraded to discord.py v2.0 master ([internal changes](https://gist.github.com/apple502j/f75b4f24652f04de85c7084ffd73ec58), [GH #2990](https://github.com/kyb3r/modmail/issues/2990)).
 - Python 3.8 or higher is required.
+- Asyncio changes ([gist](https://gist.github.com/Rapptz/6706e1c8f23ac27c98cee4dd985c8120))
 
 ### Added
 
@@ -41,11 +43,13 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 - Support LOTTIE stickers. ([GH #3119](https://github.com/kyb3r/modmail/issues/3119))
 - Editing notes now work. ([GH #3094](https://github.com/kyb3r/modmail/issues/3094))
 - Commands now work in threads.
+- Audit log searching now properly works.
 
 ### Internal
 
 - Improve regex parsing of channel topics. ([GH #3114](https://github.com/kyb3r/modmail/issues/3114), [PR #3111](https://github.com/kyb3r/modmail/pull/3111))
 - Add warning if deploying on a developmental version.
+- Extensions are now loaded `on_connect`.
 
 # v3.10.3
 

Pipfile

@@ -11,7 +11,7 @@ pylint = "~=2.9.3"
 [packages]
 aiohttp = "==3.7.4.post0"
 colorama = "~=0.4.4"  # Doesn't officially support Python 3.9 yet, v0.4.5 will support 3.9
-"discord.py" = {ref = "45d498c1b76deaf3b394d17ccf56112fa691d160", git = "https://github.com/Rapptz/discord.py.git"}
+"discord.py" = {ref = "97fe07edb2f3d0f5a980917fb6ee479bf396fd94", git = "https://github.com/Rapptz/discord.py.git"}
 emoji = "~=1.2.0"
 isodate = "~=0.6.0"
 motor = "~=2.4.0"

Pipfile.lock

@@ -1,4 +1,4 @@
-__version__ = "4.0.0-dev6"
+__version__ = "4.0.0-dev7"
 
 
 import asyncio
@@ -67,7 +67,7 @@ class ModmailBot(commands.Bot):
     def __init__(self):
         intents = discord.Intents.all()
         super().__init__(command_prefix=None, intents=intents)  # implemented in `get_prefix`
-        self._session = None
+        self.session = None
         self._api = None
         self.formatter = SafeFormatter()
         self.loaded_cogs = ["cogs.modmail", "cogs.plugins", "cogs.utility"]
@@ -131,10 +131,11 @@ def startup(self):
         logger.info("discord.py: v%s", discord.__version__)
         logger.line()
 
+    async def load_extensions(self):
         for cog in self.loaded_cogs:
             logger.debug("Loading %s.", cog)
             try:
-                self.load_extension(cog)
+                await self.load_extension(cog)
                 logger.debug("Successfully loaded %s.", cog)
             except Exception:
                 logger.exception("Failed to load %s.", cog)
@@ -167,12 +168,6 @@ def _configure_logging(self):
     def version(self):
         return parse_version(__version__)
 
-    @property
-    def session(self) -> ClientSession:
-        if self._session is None:
-            self._session = ClientSession(loop=self.loop)
-        return self._session
-
     @property
     def api(self) -> ApiClient:
         if self._api is None:
@@ -192,102 +187,85 @@ async def get_prefix(self, message=None):
         return [self.prefix, f"<@{self.user.id}> ", f"<@!{self.user.id}> "]
 
     def run(self):
-        loop = self.loop
-
-        try:
-            loop.add_signal_handler(signal.SIGINT, lambda: loop.stop())
-            loop.add_signal_handler(signal.SIGTERM, lambda: loop.stop())
-        except NotImplementedError:
-            pass
-
         async def runner():
-            try:
-                retry_intents = False
+            async with self:
                 try:
-                    await self.start(self.token)
+                    retry_intents = False
+                    try:
+                        await self.start(self.token)
+                    except discord.PrivilegedIntentsRequired:
+                        retry_intents = True
+                    if retry_intents:
+                        await self.http.close()
+                        if self.ws is not None and self.ws.open:
+                            await self.ws.close(code=1000)
+                        self._ready.clear()
+
+                        intents = discord.Intents.default()
+                        intents.members = True
+                        intents.message_content = True
+                        # Try again with members intent
+                        self._connection._intents = intents
+                        logger.warning(
+                            "Attempting to login with only the server members and message content privileged intent. Some plugins might not work correctly."
+                        )
+                        await self.start(self.token)
                 except discord.PrivilegedIntentsRequired:
-                    retry_intents = True
-                if retry_intents:
-                    await self.http.close()
-                    if self.ws is not None and self.ws.open:
-                        await self.ws.close(code=1000)
-                    self._ready.clear()
-                    intents = discord.Intents.default()
-                    intents.members = True
-                    # Try again with members intent
-                    self._connection._intents = intents
-                    logger.warning(
-                        "Attempting to login with only the server members privileged intent. Some plugins might not work correctly."
+                    logger.critical(
+                        "Privileged intents are not explicitly granted in the discord developers dashboard."
                     )
-                    await self.start(self.token)
-            except discord.PrivilegedIntentsRequired:
-                logger.critical(
-                    "Privileged intents are not explicitly granted in the discord developers dashboard."
-                )
-            except discord.LoginFailure:
-                logger.critical("Invalid token")
-            except Exception:
-                logger.critical("Fatal exception", exc_info=True)
-            finally:
-                if not self.is_closed():
-                    await self.close()
-                if self._session:
-                    await self._session.close()
-
-        # noinspection PyUnusedLocal
-        def stop_loop_on_completion(f):
-            loop.stop()
-
-        def _cancel_tasks():
-            task_retriever = asyncio.all_tasks
-            tasks = {t for t in task_retriever(loop=loop) if not t.done()}
-
-            if not tasks:
-                return
+                except discord.LoginFailure:
+                    logger.critical("Invalid token")
+                except Exception:
+                    logger.critical("Fatal exception", exc_info=True)
+                finally:
+                    if not self.is_closed():
+                        await self.close()
+                    if self.session:
+                        await self.session.close()
+
+        async def _cancel_tasks():
+            async with self:
+                task_retriever = asyncio.all_tasks
+                loop = self.loop
+                tasks = {t for t in task_retriever() if not t.done() and t.get_coro() != cancel_tasks_coro}
+
+                if not tasks:
+                    return
 
-            logger.info("Cleaning up after %d tasks.", len(tasks))
-            for task in tasks:
-                task.cancel()
-
-            loop.run_until_complete(asyncio.gather(*tasks, return_exceptions=True))
-            logger.info("All tasks finished cancelling.")
-
-            for task in tasks:
-                if task.cancelled():
-                    continue
-                if task.exception() is not None:
-                    loop.call_exception_handler(
-                        {
-                            "message": "Unhandled exception during Client.run shutdown.",
-                            "exception": task.exception(),
-                            "task": task,
-                        }
-                    )
+                logger.info("Cleaning up after %d tasks.", len(tasks))
+                for task in tasks:
+                    task.cancel()
+
+                await asyncio.gather(*tasks, return_exceptions=True)
+                logger.info("All tasks finished cancelling.")
+
+                for task in tasks:
+                    try:
+                        if task.exception() is not None:
+                            loop.call_exception_handler(
+                                {
+                                    "message": "Unhandled exception during Client.run shutdown.",
+                                    "exception": task.exception(),
+                                    "task": task,
+                                }
+                            )
+                    except (asyncio.InvalidStateError, asyncio.CancelledError):
+                        pass
 
-        future = asyncio.ensure_future(runner(), loop=loop)
-        future.add_done_callback(stop_loop_on_completion)
         try:
-            loop.run_forever()
-        except KeyboardInterrupt:
+            asyncio.run(runner())
+        except (KeyboardInterrupt, SystemExit):
             logger.info("Received signal to terminate bot and event loop.")
         finally:
-            future.remove_done_callback(stop_loop_on_completion)
             logger.info("Cleaning up tasks.")
 
             try:
-                _cancel_tasks()
-                if sys.version_info >= (3, 6):
-                    loop.run_until_complete(loop.shutdown_asyncgens())
+                cancel_tasks_coro = _cancel_tasks()
+                asyncio.run(cancel_tasks_coro)
             finally:
                 logger.info("Closing the event loop.")
 
-        if not future.cancelled():
-            try:
-                return future.result()
-            except KeyboardInterrupt:
-                # I am unsure why this gets raised here but suppress it anyway
-                return None
-
     @property
     def bot_owner_ids(self):
         owner_ids = self.config["owners"]
@@ -517,6 +495,8 @@ async def on_connect(self):
         logger.debug("Connected to gateway.")
         await self.config.refresh()
         await self.api.setup_indexes()
+        await self.load_extensions()
+        self.session = ClientSession(loop=self.loop)
         self._connected.set()
 
     async def on_ready(self):
@@ -1421,7 +1401,7 @@ async def on_message_delete(self, message):
             if embed.footer.icon:
                 icon_url = embed.footer.icon.url
             else:
-                icon_url = discord.Embed.Empty
+                icon_url = None
 
             embed.set_footer(text=f"{embed.footer.text} (deleted)", icon_url=icon_url)
             await message.edit(embed=embed)

bot.py

@@ -2091,5 +2091,5 @@ async def isenable(self, ctx):
         return await ctx.send(embed=embed)
 
 
-def setup(bot):
-    bot.add_cog(Modmail(bot))
+async def setup(bot):
+    await bot.add_cog(Modmail(bot))

cogs/modmail.py

@@ -123,10 +123,10 @@ def __init__(self, bot):
         self.loaded_plugins = set()
         self._ready_event = asyncio.Event()
 
-        self.bot.loop.create_task(self.populate_registry())
-
+    async def async_init(self):
+        await self.populate_registry()
         if self.bot.config.get("enable_plugins"):
-            self.bot.loop.create_task(self.initial_load_plugins())
+            await self.initial_load_plugins()
         else:
             logger.info("Plugins not loaded since ENABLE_PLUGINS=false.")
 
@@ -258,7 +258,7 @@ async def load_plugin(self, plugin):
                 sys.path.insert(0, USER_SITE)
 
         try:
-            self.bot.load_extension(plugin.ext_string)
+            await self.bot.load_extension(plugin.ext_string)
             logger.info("Loaded plugin: %s", plugin.ext_string.split(".")[-1])
             self.loaded_plugins.add(plugin)
 
@@ -432,7 +432,7 @@ async def plugins_remove(self, ctx, *, plugin_name: str):
 
         if self.bot.config.get("enable_plugins"):
             try:
-                self.bot.unload_extension(plugin.ext_string)
+                await self.bot.unload_extension(plugin.ext_string)
                 self.loaded_plugins.remove(plugin)
             except (commands.ExtensionNotLoaded, KeyError):
                 logger.warning("Plugin was never loaded.")
@@ -474,7 +474,7 @@ async def update_plugin(self, ctx, plugin_name):
             await self.download_plugin(plugin, force=True)
             if self.bot.config.get("enable_plugins"):
                 try:
-                    self.bot.unload_extension(plugin.ext_string)
+                    await self.bot.unload_extension(plugin.ext_string)
                 except commands.ExtensionError:
                     logger.warning("Plugin unload fail.", exc_info=True)
                 try:
@@ -525,7 +525,7 @@ async def plugins_reset(self, ctx):
                 continue
             try:
                 logger.error("Unloading plugin: %s.", ext)
-                self.bot.unload_extension(ext)
+                await self.bot.unload_extension(ext)
             except Exception:
                 logger.error("Failed to unload plugin: %s.", ext)
             else:
@@ -737,5 +737,5 @@ async def plugins_registry_compact(self, ctx):
         await paginator.run()
 
 
-def setup(bot):
-    bot.add_cog(Plugins(bot))
+async def setup(bot):
+    await bot.add_cog(Plugins(bot))

cogs/plugins.py

@@ -256,11 +256,13 @@ def __init__(self, bot):
             },
         )
         self.bot.help_command.cog = self
-        self.loop_presence.start()  # pylint: disable=no-member
         if not self.bot.config.get("enable_eval"):
             self.eval_.enabled = False
             logger.info("Eval disabled. enable_eval=False")
 
+    async def async_init(self):
+        self.loop_presence.start()  # pylint: disable=no-member
+
     def cog_unload(self):
         self.bot.help_command = self._original_help_command
 
@@ -2099,5 +2101,5 @@ def paginate(text: str):
         await self.bot.add_reaction(ctx.message, "\u2705")
 
 
-def setup(bot):
-    bot.add_cog(Utility(bot))
+async def setup(bot):
+    await bot.add_cog(Utility(bot))

cogs/utility.py

@@ -308,7 +308,7 @@ def __init__(self, ctx: commands.Context, *embeds, **options):
                 if embed.footer.icon:
                     icon_url = embed.footer.icon.url
                 else:
-                    icon_url = Embed.Empty
+                    icon_url = None
                 embed.set_footer(text=footer_text, icon_url=icon_url)
 
                 # select menu
@@ -369,7 +369,7 @@ def _set_footer(self):
             if self.embed.footer.icon:
                 icon_url = self.embed.footer.icon.url
             else:
-                icon_url = Embed.Empty
+                icon_url = None
 
             self.embed.set_footer(text=footer_text, icon_url=icon_url)