POSYDON-code/POSYDON

Add better checks on assumed input types/values to all functions

Offen

#462 geöffnet am 03.12.2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (35 Forks)auto 404
enhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (42 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

We have a lot of functions, which work currently with assumptions either only written in the doc-strings or even nowhere mentioned. All this can produce unforeseen runtime errors at any parts of the code. A more specific example in the case of None type objects is already given in issue #236 . Another common case are floats or integers to be of the correct type or range.

Contributor Guide

Research-Richtung
Identifizieren Sie Funktionen ohne Eingabevalidierung und fügen Sie Typ und Bereichsprüfungen hinzu. Beginnen Sie mit der Durchsuchung der Codebasis nach Funktionen, die Parameter ohne explizite Typ oder Wertbeschränkungen akzeptieren, insbesondere solche, die nur auf Doc String Annahmen basieren. Verwenden Sie Typ Hinweise oder Laufzeit Assertionen, um die erwarteten Typen und Bereiche durchzusetzen.
Tech Stack
python
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70