Clarify `warnings.deprecated` public API
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Documentation
The current docs only specify that it sets the __deprecated__ attribute on the deprecated item.
Pydantic relies on its full API: the fact that it’s a class, and that its instances have all passed parameters in attributes: deprecated(**kw).__dict__ == kw basically.
Two questions:
- Is that safe or might
deprecatedget e.g. refactored into a function at some point? - Can we subclass it and add parameters? Will type checkers understand this and still mark a
@our_deprecated_subclass(...) def ...as deprecated? See https://github.com/python/typing/issues/2256
maybe related to #138165
Linked PRs
- gh-153879
- gh-154487
- gh-154488
- gh-154489
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 la documentation actuelle de warnings.deprecated, puis lisez les PRs liés 153879, 154487, 154488 et 154489 ainsi que l’issue associée 138165. Le travail est terminé lorsque la classe publique, les attributs d’instance, le comportement des sous-classes et les attentes des vérificateurs de types sont documentés, ou lorsque les réponses convenues sont consignées.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100