Type annotations for public API would be nice

Aperta
  • Qualcosa non va?
#798 0 commenti 3 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 7 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
Più di una settimana
Idoneità per principianti
22/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
api, tooling

Direzione di ricerca

The payload names no specific modules, so the public API surface must be identified first, for example by running Pyright's --verifytypes check the issue suggests to get a baseline of untyped symbols. Annotating those symbols and then adding an empty py.typed marker to the package is the intended change. Done means the chosen public API passes the type-completeness check and the marker ships with the package. The issue has no comments or maintainer decision on scope, so confirm the surface before starting.

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

Descrizione

Is your feature request related to a problem? Please describe.
Most of the project's public API lacks static type annotations and consequently there is also no py.typed marker that signals to library consumers that their usages of these APIs may be type checked.

Describe the solution you'd like
It would be nice if at least the public API of this project was fully statically typed and then a py.typed marker added so that dependent projects can check that their usages of this library are correct, get type-based IDE autocompletion etc.

Describe alternatives you've considered

  • Wait for a 3rd party to publish a type stubs package. But there already are some type hints in Rope's codebase, so I don't see the point.

Additional context

  • API docs as suggested in #796 would also greatly benefit from type annotations.
  • Pyright's --verifytypes option may be used to check if the public interface is in fact "type complete". Mypy might have something similar in the form of coverage reports.
Lingua principale
Python
Stelle
2.2k
Fork
197
Merge medio
2g 13h
PR unite (30g)
5

Preparare l'ambiente

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.

Altre issue di python-rope/rope

Tutte le issue di python-rope/rope

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.