NCAS-CMS / NCAS-CMS/cf-python

Add type hints for type safety

Aperta
#787 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

code tidy enhancement testing
Lingua principale
Python
Stelle
150
Fork
23
Merge medio
1g 11h
PR unite (30g)
2

Descrizione

Add type hints across the codebase. They are valid syntax for Python v..3.5+, so are safe to add given we are now 3.7+.

We can then use type checking tools, such as mypy, to ensure robustness of our code and catch bugs relating to errors due to incorrect types.

See https://github.com/NCAS-CMS/cf-python/pull/785#discussion_r1638434210 for brief further discussion.

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

Esamina la codebase Python insieme a PEP 484 e alla breve discussione in PR #785, quindi identifica l’ambito delle annotazioni necessarie nell’intero progetto. Considera come verrebbe applicato mypy per verificare i nuovi suggerimenti di tipo. Il lavoro è completato quando la codebase dispone di annotazioni di tipo appropriate e può essere verificata per rilevare errori relativi ai tipi.

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

Valutazione

Stack tecnologico
python
Ambito
data, tooling
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.