vscode에서 파이썬 정적 타입 검사 도구 mypy 사용 시, "import requests"에 빨간줄 뜨는 현상

문제

python으로 소프트웨어를 개발할 때는 정적 타입 검사 도구인 mypy를 사용하고 있습니다.

- 수많은 런타임 에러를 미리 고칠 수 있도록 도와주는 mypy 너무 좋습니당

그런데 requests 모듈을 import 할 때마다 아래와 같이 빨간줄이 뜨면서 경고 메시지가 뜨는 것입니다.

여기서 빨간줄이?

해결책

일단 구글에 검색해보니 경고 메시지에 있는 것처럼 다음 명령어를 수행하면 해결된다고 하여 따라 실행해보니 빨간줄은 사라졌습니다.
- python -m pip install types-requests

원인

빨간줄이 사라져서 문제는 해결되었지만 원인이 궁금하여 경고 메시지에 있는 다음 링크에 들어가봤습니다.
- https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports

내용을 요약해보면 다음과 같았습니다.

1.    mypy는 개발자가 import한 모듈들에 정의된 타입이나 메소드들에 대해서 따로 타입 추론을 하지 않는다.
2.    만약 import한 모듈들이 타입 힌팅을 사용하지 않았다면 mypy에서 에러를 반환하게 된다.
3.    에러를 해결하고 싶으면 다음 중에서 한가지 조치를 취해야 한다.
    a. 하는 모듈의 버전 중에서 타입 힌팅을 지원하는 버전이 있다면 해당 버전을 사용한다.
    b. 사용하는 모듈의 타입 힌팅을 제공하는 stub 모듈이 있다면 해당 모듈을 다운로드 받는다.
    c. 직접 stub 모듈을 만든다.

즉, requests 모듈은 타입 힌팅이 없어서 위와 같은 빨간줄이 뜬 것이었고, types-requests라는 stub 모듈을 다운로드 받아서 문제를 해결한 것이었습니다.

 

mypy 사용팁

• mypy를 잘 사용하고 싶다면 import하는 모듈들이 타입 힌팅을 잘 지원하는지 확인할 것!
• 없으면 위의 a, b, c 방법 중 하나를 잘 선택할 것!
• 주로 a, b 방법을 선택하지 않을까 ㅎㅎ

 

해결!