`ElementTree.parse` type hinted to return unusable generic types
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ả
Bug Report
Since upgrading to mypy 1.15+, using ElementTree has become increasingly difficult. Likely due to https://github.com/python/typeshed/pull/13349. I'm not sure if this extra strictness is expected or if I'm just holding it wrong.
One example is the ElementTree.parse function that now returns a generic ET.ElementTree[ET.Element[str]], which is no longer compatible with basic type signatures like ET.ElementTree, which is interpreted as ElementTree[Element[str] | None].
This adds many challenges that make it difficult to work with.
- The generic argument here is very difficult to understand what it means and is lacking documentation. From what i've been able to deduce it's possible that the root node is of a different Element type or that the root node is None. While perhaps a valid scenario, it adds a big uphill to learning and usability.
- If one were to use these generic types, typing out
ET.ElementTree[ET.Element[str]]is a lot more verbose thanET.ElementTree, and i'm questioning if the strictness here is worth it. - If one tries to type hint the code with these generics. Python throws errors that
'ElementTree.Element' is not subscriptable. One workaround i found for this is to surround the type hints with double-quotes.
To Reproduce
import xml.etree.ElementTree as ET
def process_document(doc: ET.ElementTree) -> None:
pass
def process_document2(doc: ET.ElementTree[ET.Element[str]]) -> None: # TypeError: type 'xml.etree.ElementTree.Element' is not subscriptable
pass
process_document(ET.parse("foo.xml")) # mypy error: Argument 1 to "process_document" has incompatible type "ElementTree[Element[str]]"; expected "ElementTree[Element[str] | None]" [arg-type]
process_document2(ET.parse("foo.xml"))
Run with mypy --strict
Expected Behavior
ET.parse returns types assignable to ET.ElementTree
Actual Behavior
Mypy returns errror
# mypy error: Argument 1 to "process_document" has incompatible type "ElementTree[Element[str]]"; expected "ElementTree[Element[str] | None]" [arg-type]
Workarounds
- Use
ET.ElementTree().parse()function instead ofET.parse(), it returns the root-node as a type that can be assigned toET.Elementwithout any generic arguments.
This is actually a pretty decent option, if this is considered to be the primary way of using ElementTree from now on, the documentation should reflect that, right now it's suggestingET.parse() - Type out the complete
"ElementTree[Element[str] | None]"wrapped with double-quotes.
Your Environment
- Mypy version used:
- Mypy command-line flags:
- Mypy configuration options from
mypy.ini(and other config files): - Python version used:
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 đọc typeshed PR 13349 và các annotation cho ElementTree.parse, sau đó so sánh chúng với workaround ElementTree().parse() và tài liệu Python ElementTree. Được xem là hoàn tất khi hành vi generic dự kiến và khả năng gán được mong đợi của ET.parse() đã được xác lập, đồng thời vấn đề typing hoặc tài liệu liên quan đã được xử lý.
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
- devtools
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100