feat: implement console ext (#1287)

* feat: implement console ext

* style: linter pass

* ci: correct from checks.

* Update pyproject.toml

Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com>

Author: 3 people

docs/src/Guides/98 2.x Migration.md

@@ -1 +1 @@
-!!! Placeholder for 2.x migration guide
+!!! Placeholder for 2.x migration guide

docs/src/extra.css

@@ -197,4 +197,4 @@ div.doc-contents:not(.first) {
 .md-header__button.md-logo{
     margin-right: 0;
     filter: brightness(0) invert(1); /* makes the logo white */
-}
+}

docs/src/index.md

@@ -76,4 +76,4 @@ async def on_start():
     print("Bot is ready!")
 
 bot.start("token")
-```
+```

interactions/ext/console.py

@@ -0,0 +1,48 @@
+import asyncio
+
+import aiomonitor as aiomonitor
+
+import interactions
+from interactions import Extension
+
+__all__ = ("Console",)
+
+
+class Console(Extension):
+    """
+    Extension that starts the bot with the aiomonitor console active - notably giving you REPL for the bot
+
+    To access the console, you need to connect to the port specified in the constructor, by default 501.
+    On linux, you can do this with `nc localhost 501`, on windows you can use `telnet localhost 501`.
+
+    For both platforms you can also use "python -m aiomonitor.cli -p 501" as a replacement for the above commands.
+
+    Args:
+        port: The port to start the aiomonitor on
+        console_port: The port to start the aiomonitor console on
+        **kwargs: The locals to make available in the console, by default this includes `client`, `bot` and `interactions`
+
+    """
+
+    def __init__(self, client: interactions.Client, port: int = 501, console_port: int = 502, **kwargs) -> None:
+        self.client.astart = self.async_start_bot
+        self.port = port  # 501 was chosen as windows throws a massive fit if you try to use the default port
+        self.console_port = console_port
+        self.locals = kwargs
+
+    async def async_start_bot(self, token: str | None = None) -> None:
+        """Starts the bot with the console active"""
+        old_start = interactions.Client.astart
+
+        _locals = self.locals | {
+            "client": self.client,
+            "bot": self.client,
+            "interactions": interactions,
+        }
+
+        with aiomonitor.start_monitor(
+            loop=asyncio.get_event_loop(), port=self.port, console_port=self.console_port, locals=_locals
+        ) as monitor:
+            self.client.logger.info(f"Started aiomonitor on {monitor._host}:{monitor._port}")  # noqa
+
+            await old_start(self.client, token)

pyproject.toml

@@ -18,10 +18,12 @@ emoji = "^2.1.0"
 # Optional dependencies
 orjson  = {version = "^3.6.8", optional = true}
 jurigged = {version = "^0.5.3", optional = true}
+aioconsole = {version = "^0.6.0", optional = true}
 
 [tool.poetry.extras]
 orjson = ["orjson"]
 jurigged = ["jurigged"]
+aioconsole = ["aioconsole"]
 
 [tool.poetry.group.dev.dependencies]
 black = "^22.3.0"

setup.py

@@ -12,6 +12,7 @@
     "speedup": ["aiodns", "orjson", "Brotli"],
     "sentry": ["sentry-sdk"],
     "jurigged": ["jurigged"],
+    "console": ["aioconsole>=0.6.0"],
 }
 extras_require["all"] = list(itertools.chain.from_iterable(extras_require.values()))
 extras_require["docs"] = extras_require["all"] + [