mypy - minnie0531/fastapi-template GitHub Wiki

python은 동적프로그래밍 언어로 인터프리터가 코드를 실행하면서 타입을 체크하고 코드를 실행시킵니다. 타입이 정해져 있지 않기 때문에 개발자가 원하는 대로 타입이 변경시킬 수 있습니다.. 그러나 이러한 특징은 간단한 스크립트로써 사용하기에 편하지만 프로젝트가 커지면서 잠재적인 버그이슈를 갖게 됩니다. 예를 들어 String type의 변수와 integer type의 변수가 sum을 하게 된다면 당연히 코드는 에러를 발생하게 될 것입니다. 그래서 규모가 큰 프로젝트에서는 type annotation을 이용하여 type에 대한 hint혹은 타입을 명시함으로써 이러한 오류를 줄일 수 있습니다. 그리고 이렇게 명시된 type 들은 mypy에 의해 검사가 가능해 집니다.

• Iinstallation pip install mypy
• Run 파일이나 디렉토리를 넘겨주어 실행. mypy file.py/directory
• Mypy settings 프로젝트에서 mypy를 통합하여 사용하는 경우(CI pipeline) 매번 커맨드를 보내는 것 보다 설정파일을 이용하면 편리합니다. 설정 파일은 프로젝트 최상위 디렉토리에서 mypy.ini 또는 .mypy.ini 또는 setup.cfg을 정의 하여 사용 가능 합니다. 예를 들어, app과 tests 디렉토리의 모든 파일을 타입 체크하되 일부 디렉토리를 제외하고 싶다면 다음과 같이 설정할 수 있습니다.

[mypy]
files = app,tests
show_error_context = True
show_column_numbers = True
show_error_codes = True
pretty = True

[app.*.models.*]
ignore_errors = True

Type annotation

type annotation은 변수/함수를 선언할 때 아래와 같이 type을 같이 명시해 줍니다. 변수는 :을 이용하여, 함수는 ->를 이용하여 type annotation을 할 수 있습니다.

a : int = 1
b : str = "hello"

def sum(a: int, b: int) -> int : 
   return a+b

내장 타입을 이용해서 좀 더 복잡한 타입 어노테이션을 추가할 때는 스탠다드 라이브러리의 typing 모듈을 사용할 수 있습니다.

프로젝트의 quality를 높이고 안정성을 확보하기 위해서 mypy를 사용하는 것을 권장 합니다.