Use Public API #4
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
Rewrite the plugin to avoid private APIs:
* Remove custom testenv conf key: ignore_env_name_mismatch and
ignore_envname_mismatch
* Use existing conf key `runner` to opt-in to ignore_env_name_mismatch
behavior
* Return a subclass of `Info` that filters out the "name" key from
`ToxEnv.__name__` section
* When this plugin is active, the ToxEnv cached info will NOT contain a
"name" key at all, so there will be no name key to conflict, thus nothing
needs to be overridden in the private `_content` dictionary.
All tests are rewritten and vastly simplified, as there are fewer branch points
in the new implementation.
fix #3
Update copyright year to 2023
Add links to tox documentation Add section about vendoring the plugin
Since FilteredInfo can accept generic filter_keys and filter_section, add test cases to ensure the less common default branches are covered, even though the plugins don't directly use them (yet)
|
Just a heads up to my early adopters @broken-wheel and @ssbarnea that this is a breaking change in how the plugin gets activated. Thankfully I'm able to make this change early in the plugin development and hopefully will not need additional breaking changes down the road. |
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.
[BREAKING] Override public API to filter cached name key
Rewrite the plugin to avoid private APIs:
runnerto opt-in to ignore_env_name_mismatch behaviorInfothat filters out the "name" key fromToxEnv.__name__section_contentdictionary.All tests are rewritten and vastly simplified, as there are fewer branch points in the new implementation.
fix #3