python / mypy

Optional static typing for Python
https://www.mypy-lang.org/
Other
18.37k stars 2.82k forks source link

Disable comparison overlap checks in assert statements #17896

Open JukkaL opened 2 weeks ago

JukkaL commented 2 weeks ago

Feature

In assert statements, allow comparisons that don't appear to overlap. These are common in test cases, and tend to generate false positives.

One way to implement this would be to filter out errors with the comparison-overlap error code in assert statements.

A potentially better way would be to not narrow down types in comparisons in assert statements, but this could be too complicated and ad hoc.

Example where we have a false positive:

# mypy: strict-equality
from enum import Enum

class MyEnum(Enum):
    X = 1
    Y = 2

class MyClass:
    attr: MyEnum = MyEnum.X

    def mutate(self) -> None:
        self.attr = MyEnum.Y

def test_foo() -> None:
    a = MyClass()
    assert a.attr == MyEnum.X
    a.mutate()
    assert a.attr == MyEnum.Y  # Error: Non-overlapping equality check

Pitch

These errors are often false positives, and they are somewhat frequent in test cases. The fix seems simple.

Hints

Here is an example of filtering errors adapted from mypy/plugins/default.py:

            with self.msg.filter_errors(
                filter_errors=lambda name, info: info.code != codes.TYPEDDICT_READONLY_MUTATED,
                save_filtered_errors=True,
            ):
Kaven668 commented 2 weeks ago

Could I be assigned this?

JelleZijlstra commented 2 weeks ago

Feel free to send a PR if you're interested in working on this!

Avasam commented 2 weeks ago

Even in non-test code, a redundant assert can get optimized out anyway. And in non-optimized mode, it's almost certainly a quick sanity check. So I'm in favor of such a change for less false-positives.

hauntsaninja commented 2 weeks ago

Wonder if there's anything we can do about the reachability implications, since mypy will currently just not check any subsequent code in the example given. And if you do happen to have --warn-unreachable on, you'll get a similar error (granted it doesn't get used that much since it's not currently part of --strict)