Merge pull request #1 from diverpet/dev

v0.1.0

Author: diverpet

bot/akagiot2/bot_akagiot2.py

@@ -0,0 +1,82 @@
+import multiprocessing
+
+from bot.bot import BotMjai, GameMode
+from common.log_helper import LOGGER
+from pathlib import Path
+
+from common.utils import BotNotSupportingMode, Ot2BotCreationError
+
+model_file_path = "mjai/bot_3p/model.pth"
+
+
+class BotAkagiOt2(BotMjai):
+    """ Bot implementation for Akagi OT2 model """
+
+    def __init__(self) -> None:
+        super().__init__("Akagi OT2 Bot")
+        self._supported_modes: list[GameMode] = []
+        self._check()
+
+    def _check(self):
+        # check model file
+        if not Path(model_file_path).exists() or not Path(model_file_path).is_file():
+            LOGGER.warning("Cannot find model file for Akagi OT2 model:%s", model_file_path)
+        if try_create_ot2_bot():
+            self._supported_modes.append(GameMode.MJ3P)
+        else:
+            LOGGER.warning("Cannot create bot for OT2 model.", exc_info=True)
+            LOGGER.warning("Could be missing file: %s", model_file_path)
+            raise Ot2BotCreationError("Failed to create bot instance for Akagi OT2 model.")
+        pass
+
+    @property
+    def supported_modes(self) -> list[GameMode]:
+        """ return supported game modes"""
+        return self._supported_modes
+
+    # 覆写父类方法
+    def _init_bot_impl(self, mode: GameMode = GameMode.MJ3P):
+        if mode == GameMode.MJ3P:
+            try:
+                import riichi3p
+                self.mjai_bot = riichi3p.online.Bot(self.seat)
+            except Exception as e:
+                LOGGER.warning("Cannot create bot for Akagi OT2 model: %s", e, exc_info=True)
+                LOGGER.warning("Could be missing model.pth file in path mjai/bot_3p")
+                raise Ot2BotCreationError("Failed to create bot instance for Akagi OT2 model.")
+        else:
+            raise BotNotSupportingMode(mode)
+
+
+# 尝试获取mjai.bot实例，该方法可能会导致 panick，需要在分离进程中使用
+def create_bot_instance(queue):
+    import riichi3p
+    try:
+        # 尝试创建一个mjai.bot实例
+        riichi3p.online.Bot(1)
+        queue.put(True)  # 将成功的标志放入队列
+    except Exception as e:
+        LOGGER.warning("Cannot create bot: %s", e, exc_info=True)
+        LOGGER.warning("Could be missing model.pth file in path ./mjai/bot_3p")
+        queue.put(False)  # 将失败的标志放入队列
+
+
+# 使用分离进程尝试创建bot实例
+def try_create_ot2_bot():
+    queue = multiprocessing.Queue()
+    process = multiprocessing.Process(target=create_bot_instance, args=(queue,))
+    process.start()
+
+    # 尝试从队列中获取结果，设置超时时间防止无限等待
+    try:
+        success = queue.get(timeout=3)
+    except Exception as e:
+        LOGGER.error("Failed to retrieve the result from the subprocess: %s", e)
+        success = False
+
+    process.join()
+
+    if not success or process.exitcode != 0:
+        LOGGER.error("Failed to create bot or detected a crash in the subprocess with exit code %s", process.exitcode)
+        return False
+    return True

bot/factory.py

@@ -5,30 +5,27 @@
 from .local.bot_local import BotMortalLocal
 from .mjapi.bot_mjapi import BotMjapi
 from .akagiot.bot_akagiot import BotAkagiOt
+from .akagiot2.bot_akagiot2 import BotAkagiOt2
 
 
-MODEL_TYPE_STRINGS = ["Local", "AkagiOT", "MJAPI"]
+MODEL_TYPE_STRINGS = ["Local", "AkagiOT", "MJAPI", "AkagiOT2"]
 OT2_MODEL_PATH = "./mjai/bot_3p/model.pth"
 
 
 def get_bot(settings:Settings) -> Bot:
     """ create the Bot instance based on settings"""
 
     match settings.model_type:
