Python에서 자동 서식 지정 및 Linting을 위해 VSCode를 구성하는 방법

VSCode Python 코드 자동 서식 지정 및 코드 검사 구성 가이드

VSCode는 유연성과 강력한 기능으로 인해 많은 Python 개발자가 선택하는 코드 편집기가 되었지만, 많은 코드 편집 및 자동화 도구 중 하나일 뿐입니다. 워크플로에 따라 개발자는 PyCharm, Sublime Text 또는 Vim과 같은 다른 IDE나 편집기를 선호할 수 있습니다. 이 가이드에서는 VSCode에 중점을 두고 자동 서식 지정 및 코드 검사를 설정하는 방법을 보여 주지만 다른 도구에도 유사한 원칙이 적용됩니다.

Python 개발자는 간결하고 읽기 쉬운 코드를 위해 노력하고 있으며 VSCode와 같은 도구는 자동 서식 지정 및 코드 검사를 통해 이 프로세스를 단순화합니다. 이 가이드에서는 자동화를 보장하고 수동 개입을 방지하기 위해 구성 파일과 CLI 명령을 사용하여 Python 형식 지정 및 코드 검사를 위해 VSCode를 구성하는 방법을 보여줍니다.

자동 서식 지정과 코드 확인이 필요한 이유는 무엇인가요?

• 자동 서식 지정 일관된 코드 스타일, PEP 8 준수를 보장하고 수동 조정 시간을 절약합니다.
• 코드 검사는 구문 오류, 사용하지 않는 가져오기 및 기타 잠재적인 문제를 조기에 식별합니다.

두 가지가 함께 사용되면 고품질 코드를 유지하고 오류를 줄이는 데 도움이 됩니다.

형식 지정 및 코드 검사에 필요한 도구

Python 코드의 형식을 효과적으로 지정하고 검사하려면 다음 도구가 필요합니다.

검정색(서식 도구)

• 목적: Black은 일관된 코드 스타일과 PEP 8 사양 준수를 자동으로 보장하는 강력한 코드 서식 지정 도구입니다.
• 주요 기능: 수동 조정 없이 코드 서식을 단순화합니다.
• 설치: 실행 pip install black

pylint(코드 검사 도구)

• 목적: pylint는 Python 코드를 분석하여 오류를 식별하고 코딩 표준을 적용하며 사용되지 않는 가져오기 또는 정의되지 않은 변수와 같은 잠재적인 문제를 강조합니다.
• 주요 기능: 오류를 감지하고 모범 사례를 시행합니다.
• 설치: 실행 pip install pylint

Black과 pylint를 이용한 자동 구성

워크플로를 더욱 간소화하려면 저장 시 자동으로 코드 형식을 지정하고 확인하도록 VSCode를 구성할 수 있습니다. 이렇게 하면 수동으로 확인할 필요가 없으며 추가 노력 없이도 코드의 일관성이 유지됩니다.

저장 시 자동 서식 지정 및 코드 검사 활성화

settings.json 파일에 다음 옵션을 추가하세요.

<code class="language-json">{
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}</code>

• "editor.formatOnSave": 파일 저장 시 자동으로 코드 서식을 지정합니다.
• "editor.codeActionsOnSave": 저장 시 사용 가능한 모든 코드 검사 수정 사항을 실행하여 식별된 문제가 자동으로 해결되도록 합니다.

settings.json 구성 파일을 사용하면 VSCode 설정을 수동으로 조정할 필요 없이 형식 지정 및 코드 검사 기본 설정을 정의할 수 있습니다.

프로그래밍 방식으로 VSCode 설정 업데이트

.vscode 디렉토리에 settings.json 파일 생성 또는 업데이트:

<code class="language-json">{
  "python.formatting.provider": "black",
  "editor.formatOnSave": true,
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.formatting.blackArgs": ["--line-length=79"],
  "python.linting.pylintArgs": ["--disable=C0114,C0115,C0116"]
}</code>

이렇게 하면 Black이 포맷터로 활성화되고 줄 길이가 79자로 설정되며 pylint 코드 검사가 활성화되고 특정 docstring 경고가 비활성화됩니다.

추천 확장 프로그램 추가

팀 전체의 코드 일관성을 강화하고 모든 구성원이 필요한 도구를 사용하고 있는지 확인하려면 extensions.json 파일을 프로젝트에 직접 추가할 수 있습니다.

<code class="language-json">{
  "recommendations": [
    "ms-python.python",
    "ms-python.black-formatter",
    "ms-python.pylint"
  ]
}</code>

이 파일을 .vscode 디렉토리에 저장하고 이름을 extensions.json로 지정하세요.

구성 파일의 시각적 표현

다음은 파일과 그 용도에 대한 분석입니다.

文件	用途
.vscode/settings.json	定义项目特定的格式化和代码检查行为设置。
.vscode/extensions.json	推荐团队范围内的开发 IDE 扩展。

디렉터리 구조 예시

<code>.vscode/
├── settings.json   # 配置格式化和代码检查行为
├── extensions.json # 推荐 VSCode 扩展</code>

구성 테스트

형식 지정 및 코드 검사 예시

1. 코딩 문제:

<code class="language-python">   import os

   def example_function():
           print ( "Hello World" )
   print(undefined_variable)</code>

2. Black 실행 후:

<code class="language-python">   import os

   def example_function():
       print("Hello World")

   print(undefined_variable)</code>

3. pylint 실행 후: 다음 경고가 표시됩니다:
   • 사용하지 않은 가져오기: os
   • 정의되지 않은 변수: undefine_variable

블랙과 필린트를 함께 사용

블랙과 필린트를 함께 사용하는 이유는 무엇인가요?

• Black은 자동으로 일관된 형식과 PEP 8 준수를 보장합니다.
• pylint는 코드 문제(예: 사용하지 않는 가져오기, 정의되지 않은 변수)를 식별하고 코딩 표준을 시행합니다.

이 두 도구를 사용한 작업 흐름

업데이트 settings.json:

<code class="language-json">{
  "python.formatting.provider": "black",
  "editor.formatOnSave": true,
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.formatting.blackArgs": ["--line-length=79"],
  "python.linting.pylintArgs": ["--disable=C0114,C0115,C0116"]
}</code>

결론

settings.json 및 CLI 명령을 사용하여 자동 서식 지정 및 코드 검사가 가능하도록 VSCode를 구성하면 원활하고 일관된 개발 워크플로가 보장됩니다. 수동 단계를 피하고 자동화를 활용하면 서식 지정이나 코드 검사 문제에 대한 걱정 없이 고품질 Python 코드 작성에 집중할 수 있습니다.

즐거운 프로그래밍 되세요!

위 내용은 Python에서 자동 서식 지정 및 Linting을 위해 VSCode를 구성하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!