PyLint로 파이썬 코드 퀄리티 높이기: VS Code, Cursor 자동 린팅 설정 방법

 

파이썬 코드를 작성하다 보면 문법 오류, 잠재적 버그, 스타일 불일치 등을 놓치기 쉽습니다. 특히 프로젝트 규모가 커지거나 여러 사람과 협업할 때는 코드의 일관성과 품질 관리가 더욱 중요해집니다. 이럴 때 '린팅(Linting)' 도구가 큰 힘이 됩니다! 💪 오늘은 대표적인 파이썬 린터(Linter)인 PyLint를 설치하고, VS Code (또는 Cursor 같은 편집기)에서 코드를 저장할 때마다 자동으로 검사하도록 설정하는 방법을 알아보겠습니다.

린팅, 왜 필요할까요? 🤔

• 오류 조기 발견: 실행 전에 문법 오류나 잠재적인 논리 오류를 찾아내 버그를 줄여줍니다.
• 코딩 표준 강제: PEP 8과 같은 코딩 스타일 가이드라인을 따르도록 유도하여 코드의 일관성을 높입니다.
• 가독성 향상: 일관된 스타일과 잠재적 문제 표시를 통해 코드를 더 쉽게 읽고 이해할 수 있도록 돕습니다.
• 협업 효율 증대: 팀 전체가 동일한 코드 품질 기준을 유지하도록 도와 코드 리뷰 부담을 줄이고 협업을 원활하게 합니다.

1단계: PyLint 설치하기

먼저 파이썬 환경에 PyLint를 설치해야 합니다. 터미널(VS Code 내장 터미널 포함)을 열고 다음 명령어를 입력하세요.

pip install pylint

 

(만약 conda 환경을 사용하신다면 conda install pylint 명령어로도 설치할 수 있습니다.)

2단계: VS Code 또는 Cursor 설정하기 (settings.json)

PyLint를 설치했다면, 이제 VS Code(Cursor)가 PyLint를 사용하도록 설정하고, 파일을 저장할 때마다 린팅을 실행하도록 구성할 차례입니다.

1. VS Code를 엽니다.
2. Cmd(Ctrl) + Shift + P를 눌러 명령 팔레트를 엽니다.
3. Preferences: Open User Settings (JSON) 또는 기본 설정: 사용자 설정 열기 (JSON)을 검색하여 settings.json 파일을 엽니다.
4. 열린 settings.json 파일에 다음 설정을 추가하거나 기존 설정에 병합합니다. (Cmd(Ctrl)+F로 python.linting을 검색하여 관련 설정 검색 후 수정하기)

{
    // 다른 설정들...

    // 파이썬 린팅 기능 활성화
    "python.linting.enabled": true,

    // PyLint 린터 사용 활성화
    "python.linting.pylintEnabled": true,

    // 파일 저장 시 자동으로 린팅 실행
    "python.linting.lintOnSave": true

    // 다른 설정들...
}

설정 설명:

• "python.linting.enabled": true: VS Code의 파이썬 린팅 기능을 전반적으로 활성화합니다. 이 값이 false이면 다른 린팅 관련 설정이 모두 무시됩니다.
• "python.linting.pylintEnabled": true: 여러 린터 중 PyLint를 사용하도록 지정합니다. (false로 설정하면 PyLint가 실행되지 않습니다.)
• "python.linting.lintOnSave": true: 파일을 저장(.py 파일)할 때마다 자동으로 PyLint 검사를 실행합니다.

3단계: 확인하기

설정이 완료되었습니다! 이제 Python 파일(.py)을 열고 코드를 일부러 잘못 작성하거나 스타일 가이드에 맞지 않게 수정한 뒤 저장해 보세요. '문제 (Problems)' 패널 (보통 하단에 위치)에 PyLint가 감지한 오류나 경고가 표시되는 것을 확인할 수 있습니다. 문제 부분에 마우스를 가져가면 상세 내용도 볼 수 있습니다.

PyLint를 이용한 자동 린팅 설정은 파이썬 코드의 품질을 관리하고 잠재적인 오류를 미리 방지하는 데 매우 유용합니다. 몇 가지 설정만으로 개발 생산성을 크게 향상시킬 수 있으니, 꼭 설정해서 깔끔하고 안정적인 코드를 작성해 보세요! 읽어주셔서 감사합니다.

 

오늘도 행복하세요~