fix: better error message when flask not installed #5398
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
The dependencies for the AiiDA REST API are currently not installed by default - only when users request the `rest` extra. When users were starting the REST API without installing the extra, they were greeted by an unhelpful/unexpected error message ModuleNotFoundError: No module named 'flask_restful' Here we catch ImportErrors upon starting the REST API and provide an error message that includes instructions on how to remedy the situation. For cases where the ImportError has another cause, the original exception is carried along as well.
ltalirz
force-pushed
the
issue-1393-restapi-warn
branch
from
65b2dbf
to
8d91e2e
Compare
Merged
sphuber
approved these changes
Feb 27, 2022
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.
fix #1393
The dependencies for the AiiDA REST API are currently not installed by
default - only when users request the
restextra.When users were starting the REST API without installing the extra, they
were greeted by an unhelpful/unexpected error message
Here we catch ImportErrors upon starting the REST API and provide an
error message that includes instructions on how to remedy the situation.
For cases where the ImportError has another cause, the original
exception is carried along as well.