Type checking a system-install package yields erronous results
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Bug Report
I'm working on todoman a cli app which I have installed on my system since, well, it's a cli app that I use interactively daily.
I'm working on adding type hints to this project, so I have it installed the development code a virtualenv (pip install -e .) and also installed mypy and other developer tools in that virtualenv.
When I run mypy, it seems to read type definitions from my system-installed version of todoman, so type checking does not match what's inside the repository checkout.
In other words, when there's a from todoman import X, mypy seems to read the system library, and not the $(pwd)/virtualenv one. That one lacks type definitions, so the results are skewed.
To Reproduce
- Install
todomanusing your system package manager (in my casepacman -S todoman). git clone --branch typing2 https://github.com/pimutils/todoman.gitcd todoman && mkvirtualenv todoman && pip install -e . && pip install mypy- Make sure nothing in caching your
$PATHhere and runwhich mypy. mypy todoman.
Expected Behavior
mypy should fail here, since there's a type-checking error in the checked out brach.
Actual Behavior
mypy passes, since it seems to read the system install libraries which have no type hints.
Your Environment
➜ mypy --version
mypy 0.812
➜ cat .config/mypy/config
[mypy]
ignore_missing_imports = True
cache_dir = $HOME/.cache/mypy
➜ python --version
Python 3.9.5
➜ uname -srmo
Linux 5.12.6-arch1-1 x86_64 GNU/Linux
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
Reproduce the report with the listed pacman, editable-install, virtualenv, and mypy todoman steps, checking which mypy and the reported versions first. Trace why the system-installed package is selected instead of the checkout, and consider the issue done when the checked-out package is type-checked and the reported error is detected.
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