From 6ce5930f54b1e833eca12854e30ee88ff740d904 Mon Sep 17 00:00:00 2001
From: tarepan <tarepan5884@gmail.com>
Date: Fri, 21 Jun 2024 08:02:40 +0900
Subject: [PATCH] =?UTF-8?q?=E6=95=B4=E7=90=86:=20=E7=92=B0=E5=A2=83?=
 =?UTF-8?q?=E5=A4=89=E6=95=B0=E3=82=92=20`Envs`=20=E3=82=AF=E3=83=A9?=
 =?UTF-8?q?=E3=82=B9=E3=81=A7=E5=9E=8B=E4=BB=98=E3=81=91=20(#1402)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* refactor: 環境変数をクラス化して型付け

* fix: lint

* add: docstring を追加

* add: Envs dataclass の凍結を追加

* add: `Envs` にバリデーションを追加

* fix: lint
---
 run.py | 44 ++++++++++++++++++++++++++++++++++----------
 1 file changed, 34 insertions(+), 10 deletions(-)

diff --git a/run.py b/run.py
index 63d6525fe..3e1e39337 100644
--- a/run.py
+++ b/run.py
@@ -5,7 +5,7 @@
 import os
 import sys
 import warnings
-from dataclasses import dataclass
+from dataclasses import asdict, dataclass
 from io import TextIOWrapper
 from pathlib import Path
 from typing import TextIO, TypeVar
@@ -51,6 +51,30 @@ def decide_boolean_from_env(env_name: str) -> bool:
         return False
 
 
+@dataclass(frozen=True)
+class Envs:
+    """環境変数の集合"""
+
+    output_log_utf8: bool
+    cpu_num_threads: str | None
+    env_preset_path: str | None
+    disable_mutable_api: bool
+
+
+_env_adapter = TypeAdapter(Envs)
+
+
+def read_environment_variables() -> Envs:
+    """環境変数を読み込む。"""
+    envs = Envs(
+        output_log_utf8=decide_boolean_from_env("VV_OUTPUT_LOG_UTF8"),
+        cpu_num_threads=os.getenv("VV_CPU_NUM_THREADS"),
+        env_preset_path=os.getenv("VV_PRESET_FILE"),
+        disable_mutable_api=decide_boolean_from_env("VV_DISABLE_MUTABLE_API"),
+    )
+    return _env_adapter.validate_python(asdict(envs))
+
+
 def set_output_log_utf8() -> None:
     """標準出力と標準エラー出力の出力形式を UTF-8 ベースに切り替える"""
 
@@ -135,7 +159,7 @@ class CLIArgs:
 _cli_args_adapter = TypeAdapter(CLIArgs)
 
 
-def read_cli_arguments() -> CLIArgs:
+def read_cli_arguments(envs: Envs) -> CLIArgs:
     parser = argparse.ArgumentParser(description="VOICEVOX のエンジンです。")
     # Uvicorn でバインドするアドレスを "localhost" にすることで IPv4 (127.0.0.1) と IPv6 ([::1]) の両方でリッスンできます.
     # これは Uvicorn のドキュメントに記載されていない挙動です; 将来のアップデートにより動作しなくなる可能性があります.
@@ -200,7 +224,7 @@ def read_cli_arguments() -> CLIArgs:
     parser.add_argument(
         "--cpu_num_threads",
         type=int,
-        default=os.getenv("VV_CPU_NUM_THREADS") or None,
+        default=envs.cpu_num_threads,
         help=(
             "音声合成を行うスレッド数です。指定しない場合、代わりに環境変数 VV_CPU_NUM_THREADS の値が使われます。"
             "VV_CPU_NUM_THREADS が空文字列でなく数値でもない場合はエラー終了します。"
@@ -282,11 +306,12 @@ def main() -> None:
 
     multiprocessing.freeze_support()
 
-    output_log_utf8 = decide_boolean_from_env("VV_OUTPUT_LOG_UTF8")
-    if output_log_utf8:
+    envs = read_environment_variables()
+
+    if envs.output_log_utf8:
         set_output_log_utf8()
 
-    args = read_cli_arguments()
+    args = read_cli_arguments(envs)
 
     if args.output_log_utf8:
         set_output_log_utf8()
@@ -331,9 +356,8 @@ def main() -> None:
         [args.allow_origins, setting_allow_origins]
     )
 
-    env_preset_path_str = os.getenv("VV_PRESET_FILE")
-    if env_preset_path_str is not None and len(env_preset_path_str) != 0:
-        env_preset_path = Path(env_preset_path_str)
+    if envs.env_preset_path is not None and len(envs.env_preset_path) != 0:
+        env_preset_path = Path(envs.env_preset_path)
     else:
         env_preset_path = None
     root_preset_path = engine_root() / "presets.yaml"
@@ -358,7 +382,7 @@ def main() -> None:
     if args.disable_mutable_api:
         disable_mutable_api = True
     else:
-        disable_mutable_api = decide_boolean_from_env("VV_DISABLE_MUTABLE_API")
+        disable_mutable_api = envs.disable_mutable_api
 
     root_dir = select_first_not_none([args.voicevox_dir, engine_root()])
     speaker_info_dir = root_dir / "resources" / "character_info"