Add helpful hint error message if optional dependencies not yet installed. - #1656
Open
Sevans711 wants to merge 18 commits into
Open
Add helpful hint error message if optional dependencies not yet installed.#1656Sevans711 wants to merge 18 commits into
Sevans711 wants to merge 18 commits into
Conversation
also add string matching to test_check_requires_viz_and_geo in both the installed_with_geo and the installed_with_viz cases, and left a comment about why it wasn't added in the installed_with_no_opts case.
Sevans711
force-pushed
the
sevans/_raise_hint_if_optional_deps_missing
branch
from
August 10, 2026 14:50
03869b5 to
8e2a07a
Compare
6 tasks
Sevans711
requested review from
cmdupuis3,
dylannelson,
erogluorhan and
rajeeja
August 10, 2026 19:00
(maybe not necessary… but also trying to re-trigger CI jobs here, due to github actions downtime yesterday causing stalled jobs with no "rerun jobs" button available.)
also add string matching to test_check_requires_viz_and_geo in both the installed_with_geo and the installed_with_viz cases, and left a comment about why it wasn't added in the installed_with_no_opts case.
Sevans711
force-pushed
the
sevans/_raise_hint_if_optional_deps_missing
branch
from
August 10, 2026 20:02
8e2a07a to
1210ae0
Compare
rajeeja
requested changes
Aug 13, 2026
rajeeja
left a comment
rajeeja
left a comment
Contributor
There was a problem hiding this comment.
One unreachable branch, see inline.
| extra in need_extras for extra in extras | ||
| ): # still maybe in case (1) or (2). | ||
| pass # this package is already covered by other needed extras! | ||
| elif len(extras) == 0: # case (3) |
Contributor
There was a problem hiding this comment.
Unreachable — the assert above guarantees len(extras) >= 2, so this likely wants >= 2 not == 0. Means a cartopy-only miss suggests [all] instead of [geo] or [viz].
Collaborator
Author
There was a problem hiding this comment.
Thank you for looking into this! Commit 0f638de fixes this, makes slight improvements to message readability in case of many extras, and adds a test to the CI with expectations about the error messages. That test would have crashed before this fix, and it hard-codes the expected error messages for clarity and readability.
…/github.com/UXARRAY/uxarray into sevans/_raise_hint_if_optional_deps_missing
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Addresses part of #1224 #1225 but does not fully close them.
Overview
Adds
_raise_hint_if_optional_deps_missingwhich raises helpful hint upon trying but failing to import optional dependencies due to them not yet being installed.PR Checklist
General
Testing & Benchmarking
Documentation
docs/api.rst_)AI Disclosure
AI Usage: GitHub Copilot inline code suggestions, some discussion with Claude.