Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide installation instructions in RequirementCache error message #54

Merged
merged 5 commits into from
Sep 19, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/lightning_utilities/core/imports.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ def _check_requirement(self) -> None:
self.message = f"Requirement {self.requirement!r} met"
except Exception as ex:
self.available = False
self.message = f"Requirement {self.requirement!r} not met, {ex.__class__.__name__}: {ex}"
self.message = f"{ex.__class__.__name__}: {ex}. HINT: Try running `pip install {self.requirement!r}`"
carmocca marked this conversation as resolved.
Show resolved Hide resolved

def __bool__(self) -> bool:
self._check_requirement()
Expand Down
2 changes: 1 addition & 1 deletion tests/unittests/core/test_imports.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ def test_requirement_cache():

assert RequirementCache(f"pytest>={pytest.__version__}")
assert not RequirementCache(f"pytest<{pytest.__version__}")
assert "Requirement '-' not met" in str(RequirementCache("-"))
assert "pip install '-'" in str(RequirementCache("-"))
carmocca marked this conversation as resolved.
Show resolved Hide resolved