-        case "Local":
-            if settings.enable_ot2_for_3p:
-                model_files:dict = {
-                    GameMode.MJ4P: sub_file(Folder.MODEL, settings.model_file),
-                    GameMode.MJ3P: OT2_MODEL_PATH
-                }
-            else:
-                model_files:dict = {
-                    GameMode.MJ4P: sub_file(Folder.MODEL, settings.model_file),
-                    GameMode.MJ3P: sub_file(Folder.MODEL, settings.model_file_3p)
-                }
+        case "Local":   
+            model_files:dict = {
+                GameMode.MJ4P: sub_file(Folder.MODEL, settings.model_file),
+                GameMode.MJ3P: sub_file(Folder.MODEL, settings.model_file_3p)
+            }
             bot = BotMortalLocal(model_files)
         case "AkagiOT":
             bot = BotAkagiOt(settings.akagi_ot_url, settings.akagi_ot_apikey)
+        case "AkagiOT2":
+            bot = BotAkagiOt2()
         case "MJAPI":
             bot = BotMjapi(settings)
         case _:

bot/local/bot_local.py

@@ -7,40 +7,6 @@
 from common.log_helper import LOGGER
 from bot.local.engine import get_engine
 from bot.bot import BotMjai, GameMode
-from common.settings import Settings
-import multiprocessing
-
-# 尝试获取mjai.bot实例，该方法可能会导致 panick，需要在分离进程中使用
-def create_bot_instance(queue):
-    import riichi3p
-    try:
-        # 尝试创建一个mjai.bot实例
-        riichi3p.online.Bot(1)
-        queue.put(True)  # 将成功的标志放入队列
-    except Exception as e:
-        LOGGER.warning("Cannot create bot: %s", e, exc_info=True)
-        LOGGER.warning("Could be missing model.pth file in path ./mjai/bot_3p")
-        queue.put(False)  # 将失败的标志放入队列
-
-# 使用分离进程尝试创建bot实例
-def try_create_ot2_bot():
-    queue = multiprocessing.Queue()
-    process = multiprocessing.Process(target=create_bot_instance, args=(queue,))
-    process.start()
-
-    # 尝试从队列中获取结果，设置超时时间防止无限等待
-    try:
-        success = queue.get(timeout=3)
-    except Exception as e:
-        LOGGER.error("Failed to retrieve the result from the subprocess: %s", e)
-        success = False
-
-    process.join()
-
-    if not success or process.exitcode != 0:
-        LOGGER.error("Failed to create bot or detected a crash in the subprocess with exit code %s", process.exitcode)
-        return False
-    return True
 
 
 class BotMortalLocal(BotMjai):
@@ -64,28 +30,13 @@ def __init__(self, model_files:dict[GameMode, str]) -> None:
                     except Exception as e:
                         LOGGER.warning("Cannot create engine for mode %s: %s", k, e, exc_info=True)
                 elif k == GameMode.MJ3P:
-                    settings = Settings()
-                    if settings.enable_ot2_for_3p:
-                        import riichi3p
-                        try :
-                            # 用分离进程尝试创建一个mjai.bot实例
-                            if try_create_ot2_bot():
-                                self._engines[k] = "./mjai/bot_3p/model.pth"
-                            else:
-                                LOGGER.warning("Cannot create bot for OT2 model %s.", k, exc_info=True)
-                                LOGGER.warning("Could be missing model.pth file in path ./mjai/bot_3p")
-                        except Exception as e:
-                            LOGGER.warning("Cannot create bot for OT2 model %s: %s", k, e, exc_info=True)
-                            LOGGER.warning("Could be missing model.pth file in path ./mjai/bot_3p")
-                        pass
-                    else:
-                        # test import libraries for 3p
-                        try:
-                            import libriichi3p
-                            from bot.local.engine3p import get_engine as get_engine_3p
-                            self._engines[k] = get_engine_3p(self.model_files[k])
-                        except Exception as e: # pylint: disable=broad-except
-                            LOGGER.warning("Cannot create engine for mode %s: %s", k, e, exc_info=True)
+                    # test import libraries for 3p
+                    try:
+                        import libriichi3p
+                        from bot.local.engine3p import get_engine as get_engine_3p
+                        self._engines[k] = get_engine_3p(self.model_files[k])
+                    except Exception as e: # pylint: disable=broad-except
+                        LOGGER.warning("Cannot create engine for mode %s: %s", k, e, exc_info=True)
         self._supported_modes = list(self._engines.keys())
         if not self._supported_modes:
             raise LocalModelException("No valid model files found")

