Clarify `warnings.deprecated` public API
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der aktuellen Dokumentation zu warnings.deprecated und lies anschließend die verlinkten PRs 153879, 154487, 154488 und 154489 zusammen mit dem zugehörigen issue 138165. Als abgeschlossen gilt die Dokumentation der öffentlichen Klasse, der Instanzattribute, des Verhaltens bei Vererbung und der Erwartungen von Type-Checkern oder das Festhalten der vereinbarten Antworten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100