Improve the PackageLoader error message #1706
Open
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
This exception is raised when the `package_path` directory (default "templates") is not found, so explain this.
for more information, see https://pre-commit.ci
|
I don't think the first 4 items of the checklist are relevant here, but happy to be corrected. |
|
@davidism Here's that PR. |
| f"The {package_name!r} package was not installed in a" | ||
| " way that PackageLoader understands." | ||
| f"PackageLoader could not find a '{package_path}' directory for the " | ||
| f"{package_name!r} package." |
There was a problem hiding this comment.
I think the original message was about not being able to find the package properly. i.e. At line 315, roots would still be an empty list, because it failed to find anything.
So, it seems better to me if the original error is raised if roots is empty, otherwise raise this new error message if we don't break from the loop (i.e. add an else to the for loop).
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.
Explain why the
PackageLoaderfailed when thepackage_pathdirectory is missing.Checklist:
CHANGES.rstsummarizing the change and linking to the issue... versionchanged::entries in any relevant code docs.pre-commithooks and fix any issues.pytestandtox, no tests failed.