POSYDON-code/POSYDON

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

Aperta

#462 aperta il 3 dic 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (35 fork)auto 404
enhancementgood first issuehelp wanted

Metriche repository

Star
 (42 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Identifica le funzioni senza validazione di input e aggiungi controlli di tipo e intervallo. Inizia esaminando il codice base per funzioni che accettano parametri senza vincoli espliciti di tipo o valore, specialmente quelle che si basano solo su ipotesi nei doc string. Utilizza suggerimenti di tipo o asserzioni a runtime per imporre i tipi e gli intervalli previsti.
Tech stack
python
Dominio
backend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70