Lint Python 코드

적용 대상:Visual Studio Mac용 Visual Studio Visual Studio Code

Linting은 Python 소스 코드의 구문 및 스타일 문제를 강조 표시합니다. 이는 종종 미묘한 프로그래밍 오류 또는 오류로 이어질 수 있는 틀에 얽매이지 않는 코딩 사례를 식별하고 수정하는 데 도움이 됩니다. 예를 들어 Linting은 초기화되지 않았거나 정의되지 않은 변수의 사용, 정의되지 않은 함수 호출, 누락된 괄호 및 기본 제공 형식 또는 함수 재정의 시도와 같은 더 미묘한 문제를 검색합니다. Linting은 코드 실행 방법을 분석하고 오류를 검색하는 반면 서식 지정은 코드가 표시되는 방식만 재구성하기 때문에 서식과 다릅니다.

PyLint 및 mypy는 Python 코드의 오류를 검사 좋은 Python 코딩 패턴을 장려하는 널리 사용되는 도구입니다. 둘 다 Python 프로젝트용 Visual Studio에 통합됩니다.

Linter 실행

Visual Studio에서 솔루션 탐색기 Python 프로젝트를 마우스 오른쪽 단추로 클릭하고 Python을 선택한 다음 PyLint 실행 또는 Mypy 실행을 선택합니다.

이 명령은 선택한 Linter가 아직 없는 경우 활성 환경에 설치하라는 메시지를 표시합니다.

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

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

명령줄 옵션 설정

Pylint와 mypy는 모두 프로젝트에 대한 린팅 설정을 구성하는 명령줄 옵션을 제공합니다.

이 예제에서는 Pylint의 명령줄 옵션을 사용하여 구성 파일을 통해 PyLint의 동작을 .pylintrc 제어합니다. 이러한 파일은 Visual Studio 또는 해당 설정을 적용하려는 범위에 따라 다른 곳에 있는 Python 프로젝트의 루트에 배치할 수 있습니다(자세한 내용은 명령줄 옵션 참조).

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

1. 명령줄에서 프로젝트 루트(파일이 있는 .pyproj )로 이동하고 다음 명령을 실행하여 주석이 추가된 구성 파일을 생성합니다.

   pylint --generate-rcfile > .pylintrc
   

2. 솔루션 탐색기 창에서 프로젝트를 마우스 오른쪽 단추로 클릭하고 추가>기존 항목을 선택합니다. 그런 다음, 새 .pylintrc 파일로 이동하여 선택하고 추가를 선택합니다.

3. 작업할 수 있는 여러 설정이 포함된, 편집할 파일을 엽니다. 경고를 사용하지 않도록 설정하려면 [MESSAGES CONTROL] 섹션을 찾은 다음 해당 섹션에서 disable 설정을 찾습니다. 특정 메시지의 긴 문자열이 있으며, 원하는 경고를 추가할 수 있습니다. 이 예제에서는 ,missing-docstring을 추가합니다(개요 쉼표 포함).

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

   팁

   네트워크 공유에서 .pylintrc 파일을 사용하려면 UNC(Universal Naming Convention) 경로나 매핑된 드라이브 문자를 사용하여 네트워크 공유의 파일 이름 값을 통해 이름이 PYLINTRC인 환경 변수를 만듭니다. 예: PYLINTRC=\\myshare\python\.pylintrc.