python / python/mypy

warn when default values on overloads differ from implementation signature

Ouverte
#11,397 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

from typing import overload


@overload
def foo(value1: str, value2: bool = False) -> str: # this default value is wrong/useless
    ...


@overload
def foo(value1: int, value2: bool = False) -> int: # this default value is wrong/useless
    ...


def foo(value1: str | int, value2: bool = True) -> str | int:
    ...

in fact, maybe even prohibit defaults on overload signatures entirely, like in typescript:

function foo(value1: number, value2: boolean = false): number //error: A parameter initializer is only allowed in a function or constructor implementation.
function foo(value1: string, value2: boolean = false): string //error: A parameter initializer is only allowed in a function or constructor implementation.
function foo(value1: number | string, value2: boolean = true): number | string {
    return 1
}

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 par reproduire l’exemple d’overload et suivez la vérification des signatures d’overload de mypy. Déterminez si le comportement accepté doit être un avertissement pour les defaults qui diffèrent de l’implémentation ou une erreur pour tout default dans les overloads. La tâche est terminée lorsque la règle choisie est appliquée de manière cohérente et couverte par des tests de régression.

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

Évaluation

Stack technique
python
Domaine
tooling
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.