Add ability to define User Plugins in environmental variable that load at init #662
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
One was used in testing and another similar but different one was used in App init. Now they are consistent and using the same code. A runtime import was required to do this in order to avoid a circular import.
This allows users to load importable plugins from a ARMI_USER_PLUGINS environmental variable. Using user settings is too hard because the plugins have to be loaded and locked before settings can be read, since many settings are defined by plugins. Closes #569
john-science
reviewed
May 9, 2022
Comment on lines
+124
to
+130
| for pluginSpec in userPluginInput.split(","): | ||
| names = pluginSpec.split(".") | ||
| modPath = ".".join(names[:-1]) | ||
| clsName = names[-1] | ||
| mod = importlib.import_module(modPath) | ||
| plugin = getattr(mod, clsName) | ||
| self._pm.register(plugin) |
There was a problem hiding this comment.
- I might change this:
names = pluginSpec.split(".")
to this:
names = pluginSpec.strip().split(".")
People are always putting spaces after commas, when they write a list.
- Vis-a-vis my dream: why does this logic have to happen before we read in a Case Settings file? It seems like this should be able to happen at run time. Naively, I could be missing something.
|
I have opened my own branch to solve this problem. Please hold off working on this feature, so I can test mine. (I know you're busy right now, so that's probably not going to be a problem. lol) |
|
I have opened a PR for a similar feature: #723 I believe it is documented and working. |
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
Fixes #569
Checklist
If user exposed functionality was added/changed:
docfolder.setup.py.