Python APIとJava APIのエラーを詳細にする #640

qryxip · 2023-10-12T17:48:57Z

内容

Python APIとJava APIの例外に、次の変更を加えます。

VoicevoxError/VoicevoxExceptionを解体し、細分化

以下の例外クラスを継承するようにする。

	Python	Java
`NotLoadedOpenjtalkDict`	`Exception`	`IllegalStateException`
`GpuSupport`	`Exception`	`RuntimeException`
`OpenZipFile`	`Exception`	`IOException`
`ReadZipEntry`	`Exception`	`IOException`
`ModelAlreadyLoaded`	`Exception`	`IllegalStateException`
`StyleAlreadyLoaded`	`Exception`	`IllegalStateException`
`InvalidModelData`	`Exception`	`IOException`
`GetSupportedDevices`	`Exception`	`IOException`
`StyleNotFound`	`KeyError`	`IndexOutOfBoundsException`
`ModelNotFound`	`KeyError`	`IndexOutOfBoundsException`
`InferenceFailed`	`Exception`	`IOException`
`ExtractFullContextLabel`	`Exception`	`IllegalArgumentException`
`ParseKana`	`ValueError`	`IllegalArgumentException`
`LoadUserDict`	`Exception`	`IOException`
`SaveUserDict`	`Exception`	`IOException`
`WordNotFound`	`KeyError`	`IndexOutOfBoundsException`
`UseUserDict`	`Exception`	`RuntimeException`
`InvalidWord`	`ValueError`	`IllegalArgumentException`
その他	`ValueError`とか	`IllegalArgumentException`とか

Rustの"source"を"cause"に反映

Exception: なんかのエラー (1)

The above exception was the direct cause of the following exception:

Exception: なんかのエラー (2)

The above exception was the direct cause of the following exception:

Exception: unable to locate the end of central directory record

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "./run.py", line 104, in <module>
    asyncio.run(main())
  File "/home/ryo/.pyenv/versions/3.8.15/lib/python3.8/asyncio/runners.py", line 44, in run
    return loop.run_until_complete(main)
  File "/home/ryo/.pyenv/versions/3.8.15/lib/python3.8/asyncio/base_events.py", line 616, in run_until_complete
    return future.result()
  File "./run.py", line 46, in main
    model = await VoiceModel.from_path(vvm_path)
voicevox_core.OpenZipFileError: `/dev/null`の読み込みに失敗しました: ZIPファイルとして開くことができませんでした

Python API
Java API

その他

#580 で言ったこれに対応します。

Python APIとJava APIでsourceの内容を表現

qryxip · 2023-10-19T17:47:37Z

コードが整っているとは言えない状態ですが、とりあえず実装は完了。

Hiroshiba

LGTM！！！

ぶっちゃけ正直精査してないです！なんか良さそう！
前も同じようなこと言った気かもしれないんですが、自動生成できるコードもどんどん用意していけると自重で動けなくなるのを先延ばしにできる気がしました！
（いわゆる自動化）

@sevenc-nanashi さんもよかったら見ていただけると！！！

qryxip · 2023-10-19T20:10:48Z

今気付いたのですがJava APIの方、IOException相当のものをthrowするならthrowsにしないと駄目ですね。多分。

qryxip · 2023-10-19T20:14:36Z

crates/voicevox_core_python_api/python/voicevox_core/_rust.pyi

+class NotLoadedOpenjtalkDictError(Exception):
+    """open_jtalk辞書ファイルが読み込まれていない。"""
+
+    ...
+
+class GpuSupportError(Exception):
+    """GPUモードがサポートされていない。"""
+
+    ...
+
+class OpenZipFileError(Exception):
+    """ZIPファイルを開くことに失敗した。"""
+
+    ...
+
+class ReadZipEntryError(Exception):
+    """ZIP内のファイルが読めなかった。"""
+
+    ...
+
+class ModelAlreadyLoadedError(Exception):
+    """すでに読み込まれている音声モデルを読み込もうとした。"""
+
+    ...
+
+class StyleAlreadyLoadedError(Exception):
+    """すでに読み込まれているスタイルを読み込もうとした。"""
+
+    ...
+
+class InvalidModelDataError(Exception):
+    """無効なモデルデータ。"""
+
+    ...
+
+class GetSupportedDevicesError(Exception):
+    """サポートされているデバイス情報取得に失敗した。"""
+
+    ...
+
+class StyleNotFoundError(KeyError):
+    """スタイルIDに対するスタイルが見つからなかった。"""
+
+    ...
+
+class ModelNotFoundError(KeyError):
+    """音声モデルIDに対する音声モデルが見つからなかった。"""
+
+    ...
+
+class InferenceFailedError(Exception):
+    """推論に失敗した。"""
+
+    ...
+
+class ExtractFullContextLabelError(Exception):
+    """コンテキストラベル出力に失敗した。"""
+
+    ...
+
+class ParseKanaError(ValueError):
+    """AquesTalk風記法のテキストの解析に失敗した。"""
+
+    ...
+
+class LoadUserDictError(Exception):
+    """ユーザー辞書を読み込めなかった。"""
+
+    ...
+
+class SaveUserDictError(Exception):
+    """ユーザー辞書を書き込めなかった。"""
+
+    ...
+
+class WordNotFoundError(KeyError):
+    """ユーザー辞書に単語が見つからなかった。"""
+
+    ...
+
+class UseUserDictError(Exception):
+    """OpenJTalkのユーザー辞書の設定に失敗した。"""
+
+    ...
+
+class InvalidWordError(ValueError):
+    """ユーザー辞書の単語のバリデーションに失敗した。"""


