Replace custom CLI with argparse - #83
Open
hugovk wants to merge 2 commits into
Open
Conversation
| ) | ||
|
|
||
| def add_subcommand(name: str, doc: str) -> argparse.ArgumentParser: | ||
| doc = doc.strip() |
Member
There was a problem hiding this comment.
Won't strip only strip the first line? I suggest using inpect.cleandoc instead.
| # Keep the legacy 'help' and 'version' subcommands working as aliases. | ||
| elif args[0] == 'help': | ||
| print( | ||
| "Warning: 'blurb help' is deprecated, use 'blurb --help' instead", |
Member
There was a problem hiding this comment.
Why not warnings.warn(..., DeprecationWarning), that way we can suppress it.
| "Warning: 'blurb help' is deprecated, use 'blurb --help' instead", | ||
| file=sys.stderr, | ||
| ) | ||
| args = [*args[1:2], '--help'] |
Member
There was a problem hiding this comment.
Won't this allow extra arguments after --help?
|
|
||
|
|
||
|
|
||
| ### blurb help |
Member
There was a problem hiding this comment.
I'd suggest keeping at least a little note pointing to --help.
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
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.
There's a lot of custom code for the CLI handling, which we can replace with argparse.
This saves us about 150 lines of code, and we get colour help, plus I've added backticks in some help messages for "code" formatting as well.
Right now, blurb has both subcommand and option versions of help and version:
This PR deprecates the subcommands in favour of the more ususal options.