NCAS-CMS / NCAS-CMS/cf-python

Add type hints for type safety

Offen
#787 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

code tidy enhancement testing
Vorherrschende Sprache
Python
Sterne
150
Forks
23
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
2

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Überprüfe die Python-Codebasis zusammen mit PEP 484 und der kurzen Diskussion in PR #785 und ermittle anschließend den Umfang der im gesamten Projekt erforderlichen Annotationen. Berücksichtige, wie mypy zur Überprüfung der neuen Typannotationen eingesetzt würde. Als abgeschlossen gilt die Aufgabe, wenn die Codebasis angemessene Typannotationen enthält und auf typenbezogene Fehler geprüft werden kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
data, tooling
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.