Remove requirement for 'difficult' config keys. (#45)

* remove keys that make this bot hard to run

* pyright didnt flag this as accessed

Author: AbstractUmbra

config.template.toml

@@ -3,9 +3,9 @@ owner_ids = [123, 456, 789] # user or role ids, optional
 
 [TOKENS]
 bot = ''
-idevision = ''
-mystbin = ''
-pythonista = ''
+idevision = ''  # optional key
+mystbin = ''  # optional key
+pythonista = ''  # optional key
 
 [DATABASE]
 dsn = 'postgres://pythonistabot:pythonistabot@database:5432/pythonistabot' # assumed default

launcher.py

@@ -40,7 +40,8 @@ async def main() -> None:
         bot.pool = pool
         bot.log_handler = handler
 
-        bot.mb_client = mystbin.Client(token=core.CONFIG["TOKENS"]["mystbin"], session=session)
+        _mystbin_token = core.CONFIG["TOKENS"].get("mystbin")
+        bot.mb_client = mystbin.Client(token=_mystbin_token, session=session)
 
         await bot.load_extension("jishaku")
         for extension in EXTENSIONS:

modules/api.py

@@ -45,8 +45,9 @@
 
 
 class API(core.Cog):
-    def __init__(self, bot: core.Bot) -> None:
+    def __init__(self, bot: core.Bot, *, pythonista_api_key: str) -> None:
         self.bot = bot
+        self._auth: str = pythonista_api_key
 
         self.session: aiohttp.ClientSession | None = None
         self.backoff: ExponentialBackoff[bool] = ExponentialBackoff()
@@ -57,7 +58,7 @@ def __init__(self, bot: core.Bot) -> None:
 
     @property
     def headers(self) -> dict[str, Any]:
-        return {"Authorization": core.CONFIG["TOKENS"]["pythonista"]}
+        return {"Authorization": self._auth}
 
     async def cog_load(self) -> None:
         self.session = aiohttp.ClientSession(headers=self.headers)
@@ -170,4 +171,9 @@ async def keep_alive(self) -> None:
 
 
 async def setup(bot: core.Bot) -> None:
-    await bot.add_cog(API(bot))
+    pythonista_api_key = core.CONFIG["TOKENS"].get("pythonista")
+    if not pythonista_api_key:
+        LOGGER.warning("Not enabling %r due to missing config key.", __file__)
+        return
+
+    await bot.add_cog(API(bot, pythonista_api_key=pythonista_api_key))

modules/manuals.py

@@ -59,8 +59,9 @@ class Manuals(commands.Cog):
 
     target = yarl.URL("https://idevision.net/api/public/")
 
-    def __init__(self, bot: core.Bot) -> None:
+    def __init__(self, bot: core.Bot, *, idevision_auth: str | None) -> None:
         self.bot = bot
+        self._idevision_auth: str | None = idevision_auth
 
     @staticmethod
     def _cooldown_bucket(ctx: core.Context) -> commands.Cooldown | None:
@@ -176,8 +177,9 @@ async def rtfm(self, ctx: core.Context, *, query: str) -> None:
 
         headers = {
             "User-Agent": f"PythonistaBot discord bot (via {ctx.author})",
-            "Authorization": core.CONFIG["TOKENS"]["idevision"],
         }
+        if self._idevision_auth:
+            headers["Authorization"] = self._idevision_auth
 
         async with self.bot.session.get(url, headers=headers) as resp:
             if resp.status != 200:
@@ -269,8 +271,9 @@ async def rtfs(self, ctx: core.Context, *, query: str) -> None:
 
         headers = {
             "User-Agent": f"PythonistaBot discord bot (via {ctx.author})",
-            "Authorization": core.CONFIG["TOKENS"]["idevision"],
         }
+        if self._idevision_auth:
+            headers["Authorization"] = self._idevision_auth
 
         async with self.bot.session.get(url, headers=headers) as resp:
             if resp.status != 200:
@@ -306,4 +309,5 @@ async def rtfs(self, ctx: core.Context, *, query: str) -> None:
 
 
 async def setup(bot: core.Bot) -> None:
-    await bot.add_cog(Manuals(bot))
+    idevision_auth_key = core.CONFIG["TOKENS"].get("idevision")
+    await bot.add_cog(Manuals(bot, idevision_auth=idevision_auth_key))

types_/config.py

@@ -1,11 +1,11 @@
-from typing import NotRequired, TypedDict
+from typing import NotRequired, Required, TypedDict
 
 
 __all__ = ("Config",)
 
 
-class Tokens(TypedDict):
-    bot: str
+class Tokens(TypedDict, total=False):
+    bot: Required[str]
     idevision: str
     mystbin: str
     github_bot: str