vs code에서 python 개발환경 세팅

기존에 intellij를 사용하다가 AI Cursor때문에 vscode로 넘어갔다. 하지만 intellij에 익숙해져 있었는데 vscode의 환경이 너무 어색해서 하나씩 정리하게 되었다.

project에 pythonpath 추가

project root 외에 특정 폴더를 python path에 추가하는 방법이다.
intellij에서는 Project Structure에서 추가할 수 있지만 vscode에는 그런 부분이 UI로 나와있지 않다.
아래와 같이 settings.json에 추가할 수 있다.

{
    "python.analysis.extraPaths": [
        "${workspaceFolder}/module1",
        "${workspaceFolder}/module2"
    ]
}

debug로 실행

debug로 실행할 때 특정 python path가 없으면 오류가 발생할 수 있다. 이때 아래와 같이 launch.json에 추가하면 debug로 실행할 때 해당 경로를 path에 추가하게 된다.

project root에 launch.json를 만들고 아래 내용을 추가한다. launch.json가 있다면 수정한다.

{
    "version": "0.2.0",
    "configurations": [
        {
            {
                "name": "AIDemo Start",
                "type": "debugpy",
                "request": "launch",
                "env": {
                    "PYTHONPATH": "${workspaceFolder}/module1:${workspaceFolder}/module2"
                },
                "program": "${workspaceFolder}/project/main.py",
                "console": "integratedTerminal",
                "args": "--log-config ./config/logger.yml --host 0.0.0.0 --port 8000"
            }
        }
    ]
}

black formatter 설치

Python 코드를 자동으로 포맷팅해주는 기능이다.

Extensions에서 Black Formatter를 설치한다. Black이 아니라 Black Formatter이다. (Microsoft에서 만든 것)

jupyter notebook 로컬 모듈 경로 추가

Jupyter notebook 실행 시 실행 root는 기본으로 현재 파일 위치로 되어 있다. 이를 변경하는 방법이다.

1) notebookFileRoot를 수정하는 방법 (settings.json에 추가)

{
    "jupyter.notebookFileRoot": "${workspaceFolder}"
}

기본값은 : ${fileDirname}으로 되어 있다.

하지만, 이렇게 하면 파일 오픈할 때 상대경로가 안먹는 문제가 있다.

2) jupyter 시작 시 경로 추가하는 방법 (settings.json에 추가)

jupyter kernel 시작 시 현재 workspaceFolder를 추가한다.

{
    "jupyter.runStartupCommands": [
    "%load_ext autoreload",
    "%autoreload 2",
    "import os, sys; sys.path.append('${workspaceFolder}')"
    ]
}

파일 저장할 때 isort 실행하는 방법

intellij의 Optimize imports와 vs code의 Organize imports는 다르다.
그래서 파일 저장할 때 자동으로 import가 정렬되게 하려면 아래와 같이 설정한다.

plugins에서 isort 설치
black formatter 설치 (microsoft)
settings.json에 아래 추가

"[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnType": true,
    "editor.formatOnSave": true,
    "editor.parameterHints.enabled": true,
    "editor.codeActionsOnSave": {
        "source.organizeImports": "always"
    },
}

Run python file할 때 경로를 못찾는 경우

파일 실행 시 추가 path를 못찾아서 발생하는 문제가 생기는 경우가 있다. 이때 아래와 같이 추가한다.

settings.json에 아래 부분 추가

{
    "terminal.integrated.env.windows": {
        "PYTHONPATH": "${workspaceFolder}/module1:${workspaceFolder}/module2"
    },
    "terminal.integrated.env.linux": {
        "PYTHONPATH": "${workspaceFolder}/module1:${workspaceFolder}/module2"
    },
    "terminal.integrated.env.osx": {
        "PYTHONPATH": "${workspaceFolder}/module1:${workspaceFolder}/module2"
    }
}