整理: TypeAdapter によるバリデーション・ダンプを共通化

[tarepan]

内容

概要: TypeAdapter によるバリデーション・ダンプを共通化してリファクタリング

現在の ENGINE では「外部由来の bytes/object ⇔ 内部向け構造体」の変換に TypeAdapter を利用している。各構造体向けにそれぞれ TypeAdapter インスタンスが作られ、メソッドを用いて変換（validation/dump）がおこなわれている。これにより安全な変換が可能になっている。
この変換時に TypeAdapter インスタンスを直接利用しているため、各モジュールは pydantic に依存している。本質的にここではバリデーションとダンプがしたいのであり、pydantic は実装詳細に過ぎない。また pydantic 以外のライブラリであってもいい。
幸いこれらの変換は内部向け構造体に依らず共通の処理をしている。ゆえに validate_x() / dump_x() のような関数を各構造体向けに生成しその内部で pydantic を利用すれば pydantic の影響範囲を小さく出来る。pydantic を差し替える際も生成関数 1 箇所に変更を加えるだけで済む。

このような背景から、TypeAdapter によるバリデーション・ダンプを共通化するリファクタリングを提案します。

関連 Issue

無し

[Hiroshiba]

ちょっとややこしくなっているなと感じました。
それプラス、若干早すぎる一般化に思えるかもで、そのままでも良いのかもと感じました。

なにか先の見通しがあっての変更であればお聞きしたみ。

追記：あるいは名前のややこしさが解消したらそれでも

[Hiroshiba]

１回で良い処理を２回やってるかもです。
あとちょっと名前もややこしいかも。

[tarepan]

名前のややこしさ

Before/After が以下のようになっています：

# Before
_env_adapter = TypeAdapter(Envs)
args = _cli_args_adapter.validate_python(args_dict)

# After
_validate_obj_as_envs = generate_obj_validator(Envs)
args = _validate_obj_as_cli_args(args_dict)

_python が「Pythonの…何？」となりそうであったためオブジェクト（obj）へ変更し、他は既存の名称をなぞるように命名しています。
どの辺がややこしく感じるでしょうか？（あるいは元からややこしい名前という話？）

[Hiroshiba]

元もややこしいとは思います。

_dump_save_format_dict_as_bytes辺りが動詞２回続いてややこしくなってそうだなと。

TypeAdapterをラップするクラスを作り、dump_jsonやdump_bytesやvalidate_objなどをメソッドとして実装するとかすればややこしさは軽減できると思います。
同じTypeAdapterを２回作ってる部分も削減できるかもです。（処理速度的に気にしてませんが）
目的と合ってるか微妙かもですが･･･。

わりと元のままでも良いなら、元のままにしておきつつ別のとこに時間割くのもありかもです。

[tarepan]

_dump_save_format_dict_as_bytes辺りが動詞２回続いてややこしくなってそう

👍️
妥当な指摘です。

TypeAdapterをラップするクラスを作り

クラスの方が見通しが良い、という視点が新鮮でした。たしかにメソッド名は単純になりそうです。

元のままにしておきつつ別のとこに時間割くのもありかも

👍️
将来 pydantic の利用範囲を極小化したくなった場合に re-open できればと思います。
本 PR は NoGo につき close します。