Fix logging noise within the logging channel (#39)

* remove pythonista-api logging noise

* fix reply shims as per earlier edits

Author: AbstractUmbra

core/utils/logging.py

@@ -25,6 +25,14 @@ def emit(self, record: logging.LogRecord) -> None:
         self.bot.logging_queue.put_nowait(record)
 
 
+class PAPILoggingFilter(logging.Filter):
+    def __init__(self) -> None:
+        super().__init__(name="modules.api")
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        return not ("Received HELLO" in record.msg or "added our subscription" in record.msg)
+
+
 class LogHandler:
     def __init__(self, *, bot: Bot, stream: bool = True) -> None:
         self.log: logging.Logger = logging.getLogger()
@@ -47,6 +55,7 @@ def __enter__(self: Self) -> Self:
         logging.getLogger("discord.http").setLevel(logging.INFO)
         logging.getLogger("discord.state").setLevel(logging.WARNING)
         logging.getLogger("discord.gateway").setLevel(logging.WARNING)
+        logging.getLogger("modules.api").addFilter(PAPILoggingFilter())
 
         self.log.setLevel(logging.INFO)
         handler = RotatingFileHandler(

modules/api.py

@@ -49,7 +49,7 @@ def __init__(self, bot: core.Bot) -> None:
         self.bot = bot
 
         self.session: aiohttp.ClientSession | None = None
-        self.backoff: ExponentialBackoff = ExponentialBackoff()  # type: ignore
+        self.backoff: ExponentialBackoff[bool] = ExponentialBackoff()
         self.websocket: aiohttp.ClientWebSocketResponse | None = None
 
         self.connection_task: asyncio.Task[None] | None = None
@@ -68,7 +68,7 @@ async def cog_unload(self) -> None:
             try:
                 self.connection_task.cancel()
             except Exception as e:
-                LOGGER.debug(f'Unable to cancel Pythonista API connection_task in "cog_unload": {e}')
+                LOGGER.error(f'Unable to cancel Pythonista API connection_task in "cog_unload": {e}')
 
         if self.is_connected():
             assert self.websocket
@@ -78,7 +78,7 @@ async def cog_unload(self) -> None:
             try:
                 self.keep_alive_task.cancel()
             except Exception as e:
-                LOGGER.debug(f'Unable to cancel Pythonista API keep_alive_task in "cog_unload": {e}')
+                LOGGER.error(f'Unable to cancel Pythonista API keep_alive_task in "cog_unload": {e}')
 
     def dispatch(self, *, data: dict[str, Any]) -> None:
         subscription: str = data["subscription"]
@@ -98,7 +98,7 @@ async def connect(self) -> None:
             try:
                 self.keep_alive_task.cancel()
             except Exception as e:
-                LOGGER.debug(f"Failed to cancel Pythonista API Websocket keep alive. This is likely not a problem: {e}")
+                LOGGER.warning(f"Failed to cancel Pythonista API Websocket keep alive. This is likely not a problem: {e}")
 
         while True:
             try:
@@ -108,13 +108,13 @@ async def connect(self) -> None:
                     LOGGER.critical("Unable to connect to Pythonista API Websocket, due to an incorrect token.")
                     return
                 else:
-                    LOGGER.debug(f"Unable to connect to Pythonista API Websocket: {e}.")
+                    LOGGER.error(f"Unable to connect to Pythonista API Websocket: {e}.")
 
             if self.is_connected():
                 break
             else:
                 delay: float = self.backoff.delay()  # type: ignore
-                LOGGER.debug(f'Retrying Pythonista API Websocket connection in "{delay}" seconds.')
+                LOGGER.warning(f'Retrying Pythonista API Websocket connection in "{delay}" seconds.')
 
                 await asyncio.sleep(delay)
 
@@ -148,7 +148,7 @@ async def keep_alive(self) -> None:
             op: int | None = data.get("op")
 
             if op == PAPIWebsocketOPCodes.HELLO:
-                LOGGER.info(f'Received HELLO from Pythonista API: user={data["user_id"]}')
+                LOGGER.debug(f'Received HELLO from Pythonista API: user={data["user_id"]}')
 
             elif op == PAPIWebsocketOPCodes.EVENT:
                 self.dispatch(data=data)

modules/manuals.py

@@ -128,7 +128,7 @@ async def rtfm(self, ctx: core.Context, *, query: str) -> None:
                 await ctx.reply("Sorry, I couldn't apply a default library to this channel. Try again with a library?")
                 return
 
-            await ctx.reply(str(lib.value), reference=ctx.replied_message)
+            await ctx.send(str(lib.value), reference=ctx.replied_message)
             return
 
         labels = False
@@ -161,7 +161,7 @@ async def rtfm(self, ctx: core.Context, *, query: str) -> None:
             return
 
         if not final_query:
-            await ctx.reply(str(lib.value[0]), reference=ctx.replied_message)
+            await ctx.send(str(lib.value[0]), reference=ctx.replied_message)
             return
 
         url = self.target.with_path("/api/public/rtfm.sphinx").with_query(
@@ -226,7 +226,7 @@ async def rtfs(self, ctx: core.Context, *, query: str) -> None:
                 await ctx.reply("Sorry, I couldn't apply a default library to this channel. Try again with a library?")
                 return
 
-            await ctx.reply(str(lib.value), reference=ctx.replied_message)
+            await ctx.send(str(lib.value), reference=ctx.replied_message)
             return
 
         source = False
@@ -297,7 +297,7 @@ async def rtfs(self, ctx: core.Context, *, query: str) -> None:
 
         else:
             n = next(iter(nodes.items()))
-            await ctx.reply(f"Showing source for `{n[0]}`\nCommit: {matches['commit'][:6]}", reference=ctx.replied_message)
+            await ctx.send(f"Showing source for `{n[0]}`\nCommit: {matches['commit'][:6]}", reference=ctx.replied_message)
 
             pages = TextPager(ctx, n[1], prefix="```py")
             await pages.paginate()