Remove Problematic Type Union #694
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the shell launcher, an unintended and unused type union sunk into the
``ShellLauncherCommand`` type for the ``command_tuple`` type, allowing
the attr to be of type ``Sequence[str]`` or ``tuple[str, tuple[str,
...]]``. The former works as expected, but the latter would error at
runtime when sent to the ``ShellLauncher`` when opening a subprocess.
```py
class ShellLauncher:
...
def start(self, shell_command: ShellLauncherCommand) -> LaunchedJobID:
...
exe, *rest = shell_command.command_tuple
# ^^^^ Mypy thinks this is `list[str] | list[tuple[str]]`
expanded_exe = helpers.expand_exe_path(exe)
# pylint: disable-next=consider-using-with
self._launched[id_] = sp.Popen(
(expanded_exe, *rest),
# ^^^^^^^^^^^^^^^^^^^^^
# And inadvertently casts this to `tuple[Any]` which errors
# at runtime
cwd=shell_command.path,
env={k: v for k, v in shell_command.env.items() if v is not None},
stdout=shell_command.stdout,
stderr=shell_command.stderr,
)
return id_
```
Because this type was not being used, it can simply be removed from the
union.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## smartsim-refactor #694 +/- ##
=====================================================
+ Coverage 40.45% 43.95% +3.49%
=====================================================
Files 110 110
Lines 7326 7134 -192
=====================================================
+ Hits 2964 3136 +172
+ Misses 4362 3998 -364
|
amandarichardsonn
approved these changes
Sep 5, 2024
| path: pathlib.Path | ||
| stdout: io.TextIOWrapper | int | ||
| stderr: io.TextIOWrapper | int | ||
| command_tuple: tuple[str, tuple[str, ...]] | t.Sequence[str] |
Contributor
There was a problem hiding this comment.
LGTM! Thanks for catching that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the shell launcher, an unintended and unused type union sunk into the
ShellLauncherCommandtype for thecommand_tupletype, allowing the attr to be of typeSequence[str]ortuple[str, tuple[str, ...]]. The former works as expected, but the latter would error at runtime when sent to theShellLauncherwhen opening a subprocess.Because this type was not being used, it can simply be removed from the union.