friendlier error messages for missing chunk managers #9676
Conversation
|
Much better! |
|
Thanks - I had a PR on this but don't mind closing mine in favor of this one. There is also #7963 which seems related. |
|
wow, I don't know how I missed two open PRs that aim to do something similar in different ways. Which one do we take? If we merge this one your PR might still be valuable since it also changes the error message if there are chunk managers but not the one that was requested. |
|
Shall we merge? |
TomNicholas
added
topic-error reporting
topic-chunked-arrays
Sorry for dropping the ball on reviewing / merging these guys 😞 Let's merge this one.
This change would also be useful but is much less likely to come up. |
Co-authored-by: Tom Nicholas <[email protected]>
|
If you change the other ValueError to ImportError on line 109 of parallelcompat.py the failing test should pass. |
xarray/tests/test_parallelcompat.py
Outdated
| def test_fail_on_nonexistent_chunkmanager( | ||
| self, register_dummy_chunkmanager | ||
| ) -> None: | ||
| with pytest.raises(ImportError, match="unrecognized chunk manager foo"): |
There was a problem hiding this comment.
there might be two reasons why this fails: one, there's a typo, in which case I'd say it would be better to raise a ValueError (the issue is the caller's input), while the second reason is indeed that the library that provides the requested chunk manager was not installed or fails to import.
In the case when there's no chunk manager at all, we know that the user needs to install a library and I can understand using a ImportError. However, in the case where there's at least one chunk manager I don't think we can figure out whether the issue was a user error or a missing library (at least, without maintaining a list of known chunk managers and suggesting sufficiently "close" names), so I think this should still be expecting a ValueError:
| with pytest.raises(ImportError, match="unrecognized chunk manager foo"): | |
| with pytest.raises(ValueError, match="unrecognized chunk manager foo"): |
There was a problem hiding this comment.
You raise a good point about ambiguity, but I also think we could reasonably just say (imprecisely) "with this user input were unable to import a necessary library, so there's still an ImportError underneath", which then has the advantage of consistency of error types for users.
|
I'm planning to release on Friday US time. Would be good to wrap this up |
|
Trying to summarize what we discussed in the meeting on Wednesday:
This would be okay, because right now there are only 3 chunkmanagers we know of, one which ships with xarray. Outside of these 3 a slightly less helpful error message is fine. This allows our error messages to explicitly point to the correct package to install, e.g. We questioned the wisdom of even creating the whole entrypoint system in the first place, but also said that removing it is a separable issue for later, and the priority should be to improve the error messages first. I can't really remember what we decided about |
|
Thanks for the summary.
I don't think we decided anything, but it would make sense to me to raise a |
|
we probably also want to prefer the more specific error over the generic |
|
@dcherian, @TomNicholas, this should be ready for a final review ( |
|
we can always release more! |
|
the failing |
keewis
changed the title
The current error message when trying to use a chunked-array related method without actually having a chunk manager available is:
That's pretty confusing, so this catches the case where no chunk manager is available and raises an error with guidance on how to fix that.
whats-new.rst