POSYDON-code/POSYDON

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

Open

#462 opened on Dec 3, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (35 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (42 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Identify functions without input validation and add type and range checks. Start by scanning the codebase for functions that accept parameters without explicit type or value constraints, especially those with only doc string assumptions. Use type hints or runtime assertions to enforce expected types and ranges.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70