added /speaker_info endpoint and SpeakerInfo Types

voicevox-client · tuna2134 · Mar 22, 2023 · Mar 20, 2023 · Mar 20, 2023 · Mar 21, 2023
commit b1fe7a04f116313b520e3efd461e195278ed5fbf
diff --git a/voicevox/client.py b/voicevox/client.py
@@ -8,7 +8,7 @@
 from .audio_query import AudioQuery
 from .http import HttpClient
 from .speakers import Speaker
-
+from .speaker_info import SpeakerInfo
 
 logger = logging.getLogger(__name__)
 
@@ -128,6 +128,27 @@ async def fetch_speakers(
         """
         speakers = await self.http.get_speakers(core_version)
         return [Speaker(speaker) for speaker in speakers]
+
+    async def fetch_speaker_info(
+        self, speaker_uuid: str, core_version: Optional[str] = None
+    ) -> SpeakerInfo:
+        """Fetch speaker's info by given uuid.
+
+        Returns
+        -------
+        SpeakerInfo
+            policy: str
+            portrait: str
+            style_infos: [
+            {
+                id: int
+                icon: str
+                portrait: str
+                voice_samples: List[str]
+            }...
+            ]
+        """
+        return SpeakerInfo(await self.http.get_speaker_info(speaker_uuid, core_version)) 
 
     async def multi_synthesis(
         self, audio_queries: List[AudioQuery], speaker: int,

diff --git a/voicevox/http.py b/voicevox/http.py
@@ -6,8 +6,10 @@
 
 from httpx import AsyncClient
 
+
 from .errors import NotfoundError, HttpException
 from .types import AudioQueryType, SpeakerType
+from .types.speaker_info import SpeakerInfoType 
 
 
 logger = logging.getLogger(__name__)
@@ -79,6 +81,16 @@ async def get_speakers(
             params["core_version"] = core_version
         return await self.request("GET", "/speakers", params=params)
 
+    async def get_speaker_info(
+        self, speaker_uuid: str, core_version: Optional[str]
+    ) -> SpeakerInfoType:
+        params = {
+            "speaker_uuid": speaker_uuid 
+        }
+        if core_version is not None:
+            params["core_version"] = core_version
+        return await self.request("GET", "/speaker_info", params=params)
+
     async def initialize_speaker(self, params: dict) -> None:
         await self.request("POST", "/initialize_speaker", params=params)
 

diff --git a/voicevox/speaker_info.py b/voicevox/speaker_info.py
@@ -0,0 +1,56 @@
+# voicevox - speaker_info
+
+from typing import List
+
+from .types.speaker_info import SpeakerInfoType, StyleInfoType
+
+class StyleInfo:
+    """Return style info
+
+    Attributes
+    ----------
+    id: int
+        style id
+    icon: str
+        base64 encoded icon
+    portrait: str
+        base64 encoded portrait image
+    voice_samples: list[str]
+        raw voice_data ???
+    """
+
+    def __init__(self, payload: StyleInfoType):
+        self.__data = payload
+
+    @property
+    def id(self) -> int:
+        return self.__data["id"]
+    @property
+    def icon(self) -> str:
+        return self.__data["icon"]
+    @property
+    def portrait(self) -> str:
+        return self.__data["portrait"]
+    @property
+    def voice_samples(self) -> list[str]:
+        return self.__data["voice_samples"]
+
+class SpeakerInfo:
+    """Return speaker info
+
+    Attributes
+    ----------
+    policy: str
+        policy
+    portrait: str
+        base64 encoded portrait image
+    style_infos: list[StyleInfo]
+        list of Style informations
+    """
+
+    def __init__(self, payload: SpeakerInfoType):
+        self.policy: str = payload["policy"]
+        self.portrait: str = payload["portrait"]
+        self.style_infos: List[StyleInfo] = [
+            StyleInfo(style_info) for style_info in payload["style_infos"]
+        ]
diff --git a/voicevox/types/speaker_info.py b/voicevox/types/speaker_info.py
@@ -0,0 +1,16 @@
+# voicevox - types/speaker_info
+
+from typing import TypedDict, List
+
+
+class StyleInfoType(TypedDict):
+    id: int
+    icon: str
+    portrait: str
+    voice_samples: List[str]
+
+
+class SpeakerInfoType(TypedDict):
+    policy: str
+    portrait: str
+    style_infos: List[StyleInfoType]