python / python/mypy

Add documentation for annotating descriptors

Aperta
#9,450 6 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation topic-descriptors
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Documentation

Based on the discussions in #2266 and #244, it seems MyPy supports annotations for descriptors, but there doesn't seem to be anything in the documentation about this or how to properly annotate them.

Annotating these isn't obvious, and some best practice for common usages would be helpful.

For example, one common paradigm for generic data descriptors is to return self when called from a class (instance is None), and I'm struggling to find the best way to annotate that.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo le discussioni #2266 e #244, quindi esamina la struttura esistente della documentazione per individuare la sezione di typing appropriata. Documenta come dovrebbero essere annotate le descrizioni, includendo l’uso comune dei descrittori di dati generici e il caso di accesso tramite la classe in cui il descrittore restituisce se stesso; il lavoro è completato quando questi pattern e le best practice sono chiaramente trattati.

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
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.