PyLint를 사용하여 Python 코드 검사

Python 코드의 오류를 검사하고 적절한 Python 코딩 패턴을 권장하며 널리 사용되는 도구인 PyLint는 Python 프로젝트용 Visual Studio에 통합되어 있습니다.

[솔루션 탐색기]에서 Python 프로젝트를 마우스 오른쪽 단추로 클릭하고 Python > PyLint 실행...을 차례로 선택합니다.

Python 프로젝트의 상황에 맞는 메뉴에 있는 PyLint 명령

이 명령을 사용하면 필요한 경우 활성 환경에 PyLint를 설치하라는 메시지가 표시됩니다.

[오류 목록] 창에 PyLint 경고 및 오류가 표시됩니다.

PyLint 오류 목록

오류를 두 번 클릭하면 문제가 발생한 원본 코드로 직접 이동합니다.

모든 PyLint 출력 메시지에 대한 자세한 목록은 PyLint 기능 참조(영문)를 참조하세요.

PyLint 명령줄 옵션 설정

PyLint 설명서의 명령줄 옵션 섹션에서는 .pylintrc 구성 파일을 통해 PyLint의 동작을 제어하는 방법에 대해 설명합니다. 이러한 파일은 Visual Studio 또는 해당 설정을 적용하려는 범위에 따라 다른 곳에 있는 Python 프로젝트의 루트에 배치할 수 있습니다.

예를 들어 프로젝트에서 .pylintrc 파일을 사용하여 이전 이미지에 표시된 "docstring이 없습니다"라는 경고를 표시하지 않으려면 다음을 수행합니다.

  1. 명령줄에서 프로젝트 루트(.pyproj 파일을 찾을 위치)로 이동하고 다음 명령을 실행하여 주석 처리된 구성 파일을 생성합니다.

    pylint --generate-rcfile > .pylintrc
    
  2. Visual Studio 솔루션 탐색기에서 프로젝트를 마우스 오른쪽 단추로 클릭하여 추가 > 항목 종료 중...을 선택하고, 새 .pylintrc 파일로 이동하여 선택하고 추가를 선택합니다.

  3. 편집을 위해 파일을 열면 작업할 수 있는 다양한 설정이 표시됩니다. 경고를 사용하지 않도록 설정하려면 [MESSAGES CONTROL] 섹션을 찾은 다음 그 아래에 있는 disable 설정을 찾습니다. 특정 메시지의 긴 문자열이 표시되며, 원하는 경고를 추가할 수 있습니다. 이 예제에서는 ,missing-docstring을 추가합니다(쉼표로 구분된 기호 포함).

  4. .pylintrc 파일을 저장하고 PyLint를 다시 실행하여 해당 경고가 표시되지 않는지 확인합니다.