Merge pull request #696 from TotallyNotRobots/types

style(cloudbot/config.py): add type annotations for Config object

Author: linuxdaemon

cloudbot/config.py

@@ -4,32 +4,42 @@
 import time
 from collections import OrderedDict
 from pathlib import Path
+from typing import TYPE_CHECKING, Dict, Optional, cast
+
+if TYPE_CHECKING:
+    from cloudbot.bot import AbstractBot
 
 logger = logging.getLogger("cloudbot")
 
 
 class Config(OrderedDict):
-    def __init__(self, bot, *, filename="config.json"):
+    def __init__(
+        self, bot: "AbstractBot", *, filename: str = "config.json"
+    ) -> None:
         super().__init__()
         self.filename = filename
         self.path = Path(self.filename).resolve()
         self.bot = bot
 
-        self._api_keys = {}
+        self._api_keys: Dict[str, Optional[str]] = {}
 
         # populate self with config data
         self.load_config()
 
-    def get_api_key(self, name, default=None):
+    def get_api_key(
+        self, name: str, default: Optional[str] = None
+    ) -> Optional[str]:
         try:
             return self._api_keys[name]
         except LookupError:
-            self._api_keys[name] = value = self.get("api_keys", {}).get(
-                name, default
+            value = cast(
+                Optional[str], self.get("api_keys", {}).get(name, default)
             )
+
+            self._api_keys[name] = value
             return value
 
-    def load_config(self):
+    def load_config(self) -> None:
         """(re)loads the bot config from the config file"""
         self._api_keys.clear()
         if not self.path.exists():
@@ -50,7 +60,7 @@ def load_config(self):
         self.update(data)
         logger.debug("Config loaded from file.")
 
-    def save_config(self):
+    def save_config(self) -> None:
         """saves the contents of the config dict to the config file"""
         with self.path.open("w", encoding="utf-8") as f:
             json.dump(self, f, indent=4)

pyproject.toml

@@ -114,6 +114,12 @@ module = 'cloudbot.*'
 check_untyped_defs = true
 warn_return_any = true
 
+[[tool.mypy.overrides]]
+module = 'cloudbot.config'
+check_untyped_defs = true
+warn_return_any = true
+disallow_untyped_defs = true
+
 [tool.commitizen]
 name = "cz_conventional_commits"
 tag_format = "v$version"