FIX: AudioQueryの互換性の問題を修正

[sabonerune]

内容

AudioQueryに追加されたpauseLengthScaleが必須になっているため過去のクエリを保存していたり古いOpenAPIに基づいて生成したクライアントがモデル内で宣言していないキーを削除していた場合互換性の問題が発生します。

pauseLengthScaleにデフォルト値を設定することで互換性を維持します。

関連 Issue

• fix: AudioQueryのpauseLengthScaleにデフォルト値を設定する #1424

その他

とりあえずエディタで動作することは確認しました。
一応テストも通ったので問題はないと思いますがこの辺りの変更に詳しくないので確認不足があるかもしれません。

また、テストも追加するべきかもしれません。

[Hiroshiba]

LGTM！！

ありがとうございます、助かります！！ 🙇
別のタスクがつかえてしまうので急ぎめでマージします！

[Hiroshiba]

ついでにすみません！！

SkipJsonSchema[None]って、Noneが受け入れ不可なように見えるんでしたっけ。
だとしたらこの値はNoneの受入が可能（Noneに意味がある）ので、SkipJsonSchema外さないとかもです。

もしそうっぽかったら別PRで･･･！

[sabonerune]

SkipJsonSchema[None]を付けるとJsonのnullが受け入れ不可能に見えるという感じです。
また、Fieldにデフォルト値が設定されている場合はオプショナルになります。

なのでスキーマー上はキーが存在しないか数値であるが正しい挙動になります。
(実際の挙動はnullを受け入れnullを出す)

このままでも問題ないような気がしますがモデルにSkipJsonSchema[None]を付けて回ったのは今までのスキーマーを破壊しないためなので0.20の新機能であるキーにSkipJsonSchema[None]は付ける必要は無さそうですね…

[Hiroshiba]

なるほどです！！

たぶんpauseLengthのSkipJsonSchema[None]は外した方が良さそうですね！！
プルリク出そうと思います！

pauseLengthScaleの方にSkipJsonSchema[None]をつける手もありそうだけど、こっちはつけない方がいいかなぁ･･･。
難しいですね。。

[tarepan]

SkipJsonSchema[None]を付けるとJsonのnullが受け入れ不可能に見える ...
...
(実際の挙動はnullを受け入れ ...

の検証コードを書きました。
結論として @sabonerune さんの仰る通りで間違いないです👍️

import json

from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import BaseModel, Field
from pydantic.json_schema import SkipJsonSchema

app = FastAPI()


class Container(BaseModel):
    attr_required: int
    attr_optional: int | SkipJsonSchema[None] = Field(default=None)


@app.post("/container")
def post_container(container: Container) -> None:
    print(f"recieved: {container}")
    return None


client = TestClient(app)

res_post_1 = client.post("/container", json={"attr_required": 11, "attr_optional": 12}).json()
# recieved: attr_required=11 attr_optional=12
print(res_post_1)
# None

res_post_2 = client.post("/container", json={"attr_required": 11}).json()
# recieved: attr_required=11 attr_optional=None
print(res_post_2)
# None

res_post_3 = client.post("/container", json={"attr_required": 11, "attr_optional": None}).json()
# recieved: attr_required=11 attr_optional=None
print(res_post_3)
# None