run.py: ルーティング関数の戻り値に型ヒントを追加

[aoirint]

内容

run.pyのルーティング関数（@app.getなどがついている関数）の戻り値に型ヒントを追加し、mypyのno-untyped-defエラーをルーティング関数に限って解消します。

誤ったオブジェクトを返すことによる不具合を型レベルで防げます。

変更量を少なくするため、ルーティング関数以外は変更していません。

合わせて変更した点

• 変更した部分の周りの型ヒントを新しい記法に移行
  • Python 3.9で導入された記法: List[Type] -> list[Type]、Tuple[Type] -> tuple[Type]
  • Python 3.10で導入された記法: Optional[Type] -> Type | None
• /core_versionsの戻り値の型が実際にはResponseだがlist[str]で型ヒントがついていたのをResponseに修正
  • list[str]にする場合、Responseではないオブジェクトを返すように修正が必要
• /installed_librariesのdocstringの戻り値の型の誤りを修正
• setting_get(), setting_post()のresponse_classをHTMLResponseからResponseに変更
  • これらの関数ではstartlette.templating._TemplateResponse型が返るが、この型はHTMLResponseを継承しておらず、Responseを直接継承している
  • 先月HTMLResponseを継承する変更がマージされているが、まだリリースされていない
    • Inherit from HTMLResponse instead of Response on _TemplateResponse (#2272) encode/starlette#2274
  • Responseを継承したオブジェクトを返すとresponse_classは無視される（FastAPIのソースコード@c1adce4）ので、実は設定する必要がない。そのままでもいいかもしれないけれど、戻り値の型との不一致は混乱するので避けたい

未修正な点（ルーティング関数内のmypy型エラー出力）

run.py:637: error: Incompatible return value type (got "HTTPException", expected "FileResponse")  [return-value]
run.py:770: error: Unsupported left operand type for / ("None")  [operator]
run.py:770: note: Left operand is of type "Optional[Path]"
run.py:774: error: Unsupported left operand type for / ("None")  [operator]
run.py:774: note: Left operand is of type "Optional[Path]"
run.py:781: error: Unsupported left operand type for / ("None")  [operator]
run.py:781: note: Left operand is of type "Optional[Path]"
run.py:785: error: Unsupported left operand type for / ("None")  [operator]
run.py:785: note: Left operand is of type "Optional[Path]"
run.py:795: error: Unsupported left operand type for / ("None")  [operator]
run.py:795: note: Left operand is of type "Optional[Path]"
run.py:950: error: Invalid type comment or annotation  [valid-type]
run.py:950: note: Suggestion: use conint[...] instead of conint(...)
run.py:992: error: Invalid type comment or annotation  [valid-type]
run.py:992: note: Suggestion: use conint[...] instead of conint(...)

関連 Issue

• mypyの設定を有効化する #263
• /connect_waves: HTTPExceptionをreturnではなくraiseするように修正 #763
• run.pyの改善 #119

スクリーンショット・動画など

その他

mypyを実行

poetry run mypy .

[github-actions]

Coverage Result

Resultを開く

Name	Stmts	Miss	Cover
run.py	446	298
voicevox_engine/init.py	1	0
voicevox_engine/acoustic_feature_extractor.py	75	0
voicevox_engine/cancellable_engine.py	85	66
voicevox_engine/dev/core/init.py	2	0
voicevox_engine/dev/core/mock.py	27	12
voicevox_engine/dev/synthesis_engine/init.py	2	0
voicevox_engine/dev/synthesis_engine/mock.py	36	2
voicevox_engine/downloadable_library.py	93	5
voicevox_engine/engine_manifest/EngineManifest.py	34	0
voicevox_engine/engine_manifest/EngineManifestLoader.py	12	0
voicevox_engine/engine_manifest/init.py	3	0
voicevox_engine/full_context_label.py	162	3
voicevox_engine/kana_parser.py	86	1
voicevox_engine/metas/Metas.py	33	0
voicevox_engine/metas/MetasStore.py	29	12
voicevox_engine/metas/init.py	2	0
voicevox_engine/model.py	160	9
voicevox_engine/mora_list.py	4	0
voicevox_engine/morphing.py	70	46
voicevox_engine/part_of_speech_data.py	5	0
voicevox_engine/preset/Preset.py	12	0
voicevox_engine/preset/PresetError.py	2	0
voicevox_engine/preset/PresetManager.py	81	2
voicevox_engine/preset/init.py	4	0
voicevox_engine/setting/Setting.py	11	0
voicevox_engine/setting/SettingLoader.py	19	0
voicevox_engine/setting/init.py	3	0
voicevox_engine/synthesis_engine/init.py	5	0
voicevox_engine/synthesis_engine/core_wrapper.py	201	146
voicevox_engine/synthesis_engine/make_synthesis_engines.py	59	30
voicevox_engine/synthesis_engine/synthesis_engine.py	130	11
voicevox_engine/synthesis_engine/synthesis_engine_base.py	67	9
voicevox_engine/user_dict.py	144	11
voicevox_engine/utility/init.py	5	0
voicevox_engine/utility/connect_base64_waves.py	37	0
voicevox_engine/utility/core_version_utility.py	8	1
voicevox_engine/utility/mutex_utility.py	10	0
voicevox_engine/utility/path_utility.py	26	8
TOTAL	2191	672

[Hiroshiba]

ほぼLGTMです！！
細かい部分のコメントとても助かります！！

引数が1つの関数を改行するかどうかが結構ランダムに決められているように感じました。
まあ別に良いのですが、とりあえず既存のに合わせてできる限り1行にしておくと、配慮ができてちょっとかっこいいかもです！

[Hiroshiba]

LGTM！！！

調整ありがとうございます！
ず〜〜っと型ワーニングが出ていたの気になってたので嬉しいです！！！