.pyiじゃなくてPythonの方に移してもいいかも。

これは別PRでやろうと思います。

crates/voicevox_core_java_api/src/common.rs

qryxip · 2023-10-22T02:49:13Z

今気付いたのですがJava APIの方、IOException相当のものをthrowするならthrowsにしないと駄目ですね。多分。

これを今やりました。
9e87842 (#640)

@sevenc-nanashi すみません。お手数ですがこちらも確認して頂いてもよいでしょうか。OKならそのままマージして頂けると。

sevenc-nanashi · 2023-10-22T02:55:03Z

CI通ったらマージします。

qryxip added 3 commits October 13, 2023 02:44

Python APIとJava APIのエラーを詳細にする

97e711a

Merge branch 'main' into publish-python-and-java-error-details

dc6b4bc

Java API

04ac25a

qryxip marked this pull request as ready for review October 19, 2023 17:46

qryxip added 4 commits October 20, 2023 03:07

…NotFoundErrorをKeyErrorに

a9905cc

assert

69e2647

Minor refactor

2e28029

不要な依存を削除

38f277d

Hiroshiba approved these changes Oct 19, 2023

View reviewed changes

qryxip commented Oct 19, 2023

View reviewed changes

sevenc-nanashi reviewed Oct 19, 2023

View reviewed changes

crates/voicevox_core_java_api/src/common.rs Outdated Show resolved Hide resolved

crates/voicevox_core_java_api/src/common.rs Outdated Show resolved Hide resolved

qryxip added 2 commits October 21, 2023 02:47

assertはせずにUnsupportedOperationExceptionを発する

0098be9

不要なエラーを排除/パニック化

48d47de

qryxip mentioned this pull request Oct 21, 2023

JavaStrの内容を直にUTF-8として読まない #654

Merged

sevenc-nanashi approved these changes Oct 22, 2023

View reviewed changes

qryxip added 2 commits October 22, 2023 11:14

Merge branch 'main' into publish-python-and-java-error-details

5c5e04a

IOExceptionを継承するものはthrowsにする

9e87842

sevenc-nanashi approved these changes Oct 22, 2023

View reviewed changes

sevenc-nanashi merged commit 70acaf8 into VOICEVOX:main Oct 22, 2023
46 checks passed

qryxip mentioned this pull request Oct 30, 2023

Error::InferenceFailedにsourceとしてOrtErrorを持たせる #668

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Python APIとJava APIのエラーを詳細にする #640

Python APIとJava APIのエラーを詳細にする #640

qryxip commented Oct 12, 2023 •

edited

Loading

qryxip commented Oct 19, 2023

Hiroshiba left a comment

qryxip commented Oct 19, 2023

qryxip Oct 19, 2023

qryxip Oct 22, 2023

qryxip commented Oct 22, 2023

sevenc-nanashi commented Oct 22, 2023 •

edited

Loading

Python APIとJava APIのエラーを詳細にする #640

Python APIとJava APIのエラーを詳細にする #640

Conversation

qryxip commented Oct 12, 2023 • edited Loading

内容

関連 Issue

その他

qryxip commented Oct 19, 2023

Hiroshiba left a comment

Choose a reason for hiding this comment

qryxip commented Oct 19, 2023

qryxip Oct 19, 2023

Choose a reason for hiding this comment

qryxip Oct 22, 2023

Choose a reason for hiding this comment

qryxip commented Oct 22, 2023

sevenc-nanashi commented Oct 22, 2023 • edited Loading

qryxip commented Oct 12, 2023 •

edited

Loading

sevenc-nanashi commented Oct 22, 2023 •

edited

Loading