OpenwaterHealth / OpenwaterHealth/openlifu-python
Improve Static Type Checking And Annotations Across the Codebase
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 27
- Forks
- 21
- Avg merge
- 1d 20m
- Merged PRs (30d)
- 6
Description
Summary
Improve static type checking across the codebase to support better integration with the OpenLIFU-app, which sometimes leverages type hints for automating GUI elements.
Motivation
Incomplete or inaccurate typing (e.g., raw dict/list usage, incorrect assignments, missing annotations) can lead to unintended behavior or reduced ability to automate generation of GUI elements for modifying openlifu classes.
Scope
This issue serves as a tracker for PRs that:
- Add missing or more precise type annotations
- Fix type mismatches
- Replace untyped or loosely typed structures
- Improve overall type inference and clarity
Traceability Information:
- Issue: OpenLIFU-python#262
- SOFTREQ: OpenLIFU-python#337
- Comment: This issue is related to the requirements defined in OpenLIFU-python#337.
This information was populated automatically by a script on 2025-06-09T18:02:40Z.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the scope in issue #262 and read the related requirement in issue #337. Identify a specific typing gap in the Python codebase before beginning; done would mean a focused change that adds or corrects annotations, improves type inference, or resolves a type mismatch with suitable validation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100