Allow plugins sharing the same name to be overwritten #158
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
This allows someone to load the default plugins and overwrite those that they wish to by specifying an `overwrite=True` parameter to `reguster_plugin`.
The DatasetInfoPlugin plugin will end up with two different names when it is registered with its two "default" methods: by entrypoint and by creating a DatasetInfoPlugin() object with no arguments. Having these two fields equal helps downstream users who want to override the default plugins. Without this, the users will have to know what the entrypoint name is for discovered plugins so they can override the correct plugin. By standardizing on the name of the plugin, it can be inferred.
abkfenris
approved these changes
Mar 9, 2023
| 'info = xpublish.plugins.included.dataset_info:DatasetInfoPlugin', | ||
| 'dataset_info = xpublish.plugins.included.dataset_info:DatasetInfoPlugin', |
There was a problem hiding this comment.
Thanks for catching and fixing that mismatch.
Comment on lines
+46
to
+49
| # Registering a duplicate plugin name will fail | ||
| same_name = DatasetInfoPlugin(name='dataset_info', dataset_router_prefix='/newinfo') | ||
| with pytest.raises(ValueError): | ||
| rest.register_plugin(same_name) |
There was a problem hiding this comment.
Should we have a separate test to catch the error with the existing functionality?
There was a problem hiding this comment.
Up to you, I can break this test down into smaller tests if you would like!
Comment on lines
+130
to
+144
| """ | ||
| Register a plugin with the xpublish system | ||
|
|
||
| Args: | ||
| plugin (Plugin): Instantiated Plugin object | ||
| plugin_name (str, optional): Plugin name | ||
| overwrite (bool, optional): If a plugin of the same name exist, | ||
| setting this to True will remove the existing plugin before | ||
| registering the new plugin. Defaults to False. | ||
|
|
||
| Raises: | ||
| AttributeError: Plugin can not be registered | ||
| ValueError: Plugin already registered, try setting overwrite to True | ||
| """ | ||
| plugin_name = plugin_name or plugin.name |
There was a problem hiding this comment.
|
Thanks Kyle! |
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.
When configuring an
xpublishserver, I found it useful to be able to load the default entrypoint plugins and override a subset of them. For example, I didn't want thezarrplugin in the root namespace, I'd like it at/zarr. This allows plugins to be overwritten by name while still allowingxpublishto do its thing and discover entrypoint plugins.While testing this I realized that
DatasetInfoPlugin.name = 'dataset_info'but it was being added inentrypointswith the nameinfo. There is no problem with this, except when a user like me wants to override the settings of a plugin by name 😆 and depending on how it was loaded, the default name changes. I changed the entrypoint todataset_info... not going to die on this hill but it would be nice if the entrypoint name and the default plugin name were equal!