整理: 設定にモデルモジュールを追加 (#1345)

refactor: 設定にモデルモジュールを追加

build_util/make_docs.py

@@ -8,7 +8,7 @@
 from voicevox_engine.dev.tts_engine.mock import MockTTSEngine
 from voicevox_engine.engine_manifest import load_manifest
 from voicevox_engine.preset.Preset import PresetManager
-from voicevox_engine.setting.Setting import USER_SETTING_PATH, SettingHandler
+from voicevox_engine.setting.setting_manager import USER_SETTING_PATH, SettingHandler
 from voicevox_engine.tts_pipeline.tts_engine import TTSEngineManager
 from voicevox_engine.user_dict.user_dict_manager import UserDictionary
 from voicevox_engine.utility.path_utility import engine_manifest_path, engine_root

run.py

@@ -16,11 +16,8 @@
 from voicevox_engine.core.core_initializer import initialize_cores
 from voicevox_engine.engine_manifest import load_manifest
 from voicevox_engine.preset.Preset import PresetManager
-from voicevox_engine.setting.Setting import (
-    USER_SETTING_PATH,
-    CorsPolicyMode,
-    SettingHandler,
-)
+from voicevox_engine.setting.model import CorsPolicyMode
+from voicevox_engine.setting.setting_manager import USER_SETTING_PATH, SettingHandler
 from voicevox_engine.tts_pipeline.tts_engine import make_tts_engines_from_cores
 from voicevox_engine.user_dict.user_dict_manager import UserDictionary
 from voicevox_engine.utility.path_utility import engine_manifest_path, engine_root

test/benchmark/engine_preparation.py

@@ -11,7 +11,7 @@
 from voicevox_engine.core.core_initializer import initialize_cores
 from voicevox_engine.engine_manifest import load_manifest
 from voicevox_engine.preset.PresetManager import PresetManager
-from voicevox_engine.setting.Setting import SettingHandler
+from voicevox_engine.setting.setting_manager import SettingHandler
 from voicevox_engine.tts_pipeline.tts_engine import make_tts_engines_from_cores
 from voicevox_engine.user_dict.user_dict import UserDictionary
 from voicevox_engine.utility.core_version_utility import get_latest_version

test/e2e/conftest.py

@@ -11,7 +11,7 @@
 from voicevox_engine.core.core_initializer import initialize_cores
 from voicevox_engine.engine_manifest import load_manifest
 from voicevox_engine.preset.Preset import PresetManager
-from voicevox_engine.setting.Setting import SettingHandler
+from voicevox_engine.setting.setting_manager import SettingHandler
 from voicevox_engine.tts_pipeline.tts_engine import make_tts_engines_from_cores
 from voicevox_engine.user_dict.user_dict_manager import (
     DEFAULT_DICT_PATH,

test/setting/test_setting.py

@@ -3,7 +3,8 @@
 import pytest
 from pydantic import ValidationError
 
-from voicevox_engine.setting.Setting import CorsPolicyMode, Setting, SettingHandler
+from voicevox_engine.setting.model import CorsPolicyMode
+from voicevox_engine.setting.setting_manager import Setting, SettingHandler
 
 
 def test_setting_handler_load_not_exist_file() -> None:

voicevox_engine/app/application.py

@@ -22,7 +22,8 @@
 from voicevox_engine.library.library_manager import LibraryManager
 from voicevox_engine.metas.MetasStore import MetasStore
 from voicevox_engine.preset.Preset import PresetManager
-from voicevox_engine.setting.Setting import CorsPolicyMode, SettingHandler
+from voicevox_engine.setting.model import CorsPolicyMode
+from voicevox_engine.setting.setting_manager import SettingHandler
 from voicevox_engine.tts_pipeline.tts_engine import TTSEngineManager
 from voicevox_engine.user_dict.user_dict_manager import UserDictionary
 from voicevox_engine.utility.path_utility import engine_root, get_save_dir

voicevox_engine/app/middlewares.py

@@ -9,7 +9,7 @@
 from fastapi.responses import JSONResponse
 from starlette.middleware.errors import ServerErrorMiddleware
 
-from voicevox_engine.setting.Setting import CorsPolicyMode
+from voicevox_engine.setting.model import CorsPolicyMode
 
 
 def configure_middlewares(

voicevox_engine/app/routers/setting.py

@@ -6,7 +6,8 @@
 from fastapi.templating import Jinja2Templates
 
 from voicevox_engine.engine_manifest import BrandName
-from voicevox_engine.setting.Setting import CorsPolicyMode, Setting, SettingHandler
+from voicevox_engine.setting.model import CorsPolicyMode
+from voicevox_engine.setting.setting_manager import Setting, SettingHandler
 from voicevox_engine.utility.path_utility import resource_root
 
 from ..dependencies import check_disabled_mutable_api

voicevox_engine/setting/model.py

@@ -0,0 +1,15 @@
+"""
+エンジン設定機能に関して API と ENGINE 内部実装が共有するモデル
+「API と ENGINE 内部実装が共有するモデル」については `voicevox_engine/model.py` の module docstring を確認すること。
+"""
+
+from enum import Enum
+
+
+class CorsPolicyMode(str, Enum):
+    """
+    CORSの許可モード
+    """
+
+    all = "all"  # 全てのオリジンからのリクエストを許可
+    localapps = "localapps"  # ローカルアプリケーションからのリクエストを許可

voicevox_engine/setting/Setting.py → voicevox_engine/setting/setting_manager.py

@@ -5,15 +5,7 @@
 from pydantic import BaseModel, Field
 
 from ..utility.path_utility import get_save_dir
-
-
-class CorsPolicyMode(str, Enum):
-    """
-    CORSの許可モード
-    """
-
-    all = "all"  # 全てのオリジンからのリクエストを許可
-    localapps = "localapps"  # ローカルアプリケーションからのリクエストを許可
+from .model import CorsPolicyMode
 
 
 class Setting(BaseModel):