Fix missing plug-ins from vpype --help string
#444
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
When importing plug-ins in the style of `click-plugin` (command decorator, so plug-ins are loaded during the loading of the top-level command itself), plug-ins may not import from `vpype_cli` (since it isn't fully loaded). To address that, since 1.9, loading plug-ins is deferred to when `cli` is actually executed. As a result, the Click's default behaviour for handling `--help` (i.e. print and exit *before* even executing `cli`) is unable to list the plug-ins. This commit addresses this by manually handling the top-level `--help` parameter (*after* plug-ins are loaded). Fixes #432
Codecov Report
@@ Coverage Diff @@
## master #444 +/- ##
==========================================
+ Coverage 93.98% 94.31% +0.33%
==========================================
Files 60 60
Lines 5301 5313 +12
Branches 776 778 +2
==========================================
+ Hits 4982 5011 +29
+ Misses 204 185 -19
- Partials 115 117 +2
Continue to review full report at Codecov.
|
- Fixed multiple plug-in loading when using `vpype_cli.execute()` multiple times - updated CHANGELOG.md
|
Kudos, SonarCloud Quality Gate passed!
|
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.
Description
When importing plug-ins in the style of
click-plugin(command decorator, so plug-ins are loaded during the loading of the top-level command itself), plug-ins may not import fromvpype_cli(since it isn't fully loaded). To address that, since 1.9, loading plug-ins is deferred to whencliis actually executed. As a result, the Click's default behaviour for handling--help(i.e. print and exit before even executingcli) is unable to list the plug-ins. This PR addresses this by manually handling the top-level--helpparameter (after plug-ins are loaded).Fixes #432
Checklist
blackandisort)mypyreturns no errorpytestsucceedshelpreference.rstmake clean && make htmlindocs/)