common/lan_str.py

@@ -50,8 +50,6 @@ class LanStr:
     AI_MODEL_FILE_3P = "Local Model File (3P)"
     AKAGI_OT_URL = "AkagiOT Server URL"
     AKAGI_OT_APIKEY = "AkagiOT API Key"
-    AKAGI_OT2 = "AKAGI OT2"
-    ENABLE_AKAGI_OT2_FOR_3P = "Enable AkagiOT2 for 3P(Only Effective when model type is Local)"
     AKAGI_OT2_URL = "AkagiOT2 Server URL"
     AKAGI_OT2_APIKEY = "AkagiOT2 API Key"
     MJAPI_URL = "MJAPI Server URL"
@@ -93,6 +91,7 @@ class LanStr:
     GAME_NOT_RUNNING = "Not Launched"
     # errors
     LOCAL_MODEL_ERROR = "Local Model Loading Error!"
+    OT2_MODEL_ERROR = "OT2 Model Loading Error!"
     MITM_SERVER_ERROR = "MITM Service Error!"
     MITM_CERT_NOT_INSTALLED = "Run as admin or manually install MITM cert."
     MAIN_THREAD_ERROR = "Main Thread Error!"
@@ -187,8 +186,6 @@ class LanStrZHS(LanStr):
     AI_MODEL_FILE_3P = "本地模型文件(三麻)"
     AKAGI_OT_URL = "AkagiOT 服务器地址"
     AKAGI_OT_APIKEY = "AkagiOT API Key"
-    AKAGI_OT2 = "AKAGI OT2"
-    ENABLE_AKAGI_OT2_FOR_3P = "三麻中启用 AkagiOT2(仅在选择 Local 模型时生效)"
     AKAGI_OT2_URL = "AkagiOT2 服务器地址"
     AKAGI_OT2_APIKEY = "AkagiOT2 API Key"
     MJAPI_URL = "MJAPI 服务器地址"
@@ -232,6 +229,7 @@ class LanStrZHS(LanStr):
     GAME_NOT_RUNNING = "未启动"
     #error
     LOCAL_MODEL_ERROR = "本地模型加载错误!"
+    OT2_MODEL_ERROR = "OT2 模型加载错误!"
     MITM_CERT_NOT_INSTALLED = "以管理员运行或手动安装 MITM 证书"
     MITM_SERVER_ERROR = "MITM 服务错误!"
     MAIN_THREAD_ERROR = "主进程发生错误!"

common/settings.py

@@ -34,15 +34,14 @@ def __init__(self, json_file:str=DEFAULT_SETTING_FILE) -> None:
 
         # AI Model settings
         self.model_type:str = self._get_value("model_type", "Local")
-        """ model type: local, mjapi"""
+        """ model type: local, mjapi, AkagiOT, AkagiOT2"""
         # for local model
         self.model_file:str = self._get_value("model_file", "mortal.pth")
         self.model_file_3p:str = self._get_value("model_file_3p", "mortal_3p.pth")
         # akagi ot model
         self.akagi_ot_url:str = self._get_value("akagi_ot_url", "")
         self.akagi_ot_apikey:str = self._get_value("akagi_ot_apikey", "")
         # akagi ot2 3p model
