Unify typing for `__path__`?
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 5.1k
- Fork
- 2.1k
- Merge trung bình
- 1 ngày 19 giờ
- Pull request đã merge (30 ngày)
- 82
Mô tả
After the last mypy update v0.920, I started to notice an inconsistency with how the module variable __path__ is typed mainly across typeshed, mypy, and pyright.
| Type | Link | |
|---|---|---|
typeshed - ModuleType |
MutableSequence[str] |
https://github.com/python/typeshed/pull/6200 |
typeshed - pkgutil.extend_path |
list[str] |
https://github.com/python/typeshed/pull/5222 |
| mypy | list[str] |
https://github.com/python/mypy/pull/9454 |
| pyright | Iterable[str] |
https://github.com/microsoft/pylance-release/issues/1098 |
In the Python docs it's mentioned as:
`__path__` must be an iterable of strings, but it may be empty.
However the docs for pkgutil.extend_path go on say it's mostly a list (?) cpython/pkgutil.py
If the input path is not a list (as is the case for frozen
packages) it is returned unchanged. The input path is not
modified; an extended copy is returned. Items are only appended
to the copy at the end.
From my point of view, it isn't entirely clear what the "correct" type should be. Some points to consider though:
- In most cases it seems to be a
list[str]. - It was mentioned here however that it can sometimes also be a
MutableSequence[str] - The
__path__type should be valid as first argument topkgutil.extend_path. At the moment that only applies tolist[str]but obviously the argument type forextend_pathcould be changed to, for example, accept a TypeVar bound toIterable[str]instead. - It seems to be fairly common (and safe ?) to access the at least the first item of
__path__via__getitem__.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách so sánh các chú thích của typeshed ModuleType và pkgutil.extend_path với tài liệu về đường dẫn mô-đun của Python và pkgutil, sau đó xem lại các thảo luận được liên kết của mypy và pyright. Xác định một hợp đồng kiểu nhất quán phản ánh hành vi được ghi chép và quan sát được. Được xem là hoàn tất khi các chú thích liên quan nhất quán giữa các stub bị ảnh hưởng và vẫn tương thích với extend_path.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- tooling
- Loại issue
- Tái cấu trúc
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 20/100