Skip to content
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

[regression] no type checking beyond perceived isinstance guard failure #18329

Open
yonilerner opened this issue Dec 23, 2024 · 3 comments
Open
Labels
bug mypy got something wrong topic-reachability Detecting unreachable code topic-usability

Comments

@yonilerner
Copy link

yonilerner commented Dec 23, 2024

Bug Report

Starting in mypy 1.5.0 (at least when testing in versions available in playground), there are situations where an isinstance type guard that returns False will cause type checking to stop in the false branch. The examples below check correctly in 1.4.1 in the playground.

To Reproduce
Heres a pretty dumb example

x: str
assert isinstance(x, int)
y: str = 1 # expected error here, got none

Gist
Playground

Another example:

from typing import Optional

class Foo:
    x: Optional[str]
    
assert isinstance(Foo.x, int)
Foo.x.y.z = 1 # expected error here

These examples are lame, but there are legitimate use cases for this to work. For example, we use metaclasses to transform these type annotations on fields into class attributes that have underlying data. So a more real example in my use case (that cant be reproduced in a playground), would be:

class Foo(Model):
	x: Optional[int] = field(max_length=1)

assert isinstance(Foo.x, StringField) # under the hood, we transform `Foo.x` into a `StringField` because of the annotation
assert Foo.x.max_lengt == 1 # expectd failures since max_lengt is a typo

Note that this behavior is mostly the same with if isinstance...: (and then the rest of the code within the block fails to check), though it seemed that some of those examples were also broken in 1.4.1, which is different than when using assert.

Expected Behavior
I would expect mypy to correctly type check even if it thinks an assert isinstance or if isinstance would result in the rest of the code being unreachable.

Note that I do not want to use warn-unreachable here because that would not actually solve the underlying problem, it would just give me extra warnings and still not actually let me write the isinstance checks that I want.

Actual Behavior
Mypy appears to give up type checking entirely - and silently - if it thinks that the rest of the code is unreachable.

Your Environment
My environment for all the examples is mypy playground

@yonilerner yonilerner added the bug mypy got something wrong label Dec 23, 2024
@hauntsaninja
Copy link
Collaborator

This is from #15386

One workaround for now is to gate the asserts under if not typing.TYPE_CHECKING:

@yonilerner
Copy link
Author

yonilerner commented Dec 24, 2024

Thanks for the pointer! Do you know if there are any plans to change this behavior?

While I appreciate you pointing out this workaround, the issue is more that if anyone in our codebase has not read this discussion and is not aware of this workaround - or even why you would need it - they are at risk for writing a seemingly harmless (and in our codebase, totally reasonable) line of code that disables type checking and potentially allows many bugs.

I'm not aiming this point at you directly, I just wanted to make sure that it's acknowledged that a workaround in this case doesn't actually help, since the core issue is that you don't even know you need a workaround because of the silent failure.

@hauntsaninja
Copy link
Collaborator

  • I think in general mypy swallowing errors in "unreachable" code (both at module and function level) is often surprising. So I would be in favour of PRs that explored relaxing that — hopefully doing so is feasible and doesn't introduce too many false positives.
  • It could also be nice if --warn-unreachable was part of --strict. There have been some PRs that improve --warn-unreachable false positives recently, so maybe this could happen, which would make issues here not silent.
  • Genuinely unreachable code at module level is rare, so I personally am fine with type checking unreachable module level code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug mypy got something wrong topic-reachability Detecting unreachable code topic-usability
Projects
None yet
Development

No branches or pull requests

3 participants