Modular commands attempt 3 #943 #961
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
anselor
force-pushed
the
modular_commands
branch
3 times, most recently
from
c9a8f49 to
a92faa5
Compare
Codecov Report
@@ Coverage Diff @@
## master #961 +/- ##
==========================================
+ Coverage 97.74% 97.83% +0.09%
==========================================
Files 21 22 +1
Lines 4217 4487 +270
==========================================
+ Hits 4122 4390 +268
- Misses 95 97 +2
Continue to review full report at Codecov.
|
anselor
force-pushed
the
modular_commands
branch
5 times, most recently
from
6fdd73a to
6837065
Compare
kmvanbrunt
requested changes
Jul 29, 2020
| terminators: Optional[List[str]] = None, shortcuts: Optional[Dict[str, str]] = None) -> None: | ||
| terminators: Optional[List[str]] = None, shortcuts: Optional[Dict[str, str]] = None, | ||
| command_sets: Optional[Iterable[CommandSet]] = None, | ||
| auto_load_commands: bool = True) -> None: |
Member
There was a problem hiding this comment.
Do we want this set to True? Won't that needlessly run _autoload_commands() for a lot of projects which don't need to call it?
Contributor
Author
There was a problem hiding this comment.
We do because, for projects that choose to use CommandSets they will 'just work'. The search for child classes is fast because it's asking Python for child classes that have already been loaded. This should just be a lookup of information that's already loaded in memory.
kmvanbrunt
requested changes
Jul 29, 2020
kmvanbrunt
requested changes
Jul 29, 2020
anselor
force-pushed
the
modular_commands
branch
from
21397c8 to
4cb15ee
Compare
tleonhardt
requested changes
Aug 1, 2020
Member
tleonhardt
left a comment
tleonhardt
left a comment
There was a problem hiding this comment.
Make sure to update CHANGELOG before merging in
kmvanbrunt
requested changes
Aug 3, 2020
Issue #943 New class CommandSet can be used to tag a class as a command class. If the constructor is simple, the object will automatically be instantiated and loaded. New register_command decorator to tag any arbitrary function as a command.
…tation for CommandSet commands. Issue #943
…oad. Added unit tests. Moved installing commands into separate functions that can be called Issue #943
…ding command functions Adds handling of some edge cases. More thorough test coverage.
register arbitrary functions as commands. Added example that demonstrates use of each of the command decorators with CommandSets. Adds unit test that verifies that CommandSets containing decorators load and process commands correctly. Updated the constructor declaration for Cmd2ArgumentParser to explicitly re-declare argparse constructor parameters.
Added additional documentation
load/unload. Updated examples and documentation to include discussion of injectable sub-commands.
sub-commande => subcommand Added help/aliases to `as_subcommand_to` decorator.
Change setup.cfg so that pytest only runs tests in the tests directory by default. Attempting to run tests in the isolated_tests directory was causing a crash
…t "inv pytest" doesn't crash
anselor
force-pushed
the
modular_commands
branch
from
ac32fad to
b5237ed
Compare
through to the ArgparseCompleter if one is registered. For subcommands, the registered argparse instance for the subcommand is now tagged with the CommandSet from which it originated. If a CommandSet is detected, it's now passed in as 'self' for the completion functions. Fixes some issue found with removing a subcommand. Adds additional tests. Added a check to prevent removal of a CommandSet if it has commands with sub-commands from another CommandSet bound to it. Documentation improvements. Standardized around using CommandSetRegistrationException during commandset install/uninstall related errors. Added support for nested sub-command injection.
anselor
force-pushed
the
modular_commands
branch
from
b5237ed to
4fd7aa7
Compare
anselor
force-pushed
the
modular_commands
branch
from
4fd7aa7 to
c0ad7ba
Compare
kmvanbrunt
requested changes
Aug 4, 2020
…efore passing to command handlers to access sub-command handlers
anselor
force-pushed
the
modular_commands
branch
from
9783e95 to
b932ad4
Compare
This was referenced Aug 4, 2020
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.
ok, this should be the real one we want.
Going back to being integrated into the cmd2 core instead of a plugin.
Removed support for arbitrary functions as loadable modular commands. Modular commands must be in a CommandSet.
Added additional documentation and examples.
Closes #943