Skip to content

Narrow is with final types correctly #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions mypy/subtypes.py
Original file line number Diff line number Diff line change
Expand Up @@ -1959,6 +1959,16 @@ def covers_at_runtime(item: Type, supertype: Type) -> bool:
item = get_proper_type(item)
supertype = get_proper_type(supertype)

# Left `Any` or `Type[Any]` type will never be covered at runtime:
if isinstance(item, AnyType) or (
isinstance(item, TypeType) and isinstance(item.item, AnyType)
):
return False
Comment on lines +1962 to +1966

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This block prevents Any or Type[Any] from being covered at runtime. Is this the desired behavior? Should there be a comment explaining why this is necessary?

Suggested change
# Left `Any` or `Type[Any]` type will never be covered at runtime:
if isinstance(item, AnyType) or (
isinstance(item, TypeType) and isinstance(item.item, AnyType)
):
return False
# Left `Any` or `Type[Any]` type will never be covered at runtime:
# This is because runtime type checks will not be able to infer
# the underlying type of `Any` or `Type[Any]`.
if isinstance(item, AnyType) or (
isinstance(item, TypeType) and isinstance(item.item, AnyType)
):


if isinstance(item, (CallableType, TypeType)) and item.is_singleton_type():
if is_proper_subtype(item, supertype):
return True
Comment on lines +1968 to +1970

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This condition checks if the item is a singleton type and a proper subtype of the supertype. Can you add a comment explaining what a singleton type is in this context, and why this check is needed?

Suggested change
if isinstance(item, (CallableType, TypeType)) and item.is_singleton_type():
if is_proper_subtype(item, supertype):
return True
# Check if the item is a singleton type (e.g., `None`, final classes)
# and a proper subtype of the supertype.
if isinstance(item, (CallableType, TypeType)) and item.is_singleton_type():
if is_proper_subtype(item, supertype):


# Since runtime type checks will ignore type arguments, erase the types.
supertype = erase_type(supertype)
if is_proper_subtype(
Expand Down
8 changes: 8 additions & 0 deletions mypy/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -2167,6 +2167,9 @@ def with_unpacked_kwargs(self) -> NormalizedCallableType:
)
)

def is_singleton_type(self) -> bool:
return self.is_type_obj() and self.type_object().is_final

def with_normalized_var_args(self) -> Self:
var_arg = self.var_arg()
if not var_arg or not isinstance(var_arg.typ, UnpackType):
Expand Down Expand Up @@ -3111,6 +3114,11 @@ def __eq__(self, other: object) -> bool:
return NotImplemented
return self.item == other.item

def is_singleton_type(self) -> bool:
return (isinstance(self.item, Instance) and self.item.type.is_final) or isinstance(
self.item, NoneType
)
Comment on lines +3117 to +3120

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This function determines if a TypeType is a singleton type. Why is NoneType considered a singleton type here?

Suggested change
def is_singleton_type(self) -> bool:
return (isinstance(self.item, Instance) and self.item.type.is_final) or isinstance(
self.item, NoneType
)
def is_singleton_type(self) -> bool:
# A TypeType is a singleton type if its item is a final instance or None.
return (isinstance(self.item, Instance) and self.item.type.is_final) or isinstance(
self.item, NoneType
)


def serialize(self) -> JsonDict:
return {".class": "TypeType", "item": self.item.serialize()}

Expand Down
95 changes: 95 additions & 0 deletions test-data/unit/check-narrowing.test
Original file line number Diff line number Diff line change
Expand Up @@ -1374,7 +1374,102 @@ def g() -> None:
foo()
[builtins fixtures/dict.pyi]

[case testNarrowingIsFinalType]
from typing import Type, Union
from typing_extensions import final

@final
class Mark: ...

@final
class Other: ...

x: Union[Type[Mark], Type[Other], Type[None], int]

if x is Mark:
reveal_type(x) # N: Revealed type is "Type[__main__.Mark]"
else:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Other], Type[None], builtins.int]"

if x is not Mark:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Other], Type[None], builtins.int]"
else:
reveal_type(x) # N: Revealed type is "Type[__main__.Mark]"

y: Type[Mark] = Mark
if x is y:
reveal_type(x) # N: Revealed type is "Type[__main__.Mark]"
else:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Other], Type[None], builtins.int]"

if x is not y:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Other], Type[None], builtins.int]"
else:
reveal_type(x) # N: Revealed type is "Type[__main__.Mark]"

if x is type(None):
reveal_type(x) # N: Revealed type is "Type[None]"
else:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Mark], Type[__main__.Other], builtins.int]"

if x is not type(None):
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Mark], Type[__main__.Other], builtins.int]"
else:
reveal_type(x) # N: Revealed type is "Type[None]"

z: Type[None]
if x is z:
reveal_type(x) # N: Revealed type is "Type[None]"
else:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Mark], Type[__main__.Other], builtins.int]"

if x is not z:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Mark], Type[__main__.Other], builtins.int]"
else:
reveal_type(x) # N: Revealed type is "Type[None]"
[builtins fixtures/isinstancelist.pyi]


[case testNarrowingAnyAgainstFinalType]
from typing import Type, Any
from typing_extensions import final

@final
class Mark: ...

x: Any
if x is Mark:
reveal_type(x) # N: Revealed type is "def () -> __main__.Mark"
else:
reveal_type(x) # N: Revealed type is "Any"
Comment on lines +1441 to +1444

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The revealed type here is def () -> __main__.Mark. Is this the intended behavior when x is Any and compared to a final class? Should it be Mark instead?

if x is Mark:
    reveal_type(x)  # N: Revealed type is "__main__.Mark"
else:
    reveal_type(x)  # N: Revealed type is "Any"


y: Type[Any]
if y is Mark:
reveal_type(y) # N: Revealed type is "Type[__main__.Mark]"
else:
reveal_type(y) # N: Revealed type is "Type[Any]"

[builtins fixtures/isinstancelist.pyi]


[case testNarrowingIsNonFinalType]
from typing import Type, Union

class Mark: ...

x: Union[Type[Mark], Type[None], int]

if x is Mark:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Mark], Type[None], builtins.int]"
else:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Mark], Type[None], builtins.int]"

y: Type[Mark] = Mark
if x is y:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Mark], Type[None], builtins.int]"
else:
reveal_type(x) # N: Revealed type is "Union[Type[__main__.Mark], Type[None], builtins.int]"
[builtins fixtures/isinstancelist.pyi]
[case testNarrowingOptionalEqualsNone]
from typing import Optional

Expand Down