huggingface/datasets

Consider using "Sequence" instead of "List"

Open

#5,354 创建于 2022年12月12日

在 GitHub 查看
 (18 评论) (0 反应) (1 负责人)Python (18,313 star) (2,496 fork)batch import
enhancementgood first issue

描述

Feature request

Hi, please consider using Sequence type annotation instead of List in function arguments such as in Dataset.from_parquet(). It leads to type checking errors, see below.

How to reproduce

list_of_filenames = ["foo.parquet", "bar.parquet"]
ds = Dataset.from_parquet(list_of_filenames)

Expected mypy output:

Success: no issues found

Actual mypy output:

test.py:19: error: Argument 1 to "from_parquet" of "Dataset" has incompatible type "List[str]"; expected "Union[Union[str, bytes, PathLike[Any]], List[Union[str, bytes, PathLike[Any]]]]"  [arg-type]
test.py:19: note: "List" is invariant -- see https://mypy.readthedocs.io/en/stable/common_issues.html#variance
test.py:19: note: Consider using "Sequence" instead, which is covariant

Env: mypy 0.991, Python 3.10.0, datasets 2.7.1

贡献者指南

技术栈
python
领域
backenddeveloper experience
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
blocked
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python type hintsmypy basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
This issue suggests changing the type annotation of the `from parquet` method's argument from `List` to `Sequence` to fix a mypy error. The specific file is `src/datasets/arrow dataset.py` around line 1088. The change involves importing `Sequence` from `typing` and updating the type hint. However, the issue has an assignee, so it is likely already being worked on; consider asking for clarification or checking for a linked PR before starting.