visual studio code - python 개발환경 세팅

식빵·2024년 8월 13일

Python

목록 보기

2/2

1. Pyenv 설치를 먼저해주세요.

만약 본인이 이미 python 을 설치했다면 어쩔 수 없지만,
만약 아직 설치 안했다면 pyenv 를 설치하시기 바랍니다.

pyenv ?
pyenv 는 유연하게 python 버전을 바꿔가면서 사용할 수 있는 편리한 툴입니다.

Mac, Linux 사용자분들은 이 링크를 보시고
Window 사용자시면 제가 이전에 작성한 글을 참고해주세요

2. VS Code - Plugin 설치

visual studio code 를 켜고 아래와 같은 Python 플러그인들을 설치합니다.

Python
Pylance
Python Debugger
Python Environment Manager
Black Formatter (이거는 포맷터인데, 다른 걸 쓰셔도 됩니다!)
Jupyter

3. 프로젝트 세팅 및 테스트

3-1. 가상환경 세팅

프로젝트 디렉토리를 하나 만들어주고 visual studio code 로 열어줍니다.

좌측에 Python Environment Manager 아이콘을 클릭
GLOBAL ENVIRONMENTS > Pyenv 를 클릭해서 pyenv 로 설치한 파이썬이 목록 확인
만약 없다면 먼저 아무 터미널 열고 pyenv install 명령어로 python 설치
Venv 라는 아이콘 옆에 + 버튼을 클릭해서 새로운 가상환경(venv) 생성

가상환경에 사용할 기반 python 실행파일을 지정합니다.
참고로 위 그림에 나오는 것들은 모두 pyenv 로 설치한 파이썬들입니다.

이후 위처럼 GLOBAL ENVIRONMENTS > Venv 하단에 새로운 가상환경이 생성된
것을 확인할 수 있습니다. 해당 아이콘 옆의 별모양(⭐) 아이콘을 클릭합니다.
이러면 해당 가상환경을 현재 프로젝트(= 디렉토리)에서 사용하게 됩니다.

이후 위에 있는 WORKSPACE EVNIRONMENTS 에서 가상환경이 적용된 것을
확인할 수 있습니다. 만약 적용이 안된 거 같다면 Refresh Environment 를 클릭해줍니다.

ctrl + shift + p 를 클릭하고 create new terminal 를 선택해서
새로운 터미널을 열어줍니다.

이후에 위처럼 자신의 터미널 프로필에 마우스를 가져다 댑니다.
그러면 팝업이 보이는데, 거기에 "Python: Activated environment for" 가 명시되어
있는지 꼭 확인합니다.

만약에 안되어 있으면 간단하게 visual studio code 를 껏다가 다시 켜줍니다.
그리고 다시 확인해보시기 바랍니다.

참고:
venv 를 많이 사용해보신 분들은 아마 (venv) 처럼 터미널에 표기가 되어야
가상환경을 사용한다고 생각할 수 있는데, 윈도우 사용자시면 visual studio code
에서는 위처럼 표출되는 팝업에서 확인해야 합니다. (이게 OS 마다 다르더군요)
더 자세한 건 이 링크를 참조해주세요.

3-2. VS Code 세팅

ctrl + shift + p 을 입력하고 Open workspace settings(JSON) 을 선택합니다.

그러면 위 그림처럼 vs code 세팅용 디렉토리(vscode) 가 생성되고,
안에 settings.json 파일이 생성됩니다.
해당 파일의 내용을 아래와 같이 수정해줍니다.

{
  "python.analysis.typeCheckingMode": "basic",
  "python.analysis.autoImportCompletions": true,
  "python.analysis.fixAll": [
    "source.unusedImports",
    "source.convertImportFormat"
  ],
  //"python.analysis.packageIndexDepths": [
  //  {
  //    "name": "",
  //    "depth": 10,
  //    "includeAllSymbols": true
  //  }
  //],
  "notebook.output.wordWrap": true,
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.unusedImports": "always",
    "source.organizeImports": "explicit"
  }
}

python.analysis.packageIndexDepths 는 auto import 가 잘 안될 때 작성해주세요.
python.analysis.packageIndexDepths 는 곧바로 동작되는 게 아닙니다! 약간의 시간을 두고 적용됩니다. 아무래도 인덱싱 작업이 내부적으로 일어나서 그런듯합니다.
참고: https://github.com/microsoft/pylance-release/issues/3678#issuecomment-1338013453