Deltares / Deltares/imod-python
mf6 packages: names should be checked for path validity
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 12
- Avg merge
- 21h 8m
- Merged PRs (30d)
- 1
Description
In GitLab by @Huite on Dec 6, 2021, 10:14
The input files are written on a per-package basis, with the package name (key in the model dict) being used as a directory name.
There's currently no check in __setitem__ whether this results in a valid path. Ideally an error is raised immediately during __setitem__.
Contributor guide
No contributing guide indexed for this repository
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 at the model dictionary's setitem implementation and trace how package names become directory names in the per-package input files. Define the path-validity check there so invalid names raise immediately; done when valid names continue to work and invalid names fail during setitem.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100