marshmallow-code/marshmallow

Type hinting for `load` is too strict

Open

#1,457 创建于 2019年11月12日

在 GitHub 查看
 (12 评论) (0 反应) (0 负责人)Python (6,787 star) (640 fork)batch import
help wantedtyping

描述

The type hinting for load's data argument is set to typing.Mapping which makes sense for the many=False case, but for many=True case the type of data is list, which isn't a Mapping type.

贡献者指南

技术栈
python
领域
backendapi
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
understanding of Python type hints
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
The issue is about the type hint for the `data` argument of the `load` method in marshmallow. The current hint uses `typing.Mapping`, which is incorrect when `many=True` since `data` is a list. Look at the `load` method definition in the source code (likely in `marshmallow/schema.py`) and consider using `typing.Union[Mapping, list]` or overloaded signatures. The discussion in the comments may provide further context on the preferred approach.