Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

整理: fastapiの依存パッケージに意図コメント追加 #1076

Merged
merged 1 commit into from
Feb 26, 2024

Conversation

tarepan
Copy link
Contributor

@tarepan tarepan commented Feb 26, 2024

内容

概要: 依存パッケージ意図を追加してリファクタリング

pyproject.toml には依存パッケージが記録されているが、その一部は VOICEVOX ENGINE コード内に一切登場しない(見た目上の依存性がない)。これらのうち 3 つが FastAPI に暗示的に依存するものであるが、そのうち 1 つのみに FastAPI 依存に関する記述/コメントがある。他の2つにも同様のコメントを付与することでパッケージの依存関係を理解しやすくできる。

このような背景から、依存パッケージ意図の追加によるリファクタリングを提案します。

関連 Issue

@tarepan tarepan requested a review from a team as a code owner February 26, 2024 07:30
@tarepan tarepan requested review from Hiroshiba and removed request for a team February 26, 2024 07:30
Copy link

Coverage Result

Resultを開く
Name Stmts Miss Cover
run.py 513 277 coverage-46%
voicevox_engine/init.py 1 0 coverage-100%
voicevox_engine/cancellable_engine.py 94 72 coverage-23%
voicevox_engine/core/init.py 0 0 coverage-100%
voicevox_engine/core/core_adapter.py 81 12 coverage-85%
voicevox_engine/core/core_initializer.py 59 30 coverage-49%
voicevox_engine/core/core_wrapper.py 257 183 coverage-29%
voicevox_engine/dev/init.py 0 0 coverage-100%
voicevox_engine/dev/core/init.py 0 0 coverage-100%
voicevox_engine/dev/core/mock.py 65 4 coverage-94%
voicevox_engine/dev/tts_engine/init.py 0 0 coverage-100%
voicevox_engine/dev/tts_engine/mock.py 28 0 coverage-100%
voicevox_engine/engine_manifest/EngineManifest.py 36 0 coverage-100%
voicevox_engine/engine_manifest/EngineManifestLoader.py 12 0 coverage-100%
voicevox_engine/engine_manifest/init.py 0 0 coverage-100%
voicevox_engine/library_manager.py 92 4 coverage-96%
voicevox_engine/metas/Metas.py 36 0 coverage-100%
voicevox_engine/metas/MetasStore.py 28 6 coverage-79%
voicevox_engine/metas/init.py 0 0 coverage-100%
voicevox_engine/model.py 180 9 coverage-95%
voicevox_engine/morphing.py 71 46 coverage-35%
voicevox_engine/preset/Preset.py 13 0 coverage-100%
voicevox_engine/preset/PresetError.py 2 0 coverage-100%
voicevox_engine/preset/PresetManager.py 80 2 coverage-98%
voicevox_engine/preset/init.py 0 0 coverage-100%
voicevox_engine/setting/Setting.py 11 0 coverage-100%
voicevox_engine/setting/SettingLoader.py 17 0 coverage-100%
voicevox_engine/setting/init.py 0 0 coverage-100%
voicevox_engine/tts_pipeline/init.py 0 0 coverage-100%
voicevox_engine/tts_pipeline/kana_converter.py 88 1 coverage-99%
voicevox_engine/tts_pipeline/mora_mapping.py 7 0 coverage-100%
voicevox_engine/tts_pipeline/phoneme.py 34 0 coverage-100%
voicevox_engine/tts_pipeline/text_analyzer.py 146 6 coverage-96%
voicevox_engine/tts_pipeline/tts_engine.py 267 9 coverage-97%
voicevox_engine/user_dict/part_of_speech_data.py 5 0 coverage-100%
voicevox_engine/user_dict/user_dict.py 146 12 coverage-92%
voicevox_engine/utility/init.py 0 0 coverage-100%
voicevox_engine/utility/connect_base64_waves.py 37 0 coverage-100%
voicevox_engine/utility/core_version_utility.py 8 1 coverage-88%
voicevox_engine/utility/mutex_utility.py 13 0 coverage-100%
voicevox_engine/utility/path_utility.py 26 8 coverage-69%
voicevox_engine/utility/run_utility.py 10 7 coverage-30%
TOTAL 2463 689 coverage-72%

Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!

コメント書くだけで大幅にメンテナンス性が上がる典型例だなと思いました。

@Hiroshiba Hiroshiba changed the title 整理: 依存パッケージ意図 整理: fastapiの依存パッケージに意図コメント追加 Feb 26, 2024
@Hiroshiba
Copy link
Member

ちょっとタイトルわかりやすくさせていただきました!
マージします!

@Hiroshiba Hiroshiba merged commit ec19ebd into VOICEVOX:master Feb 26, 2024
4 checks passed
@tarepan tarepan deleted the refactor/dep_comment branch February 26, 2024 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants