整理: モジュール docstring を追加 (#1278)

* refactor: モジュール docstring を追加

* refactor: モジュール docstring を明確化

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>

* refactor: module docstring を明確化

* refactor: `tts_engine` module docstring を明確化

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>

* refactor: `application.py` docstring を明確化

* refactor: `model.py` docstring を詳細化

---------

Co-authored-by: Hiroshiba <hihokaruta@gmail.com>
Co-authored-by: Hiroshiba Kazuyuki <kazuyuki_hiroshiba@dwango.co.jp>

voicevox_engine/app/application.py

@@ -1,3 +1,5 @@
+"""ASGI application の生成"""
+
 from pathlib import Path
 
 from fastapi import FastAPI

voicevox_engine/app/dependencies.py

@@ -1,3 +1,5 @@
+"""FastAPI dependencies"""
+
 from dataclasses import dataclass
 
 from fastapi import HTTPException

voicevox_engine/cancellable_engine.py

@@ -1,3 +1,5 @@
+"""キャンセル可能な音声合成"""
+
 import asyncio
 import queue
 import sys

voicevox_engine/core/core_adapter.py

@@ -1,3 +1,5 @@
+"""VOICEVOX CORE のアダプター"""
+
 import json
 import threading
 from dataclasses import dataclass

voicevox_engine/core/core_initializer.py

@@ -1,3 +1,5 @@
+"""VOICEVOX CORE インスタンスの生成"""
+
 import json
 import os
 import sys

voicevox_engine/core/core_wrapper.py

@@ -1,3 +1,5 @@
+"""VOICEVOX CORE の Python ラッパー"""
+
 import os
 import platform
 from ctypes import _Pointer  # noqa: F401

voicevox_engine/dev/core/mock.py

@@ -1,3 +1,5 @@
+"""CoreWrapper のモック"""
+
 import json
 from pathlib import Path
 

voicevox_engine/dev/tts_engine/mock.py

@@ -1,3 +1,5 @@
+"""TTSEngine のモック"""
+
 import copy
 from logging import getLogger
 from typing import Any

voicevox_engine/engine_manifest.py

@@ -1,3 +1,5 @@
+"""エンジンマニフェスト関連の処理"""
+
 # マルチエンジン環境下においては、エンジンのバージョンがエディタのバージョンより
 # 古くなる可能性が十分に考えられる。その場合、エディタ側がEngineManifestの情報不足によって
 # エラーを吐いて表示が崩壊する可能性がある。これを防止するため、EngineManifest関連の定義を

voicevox_engine/library/library_manager.py

@@ -1,3 +1,5 @@
+"""音声ライブラリの管理"""
+
 import base64
 import json
 import os

voicevox_engine/metas/Metas.py

@@ -1,3 +1,5 @@
+"""話者情報と話者メタ情報"""
+
 from enum import Enum
 from typing import Literal, NewType
 

voicevox_engine/metas/MetasStore.py

@@ -1,3 +1,5 @@
+"""話者情報と話者メタ情報の管理"""
+
 import json
 from dataclasses import dataclass
 from pathlib import Path

voicevox_engine/model.py

@@ -1,3 +1,12 @@
+"""
+API と ENGINE 内部実装が共有するモデル
+
+このモジュールで定義されるモデル（データ構造）は API と ENGINE の 2 箇所から使われる。そのため
+- モデルの変更は API 変更となるため慎重に検討する。
+- モデルの docstring や Field は API スキーマとして使われるため、ユーザー向けに丁寧に書く。
+- モデルクラスは FastAPI の制約から `BaseModel` を継承しなければならない。
+"""
+
 from pydantic import BaseModel, Field
 
 from voicevox_engine.tts_pipeline.model import AccentPhrase

voicevox_engine/preset/preset_manager.py

@@ -1,4 +1,4 @@
-"""プリセットのモデルとエラー"""
+"""プリセット関連の処理"""
 
 from pathlib import Path
 

voicevox_engine/setting/setting_manager.py

@@ -1,3 +1,5 @@
+"""エンジン設定関連の処理"""
+
 from enum import Enum
 from pathlib import Path
 

voicevox_engine/tts_pipeline/connect_base64_waves.py

@@ -1,3 +1,5 @@
+"""音声データの結合"""
+
 import base64
 import io
 

voicevox_engine/tts_pipeline/phoneme.py

@@ -1,3 +1,5 @@
+"""音素"""
+
 from typing import Literal
 
 import numpy as np

voicevox_engine/tts_pipeline/text_analyzer.py

@@ -1,3 +1,5 @@
+"""テキスト解析"""
+
 import re
 from dataclasses import dataclass
 from itertools import chain

voicevox_engine/tts_pipeline/tts_engine.py

@@ -1,3 +1,5 @@
+"""音声合成エンジン"""
+
 import copy
 import math
 

voicevox_engine/utility/core_version_utility.py

@@ -1,3 +1,5 @@
+"""バージョンに関する utility"""
+
 from semver.version import Version
 
 

voicevox_engine/utility/path_utility.py

@@ -1,3 +1,5 @@
+"""パスに関する utility"""
+
 import sys
 from pathlib import Path