Fix for issue 62001; ENH: Context-aware error messages for optional dependencies #62003
Conversation
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
rhshadrach
reviewed
Jul 30, 2025
| "description": "SQL database operations", | ||
| }, | ||
| "performance": { | ||
| "alternatives": ["numexpr", "bottleneck", "numba"], |
There was a problem hiding this comment.
These are "alternatives" but only in a very loose sense. They are not alternatives for the same operations.
rhshadrach
reviewed
Jul 30, 2025
| # Mapping of operation contexts to alternative dependencies | ||
| OPERATION_CONTEXTS = { | ||
| "excel": { | ||
| "alternatives": ["openpyxl", "xlsxwriter", "calamine", "xlrd", "pyxlsb", "odfpy"], |
There was a problem hiding this comment.
These may be alternatives, but they may not be. They are not completely equivalent. If a user is doing .write_excel(..., engine="openpyxl"), I don't think we should be suggesting they try installing xlsxwriter.
mroeschke
requested changes
Jul 30, 2025
|
Also I suspect this PR was AI generated so closing. We discourage heavily AI generated pull requests |
|
It partially was, I appreciate the review, it makes sense, thank you |
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.
#62001
Summary
This PR enhances import_optional_dependency() to provide context-aware error messages that suggest relevant alternatives when
dependencies are missing, addressing issue #62001.
Before:
Missing optional dependency 'openpyxl'. Use pip or conda to install openpyxl.
After:
Missing optional dependency 'openpyxl'. For Excel file operations, try installing xlsxwriter, calamine, xlrd, pyxlsb, or odfpy.
Use pip or conda to install openpyxl.
Implementation Details
plotting, html, xml, sql, performance, compression, cloud, formats, computation, timezone, testing, development)
Files Modified
Testing
All existing tests pass with updated patterns
New tests verify context functionality works correctly
Manual verification confirms all files compile successfully
Backward compatibility maintained for existing calls
closes #xxxx (Replace xxxx with the GitHub issue number)
Tests added and passed if fixing a bug or adding a new feature
All code checks passed.
Added type annotations to new arguments/methods/functions.
Added an entry in the latest
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.Please make sure to double check I am still new to contributions and let me know if there are any mistakes.