[Python] 코드 린터 도구: Flake8, Pylint

Python 코드를 작성할 때 코드 스타일을 유지하고 잠재적인 오류를 사전에 방지하는 것은 매우 중요하다. 이를 위해 코드 린터(Linter) 도구를 사용하면 일관된 스타일을 유지하고 코드 품질을 향상할 수 있다. 대표적인 Python 코드 검사 도구로는 Flake8과 Pylint가 있다.

 

 

- Flake8: Python 코드 스타일을 검사하는 도구

PEP 8 스타일 가이드를 준수하는지 확인하는 역할을 한다. 기본적으로 코드 스타일을 점검하고, 코드의 복잡도를 분석하는 기능도 포함하고 있다.

(Flake8의 주요 기능)

• PEP 8 스타일 가이드 검사
• 코드 복잡도 분석 (McCabe Complexity 체크)
• 사용되지 않는 변수 및 불필요한 코드 탐지
• 확장 플러그인 지원

Flake8은 코드 스타일을 유지하는 데 초점을 맞추고 있으며, 기본적인 코드 오류만을 검사하는 특징이 있다

 

 

- Pylint: 코드 스타일뿐만 아니라 코드의 논리적 오류까지 검사하는 정적 분석 도구

Flake8보다 더 엄격한 규칙을 적용하며, 코드 품질을 평가하는 점수가 제공된다.

(Pylint의 주요 기능)

• PEP 8 및 PEP 257 스타일 가이드 검사
• 코드 품질 분석 및 점수 제공 (10점 만점 시스템)
• 변수 및 함수 네이밍 규칙 검사
• 불필요한 import, 사용되지 않는 변수 및 함수 탐지
• 타입 애노테이션 검증
• 확장 플러그인 지원

Pylint는 코드 스타일뿐만 아니라 코드의 구조적인 문제까지 심층적으로 분석하는 데 유용하다

---

 

(Flake8과 Pylint 설치 및 사용 방법)

두 도구 모두 pip를 통해 간단하게 설치할 수 있다.

pip install flake8 pylint

 

설치가 완료되었는지 확인하려면 다음 명령어를 실행하면 된다.

flake8 --version
pylint --version

 

(Flake8 실행)

flake8 my_script.py  # 특정 파일 검사
flake8 my_project/   # 특정 디렉토리 내의 모든 파일 검사

 

(Pylint 실행)

pylint my_script.py  # 특정 파일 검사
pylint my_project/   # 특정 디렉토리 검사

 

Pylint를 실행하면 10점 만점 기준으로 코드의 품질 점수가 출력되며, 개선해야 할 항목이 상세하게 표시된다

 

 

 

(예시)

flake8 실행 콘솔창

pylint 실행 콘솔창

 

 

 

 

 

Flake8은 가볍고 빠르며 스타일 검사에 초점을 맞추고 있지만, 코드의 논리적 오류까지 검사하지는 않는다. 반면 Pylint는 코드의 구조적인 문제를 점검하는 데 강력한 기능을 제공하지만, 검사 속도가 상대적으로 느리고 엄격한 규칙을 적용한다.

 

---

 

※ VS Code에서 Flake8과 Pylint 활성화

VS Code의 settings.json에서 다음 설정을 추가하면 두 도구를 동시에 활용할 수 있다.

{
    "python.linting.enabled": true,
    "python.linting.flake8Enabled": true,
    "python.linting.pylintEnabled": true
}

 

이를 통해 코드를 작성할 때 자동으로 오류와 스타일 문제를 감지할 수 있다.

 

 

 

 

 

Flake8과 Pylint는 Python 코드의 품질을 유지하는 데 필수적인 도구이다. Flake8은 PEP 8 스타일 가이드 준수 여부를 검사하는 데 유용하며, Pylint는 코드 스타일뿐만 아니라 코드의 논리적 오류까지 분석하는 기능을 제공한다. 두 도구를 함께 사용하면 코드 품질을 더욱 향상시킬 수 있으며, Git Hook, CI/CD 파이프라인, IDE 설정 등을 활용하면 보다 효율적인 개발 환경을 구축할 수 있다!