Support callable subcommands #362
Merged
Conversation
This file contains 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
- Renamed the use of builtin `help` in one occasion; - changed 2 TCs to test with 2-tuples; - improved slightly the documentation. See ipython#361 for rational.
+ Mimic behavior of similar libraries (docopt, click) and tools. Part of ipython#361.
ankostis
force-pushed
the
subcmd_callable
branch
2 times, most recently
from
740a589 to
5637976
Compare
minrk
reviewed
Jan 24, 2017
| # this must be a dict of two-tuples, | ||
| # the first element being the application class/import string | ||
| # and the second being the help string for the subcommand | ||
| #: subcommands for launching other applications |
There was a problem hiding this comment.
looks like these colons were added by accident
| #: if this is not empty, this will be a parent Application | ||
| #: this must be a dict of two-tuples, | ||
| #: the first element is the application class, or and import string | ||
| #: or a callable with a single argument for the parent returnng |
| if isinstance(subapp, six.string_types): | ||
| subapp = import_item(subapp) | ||
| if callable(subapp): | ||
| self.subapp = subapp(self) |
There was a problem hiding this comment.
classes are callable, so this check will catch the common case of subapp being an Application and handle it incorrectly.
There was a problem hiding this comment.
Indeed!
Would this be ok?
if callable(subapp) and not isinstance(subapp, Application):
...
There was a problem hiding this comment.
Editing my self, more like issubclass(subapp, Application)...and also avoid invoking ConfigSingleton.instance() when factory method supplied.
+ Previous commit was unfinished; the check was outright wrong (see discussion in ipython#362) and the purpose was not to invoke SingletonConfigurable.instance() at all. + Added subcommands-TCs.
ankostis
force-pushed
the
subcmd_callable
branch
from
5637976 to
bc746ac
Compare
ankostis
added a commit
to ankostis/traitlets
that referenced
this pull request
Jan 25, 2017
minrk
added a commit
that referenced
this pull request
Jan 30, 2017
Re-enable TC-code for subcmds forgotten by #362
Carreau
added
5.0-re-review
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.
Subcommands might be classes, strings (name of classes) and now Callables with a single argument: the parent Application instance (i.e. to read configs from).
That way it is possible to create different subcommands based on the same Application-class just with different constructor arguments.
I could not fins any test-cases about subcommands, so this PR is not considered finished - submitted for discussion.