refactor: ruff D102 を適用 (#1620)

Co-authored-by: Hiroshiba <[email protected]>

Author: tarepan

pyproject.toml

@@ -7,7 +7,6 @@ ignore = [
   "E501", # line-too-long
   "D400", # missing-trailing-period。日本語の「。」に対応していないため。
   "D403", # first-word-uncapitalized。日本語とは無関係であるため。日英混合時の挙動に一貫性が無いため。
-  "D102", # NOTE: 段階的に有効化する可能性がある。
 ]
 unfixable = [
   "F401", # unused-import

voicevox_engine/core/core_adapter.py

@@ -61,6 +61,7 @@ def __init__(self, core: CoreWrapper):
 
     @property
     def default_sampling_rate(self) -> int:
+        """デフォルトのサンプリングレート。"""
         return self.core.default_sampling_rate
 
     @property
@@ -119,6 +120,7 @@ def is_initialized_style_id_synthesis(self, style_id: StyleId) -> bool:
     def safe_yukarin_s_forward(
         self, phoneme_list_s: NDArray[np.int64], style_id: StyleId
     ) -> NDArray[np.float32]:
+        """音素列から音素ごとの長さを求める。"""
         # 「指定スタイルを初期化」「mutexによる安全性」「コア仕様に従う無音付加」「系列長・データ型に関するアダプター」を提供する
         self.initialize_style_id_synthesis(style_id, skip_reinit=True)
 
@@ -147,6 +149,7 @@ def safe_yukarin_sa_forward(
         end_accent_phrase_list: NDArray[np.int64],
         style_id: StyleId,
     ) -> NDArray[np.float32]:
+        """モーラごとの音素列とアクセント情報からモーラごとの音高を求める。"""
         # 「指定スタイルを初期化」「mutexによる安全性」「コア仕様に従う無音付加」「系列長・データ型に関するアダプター」を提供する
         self.initialize_style_id_synthesis(style_id, skip_reinit=True)
 
@@ -181,6 +184,7 @@ def safe_decode_forward(
         f0: NDArray[np.float32],
         style_id: StyleId,
     ) -> tuple[NDArray[np.float32], int]:
+        """フレームごとの音素・音高とスタイル ID から波形を求める。"""
         # 「指定スタイルを初期化」「mutexによる安全性」「系列長・データ型に関するアダプター」を提供する
         self.initialize_style_id_synthesis(style_id, skip_reinit=True)
         with self.mutex:
@@ -201,6 +205,7 @@ def safe_predict_sing_consonant_length_forward(
         note_duration: NDArray[np.int64],
         style_id: StyleId,
     ) -> NDArray[np.int64]:
+        """子音列・母音列・ノート長・スタイル ID から音素ごとの長さを求める。"""
         # 「指定スタイルを初期化」「mutexによる安全性」「コア仕様に従う無音付加」「系列長・データ型に関するアダプター」を提供する
         self.initialize_style_id_synthesis(style_id, skip_reinit=True)
 
@@ -221,6 +226,7 @@ def safe_predict_sing_f0_forward(
         note: NDArray[np.int64],
         style_id: StyleId,
     ) -> NDArray[np.float32]:
+        """フレームごとの音素・ノートとスタイル ID からフレームごとの音高を求める。"""
         # 「指定スタイルを初期化」「mutexによる安全性」「コア仕様に従う無音付加」「系列長・データ型に関するアダプター」を提供する
         self.initialize_style_id_synthesis(style_id, skip_reinit=True)
 
@@ -241,6 +247,7 @@ def safe_predict_sing_volume_forward(
         f0: NDArray[np.float32],
         style_id: StyleId,
     ) -> NDArray[np.float32]:
+        """フレームごとの音素・ノート・音高とスタイル ID からフレームごとの音量を求める。"""
         # 「指定スタイルを初期化」「mutexによる安全性」「コア仕様に従う無音付加」「系列長・データ型に関するアダプター」を提供する
         self.initialize_style_id_synthesis(style_id, skip_reinit=True)
 
@@ -262,6 +269,7 @@ def safe_sf_decode_forward(
         volume: NDArray[np.float32],
         style_id: StyleId,
     ) -> tuple[NDArray[np.float32], int]:
+        """フレームごとの音素・音高・音量とスタイル ID から音声波形を求める。"""
         # 「指定スタイルを初期化」「mutexによる安全性」「系列長・データ型に関するアダプター」を提供する
         self.initialize_style_id_synthesis(style_id, skip_reinit=True)
         with self.mutex:

voicevox_engine/core/core_wrapper.py

@@ -582,6 +582,7 @@ def __init__(
         cpu_num_threads: int = 0,
         load_all_models: bool = False,
     ) -> None:
+        """コアを利用可能にする。"""
         self.default_sampling_rate = 24000
 
         self.core = load_core(core_dir, use_gpu)
@@ -620,6 +621,7 @@ def __init__(
             os.chdir(cwd)
 
     def metas(self) -> str:
+        """キャラクターメタ情報を文字列として取得する。"""
         metas_bytes: bytes = self.core.metas()
         return metas_bytes.decode("utf-8")
 
@@ -630,7 +632,7 @@ def yukarin_s_forward(
         style_id: NDArray[np.int64],
     ) -> NDArray[np.float32]:
         """
-        音素列から、音素ごとの長さを求める関数
+        音素列から音素ごとの長さを求める。
 
         Parameters
         ----------
@@ -669,7 +671,7 @@ def yukarin_sa_forward(
         style_id: NDArray[np.int64],
     ) -> NDArray[np.float32]:
         """
-        モーラごとの音素列とアクセント情報から、モーラごとの音高を求める関数
+        モーラごとの音素列とアクセント情報からモーラごとの音高を求める。
 
         Parameters
         ----------
@@ -726,7 +728,7 @@ def decode_forward(
         style_id: NDArray[np.int64],
     ) -> NDArray[np.float32]:
         """
-        フレームごとの音素と音高から波形を求める関数
+        フレームごとの音素と音高から波形を求める。
 
         Parameters
         ----------
@@ -768,7 +770,7 @@ def predict_sing_consonant_length_forward(
         style_id: NDArray[np.int64],
     ) -> NDArray[np.int64]:
         """
-        子音・母音列から、音素ごとの長さを求める関数
+        子音・母音列から音素ごとの長さを求める。
 
         Parameters
         ----------
@@ -811,7 +813,7 @@ def predict_sing_f0_forward(
         style_id: NDArray[np.int64],
     ) -> NDArray[np.float32]:
         """
-        フレームごとの音素列とノート列から、フレームごとのF0を求める関数
+        フレームごとの音素列とノート列からフレームごとのF0を求める。
 
         Parameters
         ----------
@@ -852,7 +854,7 @@ def predict_sing_volume_forward(
         style_id: NDArray[np.int64],
     ) -> NDArray[np.float32]:
         """
-        フレームごとの音素列とノート列から、フレームごとのvolumeを求める関数
+        フレームごとの音素列とノート列からフレームごとの音量を求める。
 
         Parameters
         ----------
@@ -896,7 +898,7 @@ def sf_decode_forward(
         style_id: NDArray[np.int64],
     ) -> NDArray[np.float32]:
         """
-        フレームごとの音素と音高から波形を求める関数
+        フレームごとの音素と音高から波形を求める。
 
         Parameters
         ----------
@@ -932,30 +934,34 @@ def sf_decode_forward(
         raise OldCoreError
 
     def supported_devices(self) -> str:
-        """coreから取得した対応デバイスに関するjsonデータの文字列。"""
+        """コアが対応するデバイスの情報をJSON文字列として取得する。"""
         if self.api_exists["supported_devices"]:
             supported_devices_byte: bytes = self.core.supported_devices()
             return supported_devices_byte.decode("utf-8")
         raise OldCoreError
 
     def finalize(self) -> None:
+        """コアをファイナライズする。"""
         if self.api_exists["finalize"]:
             self.core.finalize()
             return
         raise OldCoreError
 
     def load_model(self, style_id: int) -> None:
+        """コアにモデルを読み込む。"""
         if self.api_exists["load_model"]:
             self.assert_core_success(self.core.load_model(c_long(style_id)))
         raise OldCoreError
 
     def is_model_loaded(self, style_id: int) -> bool:
+        """コアに指定されたモデルが読み込まれているか確認する。"""
         if self.api_exists["is_model_loaded"]:
             loaded_bool: bool = self.core.is_model_loaded(c_long(style_id))
             return loaded_bool
         raise OldCoreError
 
     def assert_core_success(self, result: bool) -> None:
+        """コアの失敗を表すコードが現れた場合に Python 例外へ変換する。"""
         if not result:
             raise CoreError(
                 self.core.last_error_message().decode("utf-8", "backslashreplace")

voicevox_engine/dev/core/mock.py

@@ -19,9 +19,11 @@ def __init__(
         cpu_num_threads: int = 0,
         load_all_models: bool = False,
     ) -> None:
+        """コアを利用可能にする。"""
         self.default_sampling_rate = 24000
 
     def metas(self) -> str:
+        """キャラクターメタ情報を文字列として取得する。"""
         return json.dumps(
             [
                 # トーク２つ・ハミング２つ
@@ -231,16 +233,25 @@ def sf_decode_forward(
         return np.array(result, dtype=np.float32)
 
     def supported_devices(self) -> str:
+        """コアが対応するデバイスの情報をJSON文字列として取得する。"""
         return json.dumps({"cpu": True, "cuda": False, "dml": False})
 
     def finalize(self) -> None:
+        """コアをファイナライズする。"""
+        # 「コアのファイナライズが常に成功する」として扱う
         pass
 
     def load_model(self, style_id: int) -> None:
+        """コアにモデルを読み込む。"""
+        # 「モデルの読み込みが常に成功する」として扱う
         pass
 
     def is_model_loaded(self, style_id: int) -> bool:
+        """コアに指定されたモデルが読み込まれているか確認する。"""
+        # 「モデルが常に読み込まれている」として扱う
         return True
 
     def assert_core_success(self, result: bool) -> None:
+        """コアの失敗を表すコードが現れた場合にそれを Python 例外へ変換する。"""
+        # 「コアが常に成功する」として扱う
         pass

voicevox_engine/metas/MetasStore.py

@@ -120,6 +120,26 @@ def character_info(
         resource_baseurl: str,
         resource_format: ResourceFormat,
     ) -> SpeakerInfo:
+        """指定されたキャラクターの情報を取得する。
+
+        Parameters
+        ----------
+        character_uuid:
+            キャラクターを指定する UUID
+        talk_or_sing:
+            「喋れる」と「歌える」のどちらを取得するか
+        core_version:
+            コアのバージョン
+        resource_baseurl:
+            リソースが存在するディレクトリのベース URL
+        resource_format:
+            返されるリソースのフォーマット
+
+        Returns
+        -------
+        SpeakerInfo
+            キャラクター情報
+        """
         # キャラクター情報は以下のディレクトリ構造に従わなければならない。
         # {engine_characters_path}/
         #     {character_uuid_0}/

voicevox_engine/user_dict/model.py

@@ -111,6 +111,9 @@ class UserDictWord(BaseModel):
 
     @model_validator(mode="after")
     def check_mora_count_and_accent_type(self) -> Self:
+        """モーラ数が None であれば計算し、アクセント型を検証する。"""
+        # TODO: 2つの機能を２つの関数に分けるのが正しいか検討
+        # モーラ数を計算し代入する
         if self.mora_count is None:
             rule_others = (
                 "[イ][ェ]|[ヴ][ャュョ]|[ウクグトド][ゥ]|[テデ][ィェャュョ]|[クグ][ヮ]"
@@ -124,7 +127,7 @@ def check_mora_count_and_accent_type(self) -> Self:
                     self.pronunciation,
                 )
             )
-
+        # アクセント型を検証する
         if not 0 <= self.accent_type <= self.mora_count:
             raise ValueError(
                 f"誤ったアクセント型です({self.accent_type})。 expect: 0 <= accent_type <= {self.mora_count}"