Clarify `warnings.deprecated` public API

Descrizione

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 deprecated get 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

Come iniziare

Leggi tutta la issue e poi la guida ai contributi del progetto.

Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.

Fai un fork del repository e lavora su un branch.

Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla documentazione attuale di warnings.deprecated, quindi leggi i PR collegati 153879, 154487, 154488 e 154489 insieme alla issue correlata 138165. Il lavoro è completato quando sono documentati la classe pubblica, gli attributi di istanza, il comportamento delle sottoclassi e le aspettative dei type checker, oppure quando vengono registrate le risposte concordate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico

python

Ambito

documentation

Tipo di issue

Documentazione

Difficoltà

4/5

Tempo stimato

3-5 giorni

Stato di attività

Ferma

Chiarezza

Da chiarire

Idoneità per principianti

25/100