-        self.enable_ot2_for_3p:bool = self._get_value("enable_ot2_for_3p", False, self.valid_bool)
         self.akagi_ot2_url:str = self._get_value("akagi_ot2_url", "")
         self.akagi_ot2_apikey: str = self._get_value("akagi_ot2_apikey", "")
         # for mjapi

common/utils.py

@@ -64,10 +64,13 @@ class UiState(Enum):
     GAME_ENDING = 20
 
 
-# === Exceptions ===    
+# === Exceptions ===
 class LocalModelException(Exception):
     """ Exception for model file error"""
 
+class Ot2BotCreationError(Exception):
+    """ Exception for OT2 bot creation error"""
+
 class MITMException(Exception):
     """ Exception for MITM error"""
 
@@ -84,6 +87,8 @@ def error_to_str(error:Exception, lan:LanStr) -> str:
     """ Convert error to language specific string"""
     if isinstance(error, LocalModelException):
         return lan.LOCAL_MODEL_ERROR
+    elif isinstance(error, Ot2BotCreationError):
+        return lan.OT2_MODEL_ERROR
     elif isinstance(error, MitmCertNotInstalled):
         return lan.MITM_CERT_NOT_INSTALLED + f"{error.args}"    
     elif isinstance(error, MITMException):

gui/settings_window.py

@@ -153,14 +153,6 @@ def create_widgets(self):
         string_entry = ttk.Entry(main_frame, textvariable=self.akagiot_apikey_var, width=std_wid*4)
         string_entry.grid(row=cur_row, column=1,columnspan=3,  **args_entry)
 
-        # Enable Akagi OT2
-        cur_row += 1
-        _label = ttk.Label(main_frame, text=self.st.lan().AKAGI_OT2)
-        _label.grid(row=cur_row, column=0, **args_label)
-        self.enable_ot2_for_3p_var = tk.BooleanVar(value=self.st.enable_ot2_for_3p)
-        enable_akagi_ot2_entry = ttk.Checkbutton(
-            main_frame, variable=self.enable_ot2_for_3p_var, text=self.st.lan().ENABLE_AKAGI_OT2_FOR_3P, width=std_wid*3)
-        enable_akagi_ot2_entry.grid(row=cur_row, column=1, **args_entry)
         # Akagi OT2 url
         cur_row += 1
         _label = ttk.Label(main_frame, text=self.st.lan().AKAGI_OT2_URL)
@@ -315,7 +307,6 @@ def _on_save(self):
         mode_file_3p_new = self.model_file_3p_var.get()
         akagi_url_new = self.akagiot_url_var.get()
         akagi_apikey_new = self.akagiot_apikey_var.get()
-        enable_ot2_for_3p_new = self.enable_ot2_for_3p_var.get()
         akagi_url2_new = self.akagiot2_url_var.get()
         akagi_apikey2_new = self.akagiot2_apikey_var.get()
         mjapi_url_new = self.mjapi_url_var.get()
@@ -328,7 +319,6 @@ def _on_save(self):
             self.st.model_file_3p != mode_file_3p_new or
             self.st.akagi_ot_url != akagi_url_new or
             self.st.akagi_ot_apikey != akagi_apikey_new or
-            self.st.enable_ot2_for_3p != enable_ot2_for_3p_new or
             self.st.akagi_ot2_url != akagi_url2_new or
             self.st.akagi_ot2_apikey != akagi_apikey2_new or
             self.st.mjapi_url != mjapi_url_new or
@@ -366,7 +356,6 @@ def _on_save(self):
         self.st.model_file_3p = mode_file_3p_new
         self.st.akagi_ot_url = akagi_url_new
         self.st.akagi_ot_apikey = akagi_apikey_new
-        self.st.enable_ot2_for_3p = enable_ot2_for_3p_new
         self.st.akagi_ot2_url = akagi_url2_new
         self.st.akagi_ot2_apikey = akagi_apikey2_new
         self.st.mjapi_url = mjapi_url_new