Meta issue: better `getattr` support
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 20.6k
- Forks
- 3.3k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Feature
One thing that bothered me for a long time is getattr and its very broad return type even for simplest cases:
from typing import Literal
class Some:
def __init__(self) -> None:
self.a = 1
s = Some()
reveal_type(s.a) # Revealed type is "builtins.int"
reveal_type(getattr(s, 'a')) # Revealed type is "Any"
reveal_type(getattr(s, 'b')) # Revealed type is "Any"
reveal_type(getattr(s, 'a', None)) # Revealed type is "Union[Any, None]"
a: Literal['a']
reveal_type(getattr(s, a)) # Revealed type is "Any"
ab: Literal['a', 'b']
reveal_type(getattr(s, ab)) # Revealed type is "Any"
So, I propose to add better support for it to mypy.
The same example, after the support is added:
from typing import Literal
class Some:
def __init__(self) -> None:
self.a = 1
s = Some()
reveal_type(s.a) # Revealed type is "builtins.int"
reveal_type(getattr(s, 'a')) # Revealed type is "builtins.int"
reveal_type(getattr(s, 'b')) # error: "Some" has no attribute "b"
reveal_type(getattr(s, 'a', None)) # Revealed type is "builtins.int"
a: Literal['a']
reveal_type(getattr(s, a)) # Revealed type is "builtins.int"
ab: Literal['a', 'b']
reveal_type(getattr(s, ab)) # error: "Some" has no attribute "b"
reveal_type(getattr(s, ab, None)) # Revealed type is "builtins.int | None"
I have even written a custom plugin for it at some point.
Why?
This pattern is quite popular among Python developers. geattr(obj, 'string_key', None) is used for compatibility, optional dependencies, etc. That's something you can find in almost any project.
Technical details
I am going to utilize existing checkmember logic.
I even plan to support attribute plugins, where possible, because a.x and getattr(a, 'x') are semantically identical.
For now only str literals and Literal str types are going to be supported.
Related issues and problems
I am calling this issue "meta", because there are several very related problems I want to mention / solve here:
Next steps
I will start with a PR with a code prototype in a couple of days.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par lire la logique checkmember existante référencée dans l’issue et examinez les issues associées 1424 et 10409. Comparez les exemples getattr demandés, notamment les noms de type string et Literal ainsi que les valeurs par défaut, et utilisez les résultats reveal_type indiqués et les erreurs d’attribut manquant comme critères d’achèvement.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- devtools
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100