Add flags to control the start of the application #200
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
Currently, importing `visiomode.core` leads to automatically loading all the plugins (i.e., `devices`, `protocols`, and `stimuli`). Although this makes sense in the context of the full application and is the expected use case for the end user, this is a bit cumbersome when trying to create minimal tests. To follow the spirit of the previous commit, putting plugin loading behind a flag in the main application initialisation makes it possible to import the various modules without incurring the burden of loading the plugins. Also note that importing `visiomode.core` is not really a choice as `visiomode.__init__` itself imports `visiomode.core`, making it a requirement to load the plugins regardless of what imports are done by the user. This is especially cumbersome when developing tests for parts of the application that do not make use of the plugins (e.g., `visiomode.config`) but which are forced to incur the import cost.
I can't think of a good use case for loading plugins after startup; I think if a user uploads a plugin it's safer to just instruct them to restart the app. |
celefthe
requested changes
Jun 10, 2024
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.
Closes #199.
It is currently impossible to get a
visiomode.core.Visiomodeobject without incurring the cost of starting the whole application (i.e., starting the webpanel and getting stuck in the main application loop).This PR puts such actions behind their own flags, meaning it is possible to initialise a minimal version of the application.
Another aspect the PR addresses is the import of plugins. They (
visiomode.devices,visiomode.protocols,visiomode.stimuli) are imported automatically when importingvisiomode(or any submodules). And because of avisiomode.plugins.load_modules_dir()at the end of said plugins, they are loaded at import time. The refactor proposed here moves their initialisation into the main app initialisation and puts it behind a flag.This could be a problem if they are required to be initialised under other circumstances but I have not been able to produce an error when playing around with the application. Do let me know if there's a use case that would require them to be loaded outside of the main application startup.