소개

Visual Studio Code에서 Python 개발 환경을 구축했으므로 비망록으로 남겨 둡니다.

환경

수중에서는 WSL2를 사용해 동작 확인하고 있습니다.
다른 환경에서도 경로 등의 설정을 바꾸면 동등한 환경을 구축할 수 있을 것입니다.

WSL2 (Ubuntu 20.04 LTS) on Windows 10 Pro

전제

Visual Studio Code 및 Python 처리 시스템이 도입되었다고 가정합니다.

소개하는 것

파이썬

Pylance (Language server)

flake8 (Linter)

블랙 (Formatter)

isort (Sort imports)

mypy (Static type checker)

파이썬

우선, 확장 기능을 넣어 갑니다.
확장 프로그램 아이콘에서 Python를 찾아서 설치합니다.


설치 후 처리 시스템의 경로를 설정합니다.
명령 팔레트 ( Alt + X )에서 Preference: Open Settings (JSON)를 선택하여 JSON 편집 화면을 열고 다음을 추가합니다. 이번에 설정한 Ubuntu 20.04 LTS는 다음과 같습니다.

"python.pythonPath": "usr/bin/python3"

※일부 항목은 메뉴바의 파일 > 사용자 설정 > 설정에서 GUI에서도 설정할 수 있습니다.

Pylance

이전과 마찬가지로 Pylance 를 검색하여 설치합니다.
앞으로는 위의 Python 확장을 대체하는 것 같습니다.
Announcing Pylance: Fast, feature-rich language support for Python in Visual Studio Code

설치 후 사용할 언어 서버로 Pylance를 구성합니다.
이전과 마찬가지로 JSON 편집 화면을 열고 다음을 추가합니다.

"python.languageServer": "Pylance"

flake8

Linter를 소개합니다. 여기에서는 flake8 을 사용합니다.
VSCode의 Python 개발 환경에서 pylint 대신 flake8을 도입하여 자동 성형을 설정합니다.

먼저 콘솔에서 pip로 flake8을 설치합니다.

$ pip install flake8

설정 GUI에서 Python > Linting: Enabled를 선택했는지 확인합니다.
기본 pylint를 비활성화하고 flake8을 활성화하려면 다음 항목을 JSON에 추가합니다.

"python.linting.pylintEnabled": false
"python.linting.flake8Enabled": true

또, 후술의 포매터인 black 와 linter 의 룰을 맞추기 위해, 이하도 추기합니다.
The Black code style

"python.linting.flake8Args": [
    "--max-line-length",
    "88",
    "--ignore=E203,W503,W504"
]

블랙

Formatter를 도입합니다. 여기서는 black을 사용하지만 좋아하는 것이 좋다고 생각합니다.
Black: Python 소스 코드를 자동 성형하는 도구

먼저 pip에서 설치합니다.

$ pip install black

또한 JSON에 다음 항목을 추가하고 black을 선택합니다.

"python.formatting.provider": "black"

에디터로 저장했을 때, 자동으로 포매터가 걸리도록, 이하도 추기합니다.

"editor.formatOnSave": true

파이썬에서만 활성화하려면 다음과 같이 작성하십시오.

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

isort

import 문장을 정렬합니다. 특별히 지정을 하지 않는 한, 확장 기능 내부의 것을 사용한다고 합니다.
그러나 저장할 때 자동으로 정렬되도록 다음 설정을 설명합니다.

"editor.codeActionsOnSave": {
    "source.organizeImports": true
}

mypy

형식 주석에 대해 정적 분석을 수행합니다.
mypy 해 갈게

예를 들어 pip로 설치합니다.

$ pip install mypy

JSON에 설정을 작성하여 mypy를 활성화합니다.

"python.linting.mypyEnabled": true

결론

이제 코딩에 집중할 수 있습니다.

마지막으로 설치 명령과 구성 파일의 JSON을 함께 둡니다.

pip install flake8 black mypy

setting.json

{
    // Editor
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
        "source.organizeImports": true
    },
    // Python
    "python.pythonPath": "/usr/bin/python3",
    "python.languageServer": "Pylance",
    "python.linting.pylintEnabled": false,
    "python.linting.flake8Enabled": true,
    "python.linting.flake8Args": [
        "--max-line-length",
        "88",
        "--ignore=E203,W503,W504"
    ],
    "python.linting.mypyEnabled": true,
    "python.formatting.provider": "black",
}