Error when running on code inside venv containing `typing-extensions`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Bug Report
When running mypy on code installed in a virtualenv environment, mypy will fail outright if the environment contains typing-extensions.
To Reproduce
See repo containing a minimal example. The steps below describe the general idea:
- Create a fresh virtual environment.
- Create a minimal library with a
setup.pythat liststyping-extensionsininstall_requires. - Install the library to the virtual environment.
- Run
mypyon a file inside the environment that is part of the library (mypy venv/lib/python3.Y/site-packages/my_project/hello.py).
Expected Behavior
mypy would report errors in hello.py, if any, or exit with 0 if none.
Actual Behavior
mypy doesn't check hello.py, complaining that it found a typing_extensions.py in the environment:
mypy: "project-venv/lib/python3.6/site-packages/typing_extensions.py" shadows library module "typing_extensions"
note: A user-defined top-level module with name "typing_extensions" is not supported
Your Environment
- Mypy version used: 0.910.
- Mypy command-line flags: none
- Mypy configuration options from
mypy.ini(and other config files): none - Python version used: multiple (3.6.8, 3.8.8).
- Operating system and version: CentOS 7
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the minimal example in the linked mypy-typing-extensions-issue repository and reproduce the command against a package installed in a virtual environment. Trace mypy's module-resolution entry point for the reported shadowing error, then verify that the target hello.py is checked as expected without the failure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100