Decide on a pydantic v3 BaseModel tagged union method and document it here
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先比较 scanspec、FastCS、pvi、ibek 和 blueapi 所采用的 tagged-union 方法，同时考虑 pydantic v3 中提议的更改。当各项目就通用的 BaseModel 方法达成一致，并且该方法（包括相关权衡）已记录在此处时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
At the moment we have multiple ways of using pydantic and tagged unions:
scanspecusing pydantic dataclasses and a decorator to make a tagged union of subclasses, it requires positional argsFastCSusing plain dataclasses and a pydantic BaseModel creation function to do serialization and deserializationpviuses an explicitly created union of BaseModelsibekuses automatically created Entity BaseModels from EntityModel instancesblueapidoes 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
- 主要语言
- Jinja
- 星标
- 25
- 派生
- 10
- 平均合并
- 4 天 17 小时
- 30 天内合并 PR
- 7
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
DiamondLightSource/python-copier-template 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 1/5 1 小时以内 新手友好度 68/100
-
documentation good first issue
难度 1/5 1 小时以内 新手友好度 70/100
-
难度 2/5 1-3 小时 新手友好度 68/100
查看 DiamondLightSource/python-copier-template 的全部 Issue
相似的 Issue
-
area:release bug
难度 2/5 1-3 小时 新手友好度 86/100
registrystack/registry-stack#1874 ·
维护者通常 1 天内回复
-
namespace operations
难度 2/5 1-3 小时 新手友好度 72/100
EclipseFdn/open-vsx.org#13702 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 72/100
material-extensions/vscode-material-icon-theme#3610 ·
维护者通常 2 天内回复
-
deltareview treats a line-range citation as an unknown path, firing the delta-review pass spuriously未关闭agent-butler-finding bug
难度 2/5 1-3 小时 新手友好度 88/100
jordansmall/spindrift#4366 ·
维护者通常 1 天内回复