Refactor (#113)

* refactor text.py

* black & isort

* no_implicit_optional fix

* mypy fixes

* fix logging mess

* fix tests

* update tests workflow

* fix workflow

Author: dborodin836

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [master, main]
+    branches: [master, main, v2]
   pull_request:
-    branches: [master, main]
+    branches: [master, main, v2]
   schedule:
     - cron: '0 0 * * 1'
 
@@ -13,11 +13,17 @@ jobs:
     name: Pytest
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        include:
+          - os: windows-latest
+          - os: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
@@ -37,10 +43,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
@@ -50,20 +56,20 @@ jobs:
           pip install -r requirements.txt
 
       - name: Run isort check
-        run: isort .
+        run: python -m isort --check-only .
 
       - name: Run black check
-        run: black .
+        run: python -m black --check .
 
   mypy:
     name: mypy
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
@@ -72,5 +78,5 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements.txt
 
-      - name: Run mypy
-        run: mypy .
+      - name: Run mypy check
+        run: python -m isort --check-only .

main.py

@@ -9,19 +9,17 @@
 
 from config import config
 from modules.bot_state import state_manager
-from modules.setup import parse_console_logs_and_build_conversation_history
 from modules.commands.gui.openai import gpt3_cmd_handler
 from modules.gui.log_window import (
     CopyStdoutToSocket,
     LogWindow,
     RedirectStdoutToLogWindow,
 )
 from modules.lobby_manager import lobby_manager
-from modules.logs import get_logger, setup_loggers
+from modules.logs import gui_logger, setup_loggers
 from modules.message_queueing import message_queue_handler
 from modules.server import app
-
-gui_logger = get_logger("gui")
+from modules.setup import parse_console_logs_and_build_conversation_history
 
 
 def keyboard_on_press(key):

modules/api/github.py

@@ -3,13 +3,10 @@
 import requests
 
 from config import config
-from modules.logs import get_logger
+from modules.logs import gui_logger, main_logger
 
 GITHUB_API_REPO_LINK = "https://api.github.com/repos/dborodin836/TF2-GPTChatBot/releases/latest"
 
-main_logger = get_logger("main")
-gui_logger = get_logger("gui")
-
 
 def check_for_updates() -> None:
     """

modules/api/llm/openai.py

@@ -5,10 +5,7 @@
 
 from config import config
 from modules.api.llm.base import LLMProvider
-from modules.logs import get_logger
-
-main_logger = get_logger("main")
-gui_logger = get_logger("gui")
+from modules.logs import gui_logger, main_logger
 
 
 class OpenAILLMProvider(LLMProvider):
@@ -62,7 +59,7 @@ def get_tts(message: str, settings: dict):
         model=settings.get("model", "tts-1"),
         voice=settings.get("voice", "alloy"),
         input=message,
-        speed=settings.get("speed", NotGiven())
+        speed=settings.get("speed", NotGiven()),
     )
 
     return response

modules/api/llm/textgen_webui.py

@@ -2,10 +2,7 @@
 
 from config import config
 from modules.api.llm.base import LLMProvider
-from modules.logs import get_logger
-
-main_logger = get_logger("main")
-combo_logger = get_logger("combo")
+from modules.logs import combo_logger, main_logger
 
 
 class TextGenerationWebUILLMProvider(LLMProvider):

modules/bans.py

@@ -3,13 +3,9 @@
 from json import JSONDecodeError
 from typing import Optional, Set
 
-from modules.logs import get_logger, log_gui_general_message
+from modules.logs import combo_logger, log_gui_general_message, main_logger
 from modules.typing import Player
 
-main_logger = get_logger("main")
-gui_logger = get_logger("gui")
-combo_logger = get_logger("combo")
-
 
 class BansManager:
     def __init__(self, bans_file: Optional[str] = None):

modules/bot_state.py

@@ -1,7 +1,4 @@
-from modules.logs import get_logger, log_gui_general_message
-
-main_logger = get_logger("main")
-gui_logger = get_logger("gui")
+from modules.logs import log_gui_general_message, main_logger
 
 
 class StateManager:

modules/builder/loaders.py

@@ -1,28 +1,29 @@
 from abc import ABC
-from typing import Dict
+from typing import Callable, Dict
 
 from modules.api.llm.groq import GroqCloudLLMProvider
 from modules.api.llm.openai import OpenAILLMProvider
 from modules.api.llm.textgen_webui import TextGenerationWebUILLMProvider
-from modules.commands.tts import TTSCommand
-from modules.commands.rcon import RconCommand
-from modules.commands.llm import CommandGlobalChatLLMChatCommand, CommandPrivateChatLLMChatCommand, \
-    ConfirmableQuickQueryLLMCommand, QuickQueryLLMCommand
 from modules.commands.decorators import (
     admin_only,
+    blacklist_factory,
     deny_empty_prompt,
     disabled,
     empty_prompt_message_response,
     openai_moderated,
     whitelist_factory,
-    blacklist_factory
 )
-from modules.logs import get_logger
+from modules.commands.llm import (
+    CommandGlobalChatLLMChatCommand,
+    CommandPrivateChatLLMChatCommand,
+    ConfirmableQuickQueryLLMCommand,
+    QuickQueryLLMCommand,
+)
+from modules.commands.rcon import RconCommand
+from modules.commands.tts import TTSCommand
+from modules.logs import gui_logger
 from modules.typing import CommandSchemaDefinition
 
-main_logger = get_logger("main")
-gui_logger = get_logger("gui")
-
 LLM_COMMAND_SETTINGS = {
     "prompt-file",
     "enable-soft-limit",
@@ -39,14 +40,14 @@
 }
 
 # Traits
-WRAPPERS = {
+WRAPPERS: Dict[str, Callable] = {
     "openai-moderated": openai_moderated,
     "admin-only": admin_only,
     "empty-prompt-message-response": empty_prompt_message_response,
     "disabled": disabled,
     "deny-empty-prompt": deny_empty_prompt,
     "whitelist": whitelist_factory,
-    "blacklist": blacklist_factory
+    "blacklist": blacklist_factory,
 }
 
 LLM_PROVIDERS = {
@@ -62,7 +63,7 @@ class InvalidCommandException(Exception): ...
 class Loader(ABC):
     def __init__(self, raw_data: dict) -> None:
         self.raw_command_data = raw_data
-        self.command_data = {}
+        self.command_data: Dict = {}
 
     def get_data(self) -> dict:
         self.__load_settings()
@@ -145,17 +146,13 @@ def __load_rcon_command(self):
         klass=RconCommand, loader=RCONCommandLoader, settings={"wait-ms"}
     ),
     "openai-tts": CommandSchemaDefinition(
-        klass=TTSCommand, loader=Loader, settings={
-            "model",
-            "voice",
-            "speed",
-            "volume",
-            "output_device"
-        }
+        klass=TTSCommand,
+        loader=Loader,
+        settings={"model", "voice", "speed", "volume", "output_device"},
     ),
-    'confirmable-quick-query': CommandSchemaDefinition(
+    "confirmable-quick-query": CommandSchemaDefinition(
         klass=ConfirmableQuickQueryLLMCommand,
         loader=LLMCommandLoader,
-        settings=LLM_COMMAND_SETTINGS
-    )
+        settings=LLM_COMMAND_SETTINGS,
+    ),
 }

modules/builder/utils.py

@@ -7,10 +7,7 @@
 from modules.builder.loaders import COMMAND_TYPES, WRAPPERS, InvalidCommandException
 from modules.command_controllers import CommandController
 from modules.commands.base import BaseCommand
-from modules.logs import get_logger
-
-main_logger = get_logger("main")
-gui_logger = get_logger("gui")
+from modules.logs import gui_logger, main_logger
 
 
 def get_commands_from_yaml() -> List[dict]:
@@ -21,7 +18,10 @@ def get_commands_from_yaml() -> List[dict]:
 
 
 def load_command_specific_attrs(type_: str, raw_data: dict) -> Dict:
-    loader = COMMAND_TYPES.get(type_).loader
+    command_def = COMMAND_TYPES.get(type_)
+    if command_def is None:
+        raise InvalidCommandException(f"Command type {type_} not supported")
+    loader = command_def.loader
     loader_instance = loader(raw_data)
     return loader_instance.get_data()
 
@@ -45,20 +45,19 @@ def create_command_from_dict(cmd: dict) -> BaseCommand:
     if traits := cmd.get("traits"):
         wrappers = []
         for wrapper in traits:
-            wrapper: dict
             try:
                 wrapper_id = wrapper["__id"]
                 wrapper.pop("__id")
                 if len(list(wrapper.keys())) > 0:
                     factory = WRAPPERS[wrapper_id]
-                    wrappers.append(factory(**wrapper))
+                    wrappers.append(factory(**wrapper))  # type: ignore
                 else:
                     wrappers.append(WRAPPERS[wrapper_id])
             except Exception as e:
                 gui_logger.warning(f"{e} is not a valid trait.")
         command_dict.update(wrappers=wrappers)
 
-    return type(class_name, (type_,), command_dict)
+    return type(class_name, (type_,), command_dict)  # type: ignore
 
 
 def load_commands(controller: CommandController) -> None: