Fix CLI output directory type - #182
Open
Vbitz wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a Typer CLI compatibility issue by changing the output_dir command parameter annotation from str | Path to str, avoiding Typer 0.15’s unsupported Union-typed parameters while keeping runtime behavior unchanged (the value is still converted via Path(output_dir)).
Changes:
- Update
output_dirCLI parameter type annotation fromstr | Pathtostrto prevent TyperAssertionErrorduring command construction (e.g.,preprocessor --help).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Restore the CLI-facing
output_dirannotation fromstr | Pathtostr. Typer 0.15 does not support union-typed command parameters and currently raisesAssertionError: Typer Currently doesn't support Union typeswhile constructing the command, including forpreprocessor --help.The function already converts the value with
output_dir = Path(output_dir), so runtime path handling is unchanged.Neurodesk confirmation
This investigation was started with OpenAI Codex CLI while debugging the NeuroContainers BrainLesion image, then confirmed by Neurodesk release CI:
Preprocessor CLI renders helpfulltest executes the installed console entry point.preprocessor --helpas the sole failure.preprocessor --help.Local validation
Tested from this branch under Python 3.10 with the project dependency set and Typer 0.15.4:
preprocessor --helppreprocessor --versionBoth commands exit successfully.