refactor: ruff D410 と D411 を適用 (#1610)

Author: tarepan

pyproject.toml

@@ -18,8 +18,6 @@ ignore = [
   "D300", # NOTE: 段階的に有効化する可能性がある。
   "D403", # NOTE: 段階的に有効化する可能性がある。
   "D409", # NOTE: 段階的に有効化する可能性がある。
-  "D410", # NOTE: 段階的に有効化する可能性がある。
-  "D411", # NOTE: 段階的に有効化する可能性がある。
 ]
 unfixable = [
   "F401", # unused-import

voicevox_engine/core/core_adapter.py

@@ -89,6 +89,7 @@ def initialize_style_id_synthesis(
         """
         指定したスタイルでの音声合成を初期化する。
         何度も実行可能。未実装の場合は何もしない。
+
         Parameters
         ----------
         style_id : StyleId

voicevox_engine/core/core_initializer.py

@@ -122,6 +122,7 @@ def initialize_cores(
         def load_core_library(core_dir: Path, suppress_error: bool = False) -> None:
             """
             指定されたコアをロードし `core_manager` へ登録する。
+
             Parameters
             ----------
             core_dir : Path

voicevox_engine/core/core_wrapper.py

@@ -291,6 +291,7 @@ def _get_core_name(
     """
     設定値を満たすCoreの名前（None: サポート外）。
     macOSの場合はarch_nameをuniversalにする。
+
     Parameters
     ----------
     arch_name : Literal["x64", "x86", "aarch64", "armv7l", "universal"]
@@ -299,6 +300,7 @@ def _get_core_name(
         実行中マシンのシステム名
     model_type: Literal["libtorch", "onnxruntime"]
     gpu_type: GPUType
+
     Returns
     -------
     name : str | None
@@ -356,11 +358,13 @@ def _check_core_type(core_dir: Path) -> Literal["libtorch", "onnxruntime"] | Non
 def load_core(core_dir: Path, use_gpu: bool) -> CDLL:
     """
     `core_dir` 直下に存在し実行中マシンでサポートされるコアDLLのロード
+
     Parameters
     ----------
     core_dir : Path
         直下にコア（共有ライブラリ）が存在するディレクトリ
     use_gpu
+
     Returns
     -------
     core : CDLL
@@ -539,10 +543,12 @@ class _CoreApiType:
 def _check_and_type_apis(core_cdll: CDLL) -> dict[str, bool]:
     """
     コアDLLの各関数を（その関数があれば）型付けする。APIの有無の情報を辞書として返す
+
     Parameters
     ----------
     core_cdll : CDLL
         コアDLL
+
     Returns
     -------
     api_exists : dict[str, bool]
@@ -622,6 +628,7 @@ def yukarin_s_forward(
     ) -> NDArray[np.float32]:
         """
         音素列から、音素ごとの長さを求める関数
+
         Parameters
         ----------
         length : int
@@ -630,6 +637,7 @@ def yukarin_s_forward(
             音素列
         style_id : NDArray[np.int64]
             スタイル番号
+
         Returns
         -------
         output : NDArray[np.float32]
@@ -659,6 +667,7 @@ def yukarin_sa_forward(
     ) -> NDArray[np.float32]:
         """
         モーラごとの音素列とアクセント情報から、モーラごとの音高を求める関数
+
         Parameters
         ----------
         length : int
@@ -677,6 +686,7 @@ def yukarin_sa_forward(
             アクセント句の終了位置
         style_id : NDArray[np.int64]
             スタイル番号
+
         Returns
         -------
         output : NDArray[np.float32]
@@ -714,6 +724,7 @@ def decode_forward(
     ) -> NDArray[np.float32]:
         """
         フレームごとの音素と音高から波形を求める関数
+
         Parameters
         ----------
         length : int
@@ -726,6 +737,7 @@ def decode_forward(
             フレームごとの音素
         style_id : NDArray[np.int64]
             スタイル番号
+
         Returns
         -------
         output : NDArray[np.float32]
@@ -755,6 +767,7 @@ def predict_sing_consonant_length_forward(
     ) -> NDArray[np.int64]:
         """
         子音・母音列から、音素ごとの長さを求める関数
+
         Parameters
         ----------
         length : int
@@ -767,6 +780,7 @@ def predict_sing_consonant_length_forward(
             ノート列
         style_id : NDArray[np.int64]
             スタイル番号
+
         Returns
         -------
         output : NDArray[np.int64]
@@ -796,6 +810,7 @@ def predict_sing_f0_forward(
     ) -> NDArray[np.float32]:
         """
         フレームごとの音素列とノート列から、フレームごとのF0を求める関数
+
         Parameters
         ----------
         length : int
@@ -806,6 +821,7 @@ def predict_sing_f0_forward(
             フレームごとのノート
         style_id : NDArray[np.int64]
             スタイル番号
+
         Returns
         -------
         output : NDArray[np.float32]
@@ -835,6 +851,7 @@ def predict_sing_volume_forward(
     ) -> NDArray[np.float32]:
         """
         フレームごとの音素列とノート列から、フレームごとのvolumeを求める関数
+
         Parameters
         ----------
         length : int
@@ -847,6 +864,7 @@ def predict_sing_volume_forward(
             フレームごとの音高
         style_id : NDArray[np.int64]
             スタイル番号
+
         Returns
         -------
         output : NDArray[np.float32]
@@ -877,6 +895,7 @@ def sf_decode_forward(
     ) -> NDArray[np.float32]:
         """
         フレームごとの音素と音高から波形を求める関数
+
         Parameters
         ----------
         length : int
@@ -889,6 +908,7 @@ def sf_decode_forward(
             フレームごとの音量
         style_id : NDArray[np.int64]
             スタイル番号
+
         Returns
         -------
         output : NDArray[np.float32]

voicevox_engine/library/library_manager.py

@@ -123,12 +123,14 @@ def installed_libraries(self) -> dict[str, InstalledLibraryInfo]:
     def install_library(self, library_id: str, file: BinaryIO) -> Path:
         """
         音声ライブラリ (`.vvlib`) をインストールする。
+
         Parameters
         ----------
         library_id : str
             インストール対象ライブラリID
         file : BytesIO
             ライブラリファイルBlob
+
         Returns
         -------
         library_dir : Path

voicevox_engine/setting/setting_manager.py

@@ -30,6 +30,7 @@ class SettingHandler:
     def __init__(self, setting_file_path: Path) -> None:
         """
         設定ファイルの管理
+
         Parameters
         ----------
         setting_file_path : Path

voicevox_engine/tts_pipeline/connect_base64_waves.py

@@ -17,10 +17,12 @@ def __init__(self, message: str):
 def decode_base64_waves(waves: list[str]) -> list[tuple[NDArray[np.float64], int]]:
     """
     base64エンコードされた複数のwavデータをデコードする
+
     Parameters
     ----------
     waves: list[str]
         base64エンコードされたwavデータのリスト
+
     Returns
     -------
     waves_nparray_sr: list[tuple[NDArray[np.float64], int]]

voicevox_engine/tts_pipeline/kana_converter.py

@@ -68,10 +68,12 @@ def _text_to_accent_phrase(phrase: str) -> AccentPhrase:
     """
     単一アクセント句に相当するAquesTalk 風記法テキストからアクセント句オブジェクトを生成
     longest matchによりモーラ化。入力長Nに対し計算量O(N^2)。
+
     Parameters
     ----------
     phrase : str
         単一アクセント句に相当するAquesTalk 風記法テキスト
+
     Returns
     -------
     accent_phrase : AccentPhrase
@@ -131,10 +133,12 @@ def _text_to_accent_phrase(phrase: str) -> AccentPhrase:
 def parse_kana(text: str) -> list[AccentPhrase]:
     """
     AquesTalk 風記法テキストからアクセント句系列を生成
+
     Parameters
     ----------
     text : str
         AquesTalk 風記法テキスト
+
     Returns
     -------
     parsed_results : list[AccentPhrase]
@@ -189,10 +193,12 @@ def parse_kana(text: str) -> list[AccentPhrase]:
 def create_kana(accent_phrases: list[AccentPhrase]) -> str:
     """
     アクセント句系列からAquesTalk 風記法テキストを生成
+
     Parameters
     ----------
     accent_phrases : list[AccentPhrase]
         アクセント句系列
+
     Returns
     -------
     text : str

voicevox_engine/tts_pipeline/song_engine.py

@@ -68,10 +68,12 @@ def _notes_to_keys_and_phonemes(
 ]:
     """
     ノート単位の長さ・モーラ情報や、音素列・音素ごとのキー列を作成する
+
     Parameters
     ----------
     notes : list[Note]
         ノート列
+
     Returns
     -------
     note_lengths : NDArray[np.int64]

voicevox_engine/tts_pipeline/tts_engine.py

@@ -121,10 +121,12 @@ def _count_frame_per_unit(
 ) -> tuple[NDArray[np.int64], NDArray[np.int64]]:
     """
     音素あたり・モーラあたりのフレーム長を算出する
+
     Parameters
     ----------
     moras : list[Mora]
         モーラ系列
+
     Returns
     -------
     frame_per_phoneme : NDArray[np.int64]