整理: ライセンス生成の重複処理を共通化

[tarepan]

内容

概要: ライセンス生成の重複処理を共通化してリファクタリングした

従来の generate_licenses.py ではライセンス情報の生成時に「ライセンス文アクセス→License インスタンス化→licenses 登録」を約20個の個別ライセンスごとにベタ書きしており、一切の共通化がなされていなかった。
これら重複処理を for 文により共通化した。
すなわち、以前の

   licenses.append(
        License(
            name="Open JTalk",
            version="1.11",
            license="Modified BSD license",
            text=Path("docs/licenses/open_jtalk/COPYING").read_text(),
        )
    )
    licenses.append(
        License(
            name="MeCab",
            version=None,
            license="Modified BSD license",
            text=Path("docs/licenses/open_jtalk/mecab/COPYING").read_text(),
        )
    )
    with urllib.request.urlopen(
        "https://raw.githubusercontent.com/VOICEVOX/voicevox_core/main/LICENSE"
    ) as res:
        licenses.append(
            License(
                name="VOICEVOX CORE",
                version=None,
                license="MIT license",
                text=res.read().decode(),
            )
        )

を次のように共通化した：

    license_infos: list[LicenseInfo] = [
        ("local",   "Open JTalk",    "1.11", "Modified BSD license", "docs/licenses/open_jtalk/COPYING"),
        ("local",   "MeCab",         None,   "Modified BSD license", "docs/licenses/open_jtalk/mecab/COPYING"),
        ("remote",  "VOICEVOX CORE", None,   "MIT license",          "https://raw.githubusercontent.com/VOICEVOX/voicevox_core/main/LICENSE"),
    ]

    for info in license_infos:
        if info[0] == "local":
            licenses.append(
                License(
                    name=info[1],
                    version=info[2],
                    license=info[3],
                    text=Path(info[4]).read_text(),
                )
            )
        elif info[0] == "remote":
            with urllib.request.urlopen(info[4]) as res:
                licenses.append(
                    License(
                        name=info[1],
                        version=info[2],
                        license=info[3],
                        text=res.read().decode(),
                    )
                )

license_infos の可読性を上げるためにこの箇所における linter をオフにし、space 挿入による整形をおこなっている。
折り返し無効化により GitHub PR UI 上での可読性が下がっているため、エディタでチェックして頂ければ幸いです。

関連 Issue

無し

Notes

python build_util/generate_licenses.py -o ./opt.json の出力がリファクタリング前後で完全一致することを確認済み

[github-actions]

Coverage Result

Resultを開く

Name	Stmts	Miss	Cover
run.py	517	210
voicevox_engine/init.py	1	0
voicevox_engine/cancellable_engine.py	94	72
voicevox_engine/core/init.py	0	0
voicevox_engine/core/core_adapter.py	81	6
voicevox_engine/core/core_initializer.py	60	30
voicevox_engine/core/core_wrapper.py	225	157
voicevox_engine/dev/init.py	0	0
voicevox_engine/dev/core/init.py	0	0
voicevox_engine/dev/core/mock.py	65	2
voicevox_engine/dev/tts_engine/init.py	0	0
voicevox_engine/dev/tts_engine/mock.py	28	0
voicevox_engine/engine_manifest/EngineManifest.py	36	0
voicevox_engine/engine_manifest/EngineManifestLoader.py	12	0
voicevox_engine/engine_manifest/init.py	0	0
voicevox_engine/library_manager.py	92	4
voicevox_engine/metas/Metas.py	36	0
voicevox_engine/metas/MetasStore.py	28	1
voicevox_engine/metas/init.py	0	0
voicevox_engine/model.py	180	3
voicevox_engine/morphing.py	71	4
voicevox_engine/preset/Preset.py	13	0
voicevox_engine/preset/PresetError.py	2	0
voicevox_engine/preset/PresetManager.py	80	2
voicevox_engine/preset/init.py	0	0
voicevox_engine/setting/Setting.py	9	0
voicevox_engine/setting/SettingLoader.py	20	0
voicevox_engine/setting/init.py	0	0
voicevox_engine/tts_pipeline/init.py	0	0
voicevox_engine/tts_pipeline/kana_converter.py	88	1
voicevox_engine/tts_pipeline/mora_mapping.py	7	0
voicevox_engine/tts_pipeline/phoneme.py	34	0
voicevox_engine/tts_pipeline/text_analyzer.py	146	6
voicevox_engine/tts_pipeline/tts_engine.py	267	9
voicevox_engine/user_dict/part_of_speech_data.py	5	0
voicevox_engine/user_dict/user_dict.py	146	12
voicevox_engine/utility/init.py	0	0
voicevox_engine/utility/connect_base64_waves.py	37	0
voicevox_engine/utility/core_utility.py	6	0
voicevox_engine/utility/core_version_utility.py	8	1
voicevox_engine/utility/mutex_utility.py	13	0
voicevox_engine/utility/path_utility.py	26	6
voicevox_engine/utility/run_utility.py	10	7
TOTAL	2443	533

[Hiroshiba]

見やすい反面、他の貢献者の方の妨げになっちゃうかもとちょっと思いました。
結構意見分かれる気がするので遠慮なく意見いただけると！！

[tarepan]

#1153 (comment) のファクトリに着想を得た alternative 実装として #1177 を提案しました。

@Hiroshiba
本 PR と #1177 を比較した所感をお聞きできればと思います。