VS Code에서 Python 코드 서식 지정

서식 지정은 소스 코드를 사람이 더 쉽게 읽을 수 있도록 합니다. 줄 간격, 들여쓰기, 연산자 주위의 공백과 같은 특정 규칙 및 관례를 강제함으로써 코드가 시각적으로 더 잘 구성되고 이해하기 쉬워집니다. autopep8 페이지에서 예를 볼 수 있습니다. 코드가 실제로 작동하는 방식에는 영향을 미치지 않습니다.

린팅은 일반적인 구문, 스타일, 기능 오류 및 비표준 프로그래밍 관행을 분석하여 오류를 방지하는 데 도움이 됩니다. 서식 지정과 린팅 사이에는 약간의 중복이 있지만 두 기능은 상호 보완적입니다.

서식 지정 도구 선택

선택한 서식 지정 도구에 대한 확장 프로그램을 VS Code Marketplace에서 검색하십시오.

Microsoft에서 다음 서식 지정 확장 프로그램을 게시합니다.

커뮤니티에서 제공하는 서식 지정 도구 확장 프로그램

또한, 아래는 import 정렬을 지원하는 서식 지정 도구 확장 프로그램입니다.

참고: 위의 표나 Marketplace에서 원하는 서식 지정 도구를 찾을 수 없는 경우, 확장 프로그램을 통해 지원을 추가할 수 있습니다. Python Extension Template을 사용하여 VS Code에 새로운 Python 도구를 통합할 수 있습니다.

기본 서식 지정 도구 설정

서식 지정 도구 확장 프로그램을 설치한 후 다음 단계에 따라 VS Code에서 Python 파일의 기본 서식 지정 도구로 선택할 수 있습니다.

1. VS Code에서 Python 파일을 엽니다.
2. 편집기를 마우스 오른쪽 버튼으로 클릭하여 컨텍스트 메뉴를 표시합니다.
3. 문서 서식 지정을 선택합니다.
4. 드롭다운 메뉴에서 기본 서식 지정 도구 구성을 선택합니다.
5. 목록에서 원하는 서식 지정 도구 확장 프로그램을 선택합니다.

또는 사용자 settings.json 파일의 [python] 범위 아래에 "editor.defaultFormatter"를 설정하여 모든 Python 파일에 대한 기본 서식 지정 도구로 설정할 수 있습니다. 환경 설정: 사용자 설정 열기(JSON) 명령으로 settings.json을 열 수 있습니다.

예를 들어, Black Formatter를 기본 서식 지정 도구로 설정하려면 사용자 settings.json 파일에 다음 설정을 추가합니다.

  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  }

서식 지정 도구 확장 프로그램을 import 정렬 도구로 설정하려면 사용자 settings.json 파일 또는 작업 영역 settings.json 파일의 [python] 범위 아래에 있는 "editor.codeActionsOnSave"에서 기본 설정을 지정할 수 있습니다. 환경 설정: 사용자 설정 열기(JSON) 및 환경 설정: 작업 영역 설정 열기(JSON) 명령을 사용하여 해당 settings.json 파일을 열 수 있습니다. 이렇게 하면 모든 Python 파일에 대해 저장 시 import 정렬이 활성화됩니다.

예를 들어, Ruff를 원하는 import 정렬 도구로 설정하려면 사용자 settings.json 또는 작업 영역 settings.json 파일에 다음 설정을 추가할 수 있습니다.

{
  "[python]": {
    "editor.codeActionsOnSave": {
      "source.organizeImports.ruff": "explicit"
    }
  }
}

코드 서식 지정

편집기를 마우스 오른쪽 버튼으로 클릭하고 문서 서식 지정을 선택하거나 ⇧⌥F (Windows Shift+Alt+F, Linux Ctrl+Shift+I) 키보드 단축키를 사용하여 코드를 서식 지정할 수 있습니다.

코드의 저장 시 서식 지정을 활성화하려면 사용자 settings.json 파일에 다음 설정을 추가할 수도 있습니다.

  "[python]": {
    "editor.formatOnSave": true
  }

일반 서식 지정 설정

대부분의 서식 지정 도구 확장 프로그램에서 지원하는 다음 설정에 대한 자세한 내용은 각 서식 지정 도구 확장 프로그램의 README를 참조하십시오.

서식 지정 문제 해결

서식 지정에 실패하면 다음 가능한 원인을 확인하십시오.

참고: 위에 나열된 원하는 서식 지정 도구를 찾을 수 없는 경우, 확장 프로그램을 통해 지원을 추가할 수 있습니다. Python Extension Template을 사용하면 VS Code에 원하는 Python 도구를 쉽게 통합할 수 있습니다.

다음 단계

• 디버깅 - 로컬 및 원격 Python 디버깅 방법을 알아봅니다.
• 테스트 - 테스트 환경을 구성하고 테스트를 검색, 실행 및 디버그합니다.
• 기본 편집 - 강력한 VS Code 편집기에 대해 알아보세요.
• 코드 탐색 - 소스 코드를 빠르게 이동합니다.
• Python Extension Template - VS Code에 원하는 린터를 통합하는 확장 프로그램을 만듭니다.