DHI / DHI/mikepluspy

Consider returning subprocess.CompletedProcess instance from Engine1D.run()

Open Beginner friendly
#56 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
25
Forks
3
PR merge metrics
No merged PRs in 30d

Description

It would be cool if `Engine1D.run()` returned the `subprocess.CompletedProcess` instance that is returned from the `subprocess.run()` call at https://github.com/DHI/mikepluspy/blob/69d0bdd6e35657b9d7911948a3dcb5b546612285/mikeplus/engines/engine1d.py#L49. This would allow users to check for subprocess errors within a script, if running a loop for instance.

https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess

Contributor guide

No contributing guide indexed for this repository

Research direction

Open mikeplus/engines/engine1d.py around line 49 and inspect the subprocess.run() call referenced in the issue. Read Python's subprocess.CompletedProcess documentation to confirm the expected return value. Done means Engine1D.run() exposes that result so callers can inspect subprocess errors while looping.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.