python / python/typeshed

Inconsistent dataclass declaration

Ouverte
#13,189 0 commentaires 0 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

The dataclass decorator in the typeshed package has an inconsistency in its overloads. Specifically, when cls is passed explicitly as None, it is unclear whether additional arguments (e.g., init, repr, etc.) should be allowed or not. The current implementation allows passing cls=None alongside additional arguments, but this usage is not explicitly documented or validated.

Expected Behavior

The overloads should clearly define and document the behavior of cls=None when additional arguments are provided:

If allowed, the typing should reflect that explicitly.
If not allowed, the implementation should prevent or warn against such usage.

Current Behavior

Passing cls=None with arguments like kw_only=True is allowed, but this behavior is not described in the overloads. For example:

decorator = dataclass(None, kw_only=True)
@decorator
class MyClass:
    x: int

The above works but is ambiguous in terms of type checking and intended usage.

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 surcharges du décorateur dataclass dans le package typeshed et comparez-les avec l’exemple montré dataclass(None, kw_only=True). Déterminez si cls=None avec des arguments supplémentaires est pris en charge, puis faites en sorte que les surcharges et la documentation expriment cette décision de manière cohérente. C’est terminé lorsque le comportement est dépourvu d’ambiguïté pour les vérificateurs de types et les utilisateurs.

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

Évaluation

Stack technique
python
Domaine
devtools
Type d'issue
Bug
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
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.