整理: Speaker と内部型の分離 (#1202)

* refactor: `CoreSpeaker` と `Speaker` を分離

* refactor: `CoreSpeaker` と `SpeakerStyle` を分離

* fix: lint

* refactor: `EngineSpeaker` と `Speaker` の分離

* refactor: プライベートクラスの名称をプライベート化

* refactor: `Speaker` 属性順序を変更

* fix: NewType 型への代入時にラップ

* fix: lint

* refactor: 外部に露出しない詳細情報を削除

* fix: lint

test/test_metas_store.py

@@ -1,7 +1,7 @@
 import uuid
 from unittest import TestCase
 
-from voicevox_engine.metas.Metas import Speaker, SpeakerStyle, StyleType
+from voicevox_engine.metas.Metas import Speaker, SpeakerStyle, StyleId, StyleType
 from voicevox_engine.metas.MetasStore import filter_speakers_and_styles
 
 
@@ -12,7 +12,7 @@ def _gen_speaker(style_types: list[StyleType]) -> Speaker:
         styles=[
             SpeakerStyle(
                 name="",
-                id=0,
+                id=StyleId(0),
                 type=style_type,
             )
             for style_type in style_types

voicevox_engine/metas/Metas.py

@@ -49,35 +49,20 @@ class SpeakerSupportedFeatures(BaseModel):
     )
 
 
-class CoreSpeaker(BaseModel):
+class Speaker(BaseModel):
     """
-    コアに含まれる話者情報
+    話者情報
     """
 
     name: str = Field(title="名前")
     speaker_uuid: str = Field(title="話者のUUID")
     styles: List[SpeakerStyle] = Field(title="スタイルの一覧")
     version: str = Field("話者のバージョン")
-
-
-class EngineSpeaker(BaseModel):
-    """
-    エンジンに含まれる話者情報
-    """
-
     supported_features: SpeakerSupportedFeatures = Field(
         title="話者の対応機能", default_factory=SpeakerSupportedFeatures
     )
 
 
-class Speaker(CoreSpeaker, EngineSpeaker):
-    """
-    話者情報
-    """
-
-    pass
-
-
 class StyleInfo(BaseModel):
     """
     スタイルの追加情報

voicevox_engine/metas/MetasStore.py

@@ -1,13 +1,14 @@
 import json
 from copy import deepcopy
 from pathlib import Path
-from typing import TYPE_CHECKING, Dict, List, Literal, Tuple
+from typing import TYPE_CHECKING, Dict, List, Literal, NewType, Tuple
+
+from pydantic import BaseModel, Field
 
 from voicevox_engine.metas.Metas import (
-    CoreSpeaker,
-    EngineSpeaker,
     Speaker,
     SpeakerStyle,
+    SpeakerSupportedFeatures,
     StyleId,
     StyleType,
 )
@@ -16,6 +17,49 @@
     from voicevox_engine.core.core_adapter import CoreAdapter
 
 
+_CoreStyleId = NewType("_CoreStyleId", int)
+_CoreStyleType = Literal["talk", "singing_teacher", "frame_decode", "sing"]
+
+
+class _CoreSpeakerStyle(BaseModel):
+    """
+    話者のスタイル情報
+    """
+
+    name: str
+    id: _CoreStyleId
+    type: _CoreStyleType | None = Field(default="talk")
+
+
+def cast_styles(cores: list[_CoreSpeakerStyle]) -> list[SpeakerStyle]:
+    """コアから取得したスタイル情報をエンジン形式へキャストする。"""
+    return [
+        SpeakerStyle(name=core.name, id=StyleId(core.id), type=core.type)
+        for core in cores
+    ]
+
+
+class _CoreSpeaker(BaseModel):
+    """
+    コアに含まれる話者情報
+    """
+
+    name: str
+    speaker_uuid: str
+    styles: List[_CoreSpeakerStyle]
+    version: str = Field("話者のバージョン")
+
+
+class _EngineSpeaker(BaseModel):
+    """
+    エンジンに含まれる話者情報
+    """
+
+    supported_features: SpeakerSupportedFeatures = Field(
+        default_factory=SpeakerSupportedFeatures
+    )
+
+
 class MetasStore:
     """
     話者やスタイルのメタ情報を管理する
@@ -29,8 +73,8 @@ def __init__(self, engine_speakers_path: Path) -> None:
             エンジンに含まれる話者メタ情報ディレクトリのパス。
         """
         # エンジンに含まれる各話者のメタ情報
-        self._loaded_metas: Dict[str, EngineSpeaker] = {
-            folder.name: EngineSpeaker(
+        self._loaded_metas: Dict[str, _EngineSpeaker] = {
+            folder.name: _EngineSpeaker(
                 **json.loads((folder / "metas.json").read_text(encoding="utf-8"))
             )
             for folder in engine_speakers_path.iterdir()
@@ -51,12 +95,17 @@ def load_combined_metas(self, core: "CoreAdapter") -> List[Speaker]:
             エンジンとコアに含まれる話者メタ情報
         """
         # コアに含まれる話者メタ情報の収集
-        core_metas = [CoreSpeaker(**speaker) for speaker in json.loads(core.speakers)]
+        core_metas = [_CoreSpeaker(**speaker) for speaker in json.loads(core.speakers)]
         # エンジンに含まれる話者メタ情報との統合
         return [
             Speaker(
-                **self._loaded_metas[speaker_meta.speaker_uuid].dict(),
-                **speaker_meta.dict(),
+                supported_features=self._loaded_metas[
+                    speaker_meta.speaker_uuid
+                ].supported_features,
+                name=speaker_meta.name,
+                speaker_uuid=speaker_meta.speaker_uuid,
+                styles=cast_styles(speaker_meta.styles),
+                version=speaker_meta.version,
             )
             for speaker_meta in core_metas
         ]