Use informative error message for optional dependency imports #118
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
andersy005
reviewed
Oct 25, 2022
andersy005
reviewed
Oct 25, 2022
Co-authored-by: Anderson Banihirwe <axbanihirwe@gmail.com>
Codecov Report
@@ Coverage Diff @@
## main #118 +/- ##
===========================================
- Coverage 100.00% 97.97% -2.03%
===========================================
Files 5 5
Lines 192 198 +6
Branches 35 35
===========================================
+ Hits 192 194 +2
- Misses 0 4 +4
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
andersy005
approved these changes
Oct 26, 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.
Description of proposed changes
This PR adds information about optional dependencies to the installation instructions and improves the ImportError message when trying to use the data loaders without having PyTorch and/or TensorFlow installed.
Open to opinions about whether these error messages should also be used for the torch and tf xarray accessors and if it's necessary to add tests for this case. This drops code coverage to 99%.
Fixes #