VSCode에서 Python 디버깅 (launch.json 설정)

Python

Author

gabriel yang

Published

November 26, 2024

VSCode에서 Python 디버깅

Visual Studio Code(VSCode)를 사용해 디버깅 작업을 진행할 때 launch.json 파일을 설정해야 할 때가 많습니다.

특히, 특정 파일을 디버깅할 때 현재 열려 있는 파일의 위치에서 디버깅을 실행하도록 설정하면 편리합니다.

1. launch.json 파일 생성하기

VSCode 실행 후 Run and Debug 열기 VSCode의 왼쪽 사이드바에서 녹색 재생 버튼과 벌레 모양 아이콘을 클릭하거나 Ctrl+Shift+D를 눌러 실행과 디버그 메뉴를 엽니다.
구성 추가 상단의 create a launch.json file 또는 Add Configuration... 버튼을 클릭합니다.
Python 환경 선택 Python 프로젝트에서 작업 중이라면 Python 옵션을 선택합니다. 이렇게 하면 기본 Python 디버깅 구성 템플릿이 생성됩니다.

2. launch.json 수정하기

launch.json은 VSCode가 디버깅 동작을 설정하는 데 사용하는 파일입니다. 다음 설정을 추가하여 현재 파일을 기준으로 디버깅이 실행되도록 구성할 수 있습니다.

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python: Current File",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "cwd": "${fileDirname}",
      "justMyCode": true
    }
  ]
}

주요 설정 항목

program: "${file}" 디버깅할 Python 파일의 경로를 지정합니다. ${file}은 현재 열려 있는 파일을 나타냅니다.
cwd: "${fileDirname}" 현재 디버깅 중인 파일의 디렉터리를 작업 디렉터리로 설정합니다. 이는 파일이 위치한 폴더를 기준으로 실행되도록 보장합니다.
console: "integratedTerminal" 디버깅 출력이 VSCode의 통합 터미널에 나타나도록 설정합니다. 필요에 따라 "externalTerminal"로 변경할 수도 있습니다.

3. 실제 디버깅 실행하기

디버깅하려는 Python 파일을 VSCode에서 엽니다.
상단의 실행 버튼을 클릭하거나 F5를 눌러 디버깅을 시작합니다.
설정한 대로 현재 파일과 동일한 위치에서 디버깅이 시작됩니다.

4. 예제 시나리오

디버깅 대상인 Python 파일 example.py가 다음과 같은 코드라고 가정합니다.

import os

if __name__ == "__main__":
    print("현재 작업 디렉터리:", os.getcwd())
    print("현재 파일 경로:", __file__)

결과

example.py 파일을 열고 디버깅을 실행하면 출력은 다음과 같이 나타날 것입니다.

현재 작업 디렉터리: C:\Users\Username\Project
현재 파일 경로: C:\Users\Username\Project\example.py

이는 cwd가 올바르게 설정되어 파일의 디렉터리를 기준으로 실행된 것을 보여줍니다.

5. 추가 팁

프로젝트 구조가 복잡한 경우, 특정 폴더를 기준으로 디버깅해야 한다면 cwd를 절대 경로로 수정할 수도 있습니다.
여러 개의 디버깅 환경을 구성하려면 configurations 배열에 다양한 설정을 추가하여 상황에 맞게 사용할 수 있습니다.