feat! [Python] リテラル型をnon exhaustiveに

[qryxip]

内容

#941, #955, #950 の続き。

_Reservedは voicevox_core._models._Reserved voicevox_core._models._please_do_not_use._Reserved としてでしか存在せず、ユーザーは原則触ることはできない状態にしてある。

不正な値を入れようとしたときのPydanticのエラーはこうなる。

❯ python
Python 3.10.16 (main, Jan  1 2025, 22:31:19) [GCC 14.2.1 20240910] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from voicevox_core import UserDictWord
>>> UserDictWord("ア", "ア", word_type="不正な値")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/ryo/.cache/pypoetry/virtualenvs/voicevox-core-hMLxFPJX-py3.10/lib/python3.10/site-packages/pydantic/_internal/_dataclasses.py", line 141, in __init__
    s.__pydantic_validator__.validate_python(ArgsKwargs(args, kwargs), self_instance=s)
pydantic_core._pydantic_core.ValidationError: 2 validation errors for UserDictWord
word_type.literal['PROPER_NOUN','COMMON_NOUN','VERB','ADJECTIVE','SUFFIX']
  Input should be 'PROPER_NOUN', 'COMMON_NOUN', 'VERB', 'ADJECTIVE' or 'SUFFIX' [type=literal_error, input_value='不正な値', input_type=str]
    For further information visit https://errors.pydantic.dev/2.9/v/literal_error
word_type.function-after[_no_input_allowed(), any]
  Value error, No input is allowed for `_Reserved` [type=value_error, input_value='不正な値', input_type=str]
    For further information visit https://errors.pydantic.dev/2.9/v/value_error

またドキュメントはこんな感じ。_Reservedにリンクが張られていないのは、上記の通り意図したもの。

関連 Issue

その他

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

[Hiroshiba]

LGTM！

結構pydanticの機能に依存している箇所があると思うので、pydanticのバージョンをあげたときもちゃんと動作していることを確認するテストを追加しても良いのかもなーと感じました！
（ちょっとちゃんと把握してないのでどういうテストがいるのか、そもそも必要なのかわかってませんが･･･）

不要だったらマージ、あったほうが良ければ実装＆再レビュー、もしくはissue化とかで良さそう！

[qryxip]

337d2ab (#957): voicevox_core._models._Reservedを、voicevox_core._models._please_do_not_use._Reservedに移動しました。

[qryxip]

結構pydanticの機能に依存している箇所があると思うので、pydanticのバージョンをあげたときもちゃんと動作していることを確認するテストを追加しても良いのかもなーと感じました！ （ちょっとちゃんと把握してないのでどういうテストがいるのか、そもそも必要なのかわかってませんが･･･）

不要だったらマージ、あったほうが良ければ実装＆再レビュー、もしくはissue化とかで良さそう！

ちょっと理解しきれていないのですが、正常系は既にいっぱいパスが通っていることを考えるとエラー周りですかね？例えば不正な文字列を入れたら変な例外ではなくちゃんとpydantic.ValidationErrorで返されることとか…？

例:

voicevox_core/crates/voicevox_core_python_api/python/test/test_blocking_user_dict_manipulate.py

Lines 77 to 83 in 2410043

	with pytest.raises(pydantic.ValidationError):
	dict_a.add_word(
	voicevox_core.UserDictWord(
	surface="",
	pronunciation="カタカナ以外の文字",
	)
	)

[qryxip]

3c43148 (#957): 異常系のテストを一つ書いてみました。

[Hiroshiba]

あ、ですです！
バリデーション等が正しく動作するかのチェックが無く、動かなくなっていても気づかなそうという意図でした。

あるとしたら追加された想定外の文字が渡されたパターンと、あと_Proposedがpydanticの中で正しく動くか（＝__get_pydantic_core_schema__を通る経路が正しく動くか？）とかかなと思ってました。
後者は不要なのかも。

[qryxip]

なるほどです。であればさっき追加したテストで両方カバーできているかなと思いました。