python / python/typeshed

Several methods on built-in types are too strict.

Ouverte
#15,271 4 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
5.1k
Forks
2.1k
Merge moyen
1 j 19 h
PR mergées (30 j)
82

Description

I have identified several methods on built-in types that are too strict and can cause annoying false positives:

  • set and frozenset methods (#15470, #15160)
  • dict.{get, pop} (#15471)
  • list.{count, index, remove} (#15472)
  • MutableSet.discard
  • Mapping.get
  • MutableMapping.pop
  • Sequence.{count, index}
  • MutableSequence.remove
  • probably some more.

It seems like the annotations for these were designed to help detect user errors. For instance, we know that .get on a dict[int, int] will always return the default as the types are incompatible, and so .get was restricted in typeshed to only accept the key type. However, this hurts, even in simple cases like using literals:

from typing import Mapping, Literal

def demo_get(
    d: Mapping[Literal["foo", "bar"], int],
    dynamic_key: str,
) -> None:
    # No overload variant of "get" of "Mapping" matches argument type "str"
    d.get(dynamic_key)  

def demo_sub(
    left: set[Literal["foo", "bar"]],
    right: set[str],
) -> None:
    # Unsupported operand types for - ("set[Literal['foo', 'bar']]" and "set[str]")
    left - right

I believe typeshed is trying to act as a linter here, which shouldn't be its job. Type-checkers and type-informed linters are better at this and can use more complex logic.

For example, in the set difference case set[A] - set[B], the proper test would be to check whether the types have a non-empty intersection or not. The same could be said for Mapping[K, V].get(K2).

Related Topics:

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 localiser les stubs typeshed pour les méthodes listées de dict, list, set, Mapping, Sequence et Mutable*, puis lisez les issues associées 8219, 9155 et 9004. Le périmètre n’est pas encore défini, car l’issue mentionne également d’autres méthodes probablement concernées ; la tâche ne pourra être considérée comme terminée qu’une fois qu’un ensemble convenu d’API affectées et des modifications cohérentes des annotations auront été définis.

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é
5/5
Temps estimé
Plus d'une semaine
Activité
Calme
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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