DiamondLightSource / DiamondLightSource/python-copier-template

Decide on a pydantic v3 BaseModel tagged union method and document it here

未关闭
#316 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Jinja
星标
25
派生
10
平均合并
4 小时 4 分钟
30 天内合并 PR
6

描述

At the moment we have multiple ways of using pydantic and tagged unions:
- `scanspec` using pydantic dataclasses and a decorator to make a tagged union of subclasses, it requires positional args
- `FastCS` using plain dataclasses and a pydantic BaseModel creation function to do serialization and deserialization
- `pvi` uses an explicitly created union of BaseModels
- `ibek` uses automatically created Entity BaseModels from EntityModel instances
- `blueapi` does something with BaseModels too, but I can't remember what

With the advent of pydantic v3, now would be a good time to look at investigating a common approach for all these usecases. Standardising on BaseModel instances would probably give us the most tool support for things like documenting models in sphinx, FastAPI and GraphQL support, and downstream serialization

@GDYendell @gilesknap @DiamondJoseph @tpoliaw @abbiemery FYI

@hyperrealist I'm hoping you'll take this on at some point in the new year

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。