Skip to content

Plugin interface for type narrowing on == comparisons #10708

Open
@freundTech

Description

@freundTech

Feature

I'm proposing a new plugin interface for type narrowing on == comparisons.

Pitch

Take the following code:

from enum import IntEnum

class MyIntEnum(IntEnum):
    A = 1
    B = 2

m: MyIntEnum

if m == 1:
    pass
else:
    reveal_type(m)

This should reveal MyIntEnum.B, but mypy can't know that because it has no idea about how the __eq__ method on MyIntEnum works.
A plugin interface together with a builtin plugin could fix that.

mypy would walk through the MyIntEnum MRO until it encounters a class that defines __eq__ and then look for a plugin able to handle this class.

The plugin matching the class will be called and can return two types. One narrowing for if the condition matches and one for if it doesn't.

This would also be useful for checking match statements (#10191). Currently I have to special case enums there, as match always compares emums with ==, while mypy only narrows types if enums are compared with is.

It would probably also make it possible to get rid of the special casing of a == type(A) and replace it with a plugin.

I would like to first hear some opinions about this before I start implementing it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featuretopic-pluginsThe plugin API and ideas for new plugins

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions