Improve missing module error for subdirectories (#7405) #8927
Conversation
|
Thanks, would be happy to take any suggestions on the wording of the message! |
mypy/modulefinder.py
Outdated
| def error_message_templates(self) -> Tuple[str, str]: | ||
| if self is ModuleNotFoundReason.NOT_FOUND: | ||
| msg = "Cannot find implementation or library stub for module named '{}'" | ||
| note = "See https://mypy.readthedocs.io/en/latest/running_mypy.html#missing-imports" | ||
| elif self is ModuleNotFoundReason.WRONG_WORKING_DIRECTORY: | ||
| msg = "Cannot find implementation or library stub for module named '{}'" | ||
| note = ("You may be running mypy in the wrong directory, " |
There was a problem hiding this comment.
Some brainstorm: You may be running mypy in a subdirectory, mypy should be run in the package root directory. @JukkaL may have better suggestions.
There was a problem hiding this comment.
Any suggestions on this message, or other changes that need to be made in order for this PR to be ready for merge @JukkaL?
mypy/test/testcmdline.py
Outdated
| "testFailedImportCannotBeFoundInParent": "main/subdir", | ||
| "testImportInParentButNoInit": "main/subdir", | ||
| "testFailedImportCanBeFoundInParentsParent": "main/subdir1/subdir2", | ||
| } |
There was a problem hiding this comment.
I'd prefer having a way of specifying this in the test case, as this is more fragile (consider what happens if one of the test cases is renamed). For example, this could be specified via # cwd: main/subdir in the test case description, similar to how we have # cmd: ... and similar. This would also make it easier to understand what the test cases are testing exactly.
This is not absolutely essential, but it would be nice to have. If you decide not to implement this, please add a comment to each test case that describes the working directory and mentions custom_working_dir.
There was a problem hiding this comment.
Added # cwd: ... to testcmdline.py 👍
| [file main/__init__.py] | ||
| [out] | ||
| main.py:1: error: Cannot find implementation or library stub for module named 'wrongdir' | ||
| main.py:1: note: See https://mypy.readthedocs.io/en/latest/running_mypy.html#missing-imports |
There was a problem hiding this comment.
Command line tests are quite expensive to run. Could you reduce the number of test cases to 2, for example? Maybe you can combine tested features.
ethan-leba
force-pushed
the
eleba/better-module-messages
branch
2 times, most recently
from
e663f72 to
6c145c1
Compare
ethan-leba
force-pushed
the
eleba/better-module-messages
branch
from
6c145c1 to
bf705b3
Compare
|
Thanks for the review @JukkaL! I addressed your comments, and used @TH3CHARLie's suggestion for the error message. Let me know if there's any more work that needs to be done on this PR! |
Fixes #7405