better run command, 3.9.1

Author: Taaku18

CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 This project mostly adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html);
 however, insignificant breaking changes do not guarantee a major version bump, see the reasoning [here](https://github.com/kyb3r/modmail/issues/319). If you're a plugin developer, note the "BREAKING" section.
 
+# v3.9.1
+
+### Internal
+
+- `bot.run` now more gracefully handles closing, similar to how discord.py handles it.
+  - No longer displays `PrivilegedIntentsRequired` exception when exiting when presence intent is disabled.
+
 # v3.9.0
 
 ### Breaking

bot.py

@@ -1,11 +1,12 @@
-__version__ = "3.9.0"
+__version__ = "3.9.1"
 
 
 import asyncio
 import copy
 import logging
 import os
 import re
+import signal
 import sys
 import typing
 from datetime import datetime
@@ -184,40 +185,104 @@ def db(self):
     async def get_prefix(self, message=None):
         return [self.prefix, f"<@{self.user.id}> ", f"<@!{self.user.id}> "]
 
-    def run(self, *args, **kwargs):
+    def run(self):
+        loop = self.loop
+
         try:
-            self.loop.run_until_complete(self.start(self.token))
-        except KeyboardInterrupt:
+            loop.add_signal_handler(signal.SIGINT, lambda: loop.stop())
+            loop.add_signal_handler(signal.SIGTERM, lambda: loop.stop())
+        except NotImplementedError:
             pass
-        except discord.LoginFailure:
-            logger.critical("Invalid token")
-        except discord.PrivilegedIntentsRequired:
-            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."
-            )
+
+        async def runner():
             try:
-                self.loop.run_until_complete(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
+                    # 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."
+                    )
+                    await self.start(self.token)
             except discord.PrivilegedIntentsRequired:
                 logger.critical(
                     "Privileged intents are not explicitly granted in the discord developers dashboard."
                 )
-        except Exception:
-            logger.critical("Fatal exception", exc_info=True)
-        finally:
-            self.loop.run_until_complete(self.logout())
-            for task in asyncio.all_tasks(self.loop):
+            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()
+
+        def stop_loop_on_completion(f):
+            loop.stop()
+
+        def _cancel_tasks():
+            if sys.version_info < (3, 8):
+                task_retriever = asyncio.Task.all_tasks
+            else:
+                task_retriever = asyncio.all_tasks
+
+            tasks = {t for t in task_retriever(loop=loop) if not t.done()}
+
+            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
+                    })
+
+        future = asyncio.ensure_future(runner(), loop=loop)
+        future.add_done_callback(stop_loop_on_completion)
+        try:
+            loop.run_forever()
+        except KeyboardInterrupt:
+            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:
-                self.loop.run_until_complete(asyncio.gather(*asyncio.all_tasks(self.loop)))
-            except asyncio.CancelledError:
-                logger.debug("All pending tasks has been cancelled.")
+                _cancel_tasks()
+                if sys.version_info >= (3, 6):
+                    loop.run_until_complete(loop.shutdown_asyncgens())
             finally:
-                self.loop.run_until_complete(self.session.close())
-                logger.error(" - Shutting down bot - ")
+                logger.info('Closing the event loop.')
+                loop.close()
+
+        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):

pyproject.toml

@@ -21,7 +21,7 @@ exclude = '''
 
 [tool.poetry]
 name = 'Modmail'
-version = '3.8.6'
+version = '3.9.1'
 description = "Modmail is similar to Reddit's Modmail, both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way."
 license = 'AGPL-3.0-only'
 authors = [