POSYDON-code/POSYDON

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

Ouverte

#462 ouverte le 3 déc. 2024

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Python (35 forks)auto 404
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (42 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Identifiez les fonctions sans validation d'entrée et ajoutez des vérifications de type et de plage. Commencez par parcourir la base de code pour les fonctions qui acceptent des paramètres sans contraintes explicites de type ou de valeur, en particulier celles qui reposent uniquement sur des hypothèses dans les doc strings. Utilisez des indications de type ou des assertions au moment de l'exécution pour imposer les types et plages attendus.
Stack technique
python
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70