0. 개요
flake8이란 "pep8의 체크, pyflakes의 체크 및 순환 복잡도를 체크할 수 있는 Wrapper"이다.
한 마디로, 파이썬 코드를 이쁘게 만들어주는 라이브러리다.
flake8이 제공하는 기능은 크게 3가지이다.
- PyFlakes (pyflakes : 코드의 에러 체크)
- pycodestyle (pycodestyle : PEP8에 준거하고 있는지를 체크)
- Ned Batchelder's McCabe script (mccabe : 순환 복잡도를 체크)
여기서 잠깐, PEP8이란?
- 파이썬 개선 제안서, 파이썬 코드를 어떻게 구상할 지 알려주는 스타일 가이드
즉, 파이썬 코드 검수와 동시에, 코딩 스타일에 대한 표준을 제시하는 라이브러리이다.
1. 설치
#pip install flake8
위의 명령어를 수행하면 이미지와 같이 설치가 진행된다.
2. 실행
vscode 기준으로, flake8 실행 방법을 설명한다.
windows: alt + shift + p
mac: command + shift + p
검색 창 실행 후, [select Linter] 검색 후 클릭하여 실행한다.
이후, 아래 항목에서 flake8 을 선택하면 실행 완료된다.
3. 테스트
flake8이 정상적으로 실행되는지 테스트를 해보자.
(1)flake8 적용 전
flake8 적용 전에는, 위와 같은 코드 작성 시 빨간 줄(오류)이 발생하지 않는다.
(2)flake8 적용 후
flake8을 적용했을 시에 발생하는 두 가지 케이스를 알아본다.
참고로, flake8은 수정한 파일을 저장해야 작동한다.
case1) 주석
위처럼 빨간 줄이 생기고
마우스 커서를 가져다 대면 왜 오류가 발생했는지 설명을 보여준다.
위와 같은 경우는, #이 너무 여러 개가 붙어있어서 발생한 경우.
이렇게 # 입력 후, 한 칸을 띄어야 오류가 사라진다.
case2) 변수 관련
변수를 선언만 하고 사용하지 않거나, 변수와 operator(=) 사이에 공백이 없으면 오류를 발생시킨다.
공백을 입력하면 오류가 사라진다.
끝.