python / python/mypy

Report protocol problems in no_variant_matches_arguments if possible

Ouverte
#17,092 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

feature
Langage dominant
Python
Étoiles
20.6k
Forks
3.3k
Métriques de merge des PR
Métriques de PR en attente

Description

Feature

Report protocol problems in no_variant_matches_arguments if possible.

Pitch

Given following example:

from typing import Protocol, overload


class Foo(Protocol):
    def some_method(self, value: int = 0) -> None: ...


class Bar:
    def some_method(self, value: int) -> None:
        pass


@overload
def accept_foo(value: Foo, v: int) -> None:
    pass


@overload
def accept_foo(value: Foo, v: float) -> None:
    pass


def accept_foo(value: Foo, v: int | float) -> None:
    pass


accept_foo(Bar(), 1)

The Bar has conflict with the Protocol Foo, but currently Mypy won't report the protocol problems. This is the current error report:

protocol_example.py:27: error: No overload variant of "accept_foo" matches argument types "Bar", "int"  [call-overload]
protocol_example.py:27: note: Possible overload variants:
protocol_example.py:27: note:     def accept_foo(value: Foo, v: int) -> None
protocol_example.py:27: note:     def accept_foo(value: Foo, v: float) -> None
Found 1 error in 1 file (checked 1 source file)

If we can report the protocol problems in this case, it may save developers time to figure out what' wrong.

I did a proof-of-concept implementation here: https://github.com/python/mypy/commit/a2040d3680320afbac6e13b3b04593a7965242bc. This is the updated error report:

protocol_example.py:27: error: No overload variant of "accept_foo" matches argument types "Bar", "int"  [call-overload]
protocol_example.py:27: note: Following member(s) of "Bar" have conflicts:
protocol_example.py:27: note:     Expected:
protocol_example.py:27: note:         def some_method(self, value: int = ...) -> None
protocol_example.py:27: note:     Got:
protocol_example.py:27: note:         def some_method(self, value: int) -> None
protocol_example.py:27: note:     Expected:
protocol_example.py:27: note:         def some_method(self, value: int = ...) -> None
protocol_example.py:27: note:     Got:
protocol_example.py:27: note:         def some_method(self, value: int) -> None
protocol_example.py:27: note: Possible overload variants:
protocol_example.py:27: note:     def accept_foo(value: Foo, v: int) -> None
protocol_example.py:27: note:     def accept_foo(value: Foo, v: float) -> None
Found 1 error in 1 file (checked 1 source file)

If this is OK, I'd happy to refine the implementation and submit a PR.

Thanks.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez au point d'entrée no_variant_matches_arguments et examinez le commit de preuve de concept lié dans l'issue. Reproduisez l'exemple fourni de Protocol et overload, puis vérifiez que le diagnostic signale correctement les membres en conflit, sans sortie en double ni trompeuse.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
compilers, devtools
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.