Proposal: Add coerced type narrowing similar to 'cast'
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 1.8k
- Fork
- 302
- Merge trung bình
- 23 giờ
- Pull request đã merge (30 ngày)
- 8
Mô tả
My suggestion is to add a way to coerce type narrowing without any runtime change,
by adding new type_assert and/or ensure_type.
def function(arg: Any):
type_assert isinstance(arg, int)
reveal_type(arg) # Revealed type: "builtins.int"
def function(arg: Any):
ensure_type(arg, int)
reveal_type(arg) # Revealed type: "builtins.int"
These functions do nothing at runtime! they only help with the types.
Why not cast(int, arg)?
-
castcompletely replaces the type and we need to write a full new type.
With type narrowing it's only necessary to limit the options of the existing type.def function(arg: Union[int, str, list]): arg = cast(Union[str, list], arg) reveal_type(arg) # Revealed type: "str | list"def function(arg: Union[int, str, list]): type_assert not isinstance(arg, int) # only need to remove 'int' reveal_type(arg) # Revealed type: "str | list" -
castis more dangerous because we ignore the previous type. with narrowing we just limit the options of the previous type.def function(arg: Union[int, str, list]): arg1 = cast(dict, arg) reveal_type(arg1) # Revealed type: "dict"def function(arg: Union[int, str, list]): type_assert not isinstance(arg, dict) # Error: Subclass of "int" and "dict[Any, Any]" cannot existdef function(arg: Union[int, str, list]): type_assert not isinstance(arg, int) type_assert not isinstance(arg, str) type_assert not isinstance(arg, list) reveal_type(arg) # Error: Statement is unreachable -
castcan't doIntersection(yet). explained below.
Why type_assert and not a normal assert?
assertmakes it slower at runtime, and sometimes we careassertcan break things when improving types of an old code base
The downsides:
- Without
assertor if-else conditions at runtime, the coerced narrowing ignores the real type and is dangerous, almost likecast.
With Intersection type
Until we have Intersection type, this kind of things are problematic:
class Animal:
def say_my_name(self) -> None:
print("My name is Animal")
@runtime_checkable
class CanFlyProtocol(Protocol):
def fly(self) -> None: ...
class Bird(Animal, CanFlyProtocol):
def fly(self) -> None:
print("Fly")
def let_it_fly(animal: Animal): # we can't restrict the argument type to be Animal AND CanFlyProtocol
animal.say_my_name()
animal.fly() # Error: "Animal" has no attribute "fly"
Even cast can't help us, but we can narrow the type!
def let_it_fly(animal: Animal):
assert isinstance(animal, CanFlyProtocol)
animal.say_my_name()
animal.fly()
reveal_type(animal) # Revealed type: "<subclass of "Animal" and "CanFlyProtocol">"
Type checkers can understand Intersection when we narrow the type, great!
But what if we don't want to change runtime behavior? for this we can
replace assert with the suggested type_assert or ensure_type!
def let_it_fly(animal: Animal):
type_assert isinstance(animal, CanFlyProtocol)
animal.say_my_name()
animal.fly()
reveal_type(animal) # Revealed type: "<subclass of "Animal" and "CanFlyProtocol">"
A side note: with
type_assertwe probably can stop adding@runtime_checkableto Protocols, if we only added it for this kind of type-hint only issues thatassert isinstance(animal, CanFlyProtocol)solved.
Performingisinstancewith Protocol is very slow so this benefit is not small.
ensure_type with Not
See:
def function(arg: Union[int, str, list]):
type_assert not isinstance(arg, int)
reveal_type(arg) # Revealed type: "str | list"
How to do not isinstance with ensure_type? we have two options:
-
Add a similar
ensure_not_typedef function(arg: Union[int, str, list]): ensure_not_type(arg, int) reveal_type(arg) # Revealed type: "str | list" -
Wait for the
Not[]typedef function(arg: Union[int, str, list]): ensure_type(arg, Not[int]) reveal_type(arg) # Revealed type: "str | list"
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
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
Issue không nêu tên tệp, test hay các điểm bắt đầu của việc triển khai. Hãy bắt đầu bằng việc xem xét các dạng type_assert và ensure_type được đề xuất cùng các cuộc thảo luận liên quan về Intersection và Not; xác định ngữ nghĩa được hỗ trợ, hành vi khi chạy và các kiểm thử nghiệm thu trước khi triển khai.
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
- Tính năng
- Độ 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
- 25/100