Visual Studio Code 파이썬(Python) 가상개발환경(venv) 셋팅

Visual Studio Code 파이썬(Python) 가상 개발환경(venv) 세팅

PC를 여러 번 초기화하며 개발환경을 세팅하면서 고민도 하고 실제로 이런저런 IDE와 라이브러리들을 설치하면서 고심한 결과 Pycharm과 Visual Studio Code 중에서 Visual Studio Code를 선택하기로 했다.

여러 가지 이유가 있지만, 기억나는 몇 가지의 결론은 아래와 같은 점들에 의해서 결정을 한 것 같다.

 

• 가볍고, 무거움의 차이, Pycharm이 그동안 사용해왔던 이클립스나 기타 IDE들에 비해서 무겁진 않겠지만 기본적으로 느껴지는 무거움과 노트북의 쿨러 소리의 여파로 이후 장기간 사용한다고 생각했을 때 부담스러움이 있었다. 반면 Visual Studio Code는 확실히 가볍다.
• 범용성, Visual Studio Code는 파이썬뿐만이 아니라, 다른 많은 언어 개발에도 활용성이 좋다. 하지만 Pycharm는 Python을 활용한 개발에만 너무 최적화되어있어, 언제가 혹은 언제든 다른 언어로 개발을 해야 하는 상황이 왔을 때를 생각해보면 Visual Studio Code의 사용법이 익숙해지는 게 좋을 거라 생각했다.
• 배움과 적응, Python이라는 언어를 이제야 접하며 기초가 많이 부족하기도 하고, 배워야 할 부분들도 많다. 이런 상황에서는 사실 직접 커맨드 창에 입력해가며 기본적인 명령어들을 작성하고 손에 익히는 부분들이 필요하다고 생각했다. Pycharm의 경우 가상 환경 설정창부터 Python을 개발하는 대부분들 기능들을 강력하게 지원하지만 Pycharm이 없을 경우 아무것도 못하고 손 놓고 있을 수가 없기 때문이다.

이 외에도 여러 가지 크고 작은 이유가 있겠지만, 입문으로서는 아무래도 Visual Studio Code로 마음이 좀 기운다. 물론 Python이란 언어가 익숙해지고, 좀 더 강력한 IDE가 필요해지게 되면 언제든 Pycharm도 사용해볼 마음이 있음은 당연한 일이다.

 

---

1. Visual Studio Code 설치

https://code.visualstudio.com/

Visual Studio Code - Code Editing. Redefined

위의 링크로 이동하여 Visual Studio Code를 다운로드하여야 한다. 접속해서 우측 상단의  DOWNLOAD  버튼을 클릭한다. 나는 Windows10을 64bit 기반으로 진행하고 있기 때문에 젤 왼쪽의 Windows 중에서 System Installer 64Bit를 선택해서 다운로드하였다. 일반 User Installer와 System Installer의 차이는 관리자 권한으로 실행 여부이다. 대부분 개발 시 커맨드 창이나 기타 명령어를 관리자 권한으로 실행하기 때문에 System Installer로 다운로드하였다.

Visual Studio Code 다운로드

다운로드를 하고 설치 파일을 실행해서 Next만 눌리면 설치가 완료되고 Visual Studio Code를 실행할 수 있다.

 

 

2. 프로젝트 생성

별도의 프로젝트 생성 기능이 있다기보다 그냥 나는 Workspace에서 폴더를 생성해서 해당 폴더를 오픈하는 것으로 이용한다. [FIle] - [Open Folder]를 선택해서 원하는 위치의 프로젝트 폴더를 선택한다.

나는 D:\Workspace\python_seed폴더를 생성해서 선택하였다.

Project 폴더선택

welcome창은 그냥 닫아주고, 좌측 해당 프로젝트 EXPLORER에서 우측 버튼 클릭 후 [New File]을 선택해서 아무 이름. py 파일을 생성해준다. 나는 main.py라고 생성해주었다. 그럼 파이썬 확장 프로그램 설치 여부를 우측 하단에서 물어보는데 Install 해주면 된다. 

 

가상 환경이 아직 설정되지 않았기때문에 Python 확장프로그램은 아래와 같이 설치하고, pylint는 설치하지 않았다. 

파이썬 확장프로그램 설치

 

3. 가상환경 설정

가상 환경 설정 시 Visual Studio Code에서 사용하는 터미널(Terminal)의 경우 PowerShell이 기본(Default)로 설정되어있어서, 가상환경 실행이 잘 안 되는 경우가 있으니 [ Ctrl + Shift + P ] 키를 눌러 나타나는 창에 "shell"을 입력해보면 아래 화면과 같이 "Terminal: Select Default Shell"이라고 기본 터미널 설정을 할 수 있는 메뉴가 나타난다. 선택한다.

Visual Studio Code의 Terminal 기본설정 변경1

선택하면 Command Prompt와 PowerShell을 선택할 수 있는데 Command Prompt를 선택한다. 아래의 사진에서 확인할 수 있듯이 윈도의 CMD창과 동일하다.

Visual Studio Code의 Terminal 기본설정 변경2

 

[Ctrl +Shift + `] 키를 눌릴 경우 터미널이 켜진다. 단축키가 싫다면 Terminal - New Terminal 메뉴를 활용한다. 터미널에서 아래와 같이 입력하여 가상 환경을 생성해준다. 제일 끝의 venv만 사용자가 원하는 폴더로 이름을 변경해도 된다.

python -m venv venv

그러면 한 5초? 이내에 아래와 같이 가상 환경이 만들어진다. 별다른 만들어졌다는 메시지는 없다. 아래 좌측은 실제 만들어진 폴더 안에 생긴 파일들, 우측은 명령어 실행 화면이다.

파이썬 가상환경 생성

이후 [ Ctrl + Shift + P ] 키를 눌러 ">select Interpreter"를 검색해서 선택한다.

가상환경 Interpreter선택1

그렇게 되면 좀 전에 생성했던 가상 환경을 선택할 수 있도록 아래와 같이 Python 3.8.2 32-bit ('venv':venv)를 선택할 수 있게 된다, 나는 Python을 3.8 버전을 설치해서 그렇고 파이썬 버전이 따라 다르게 나타날 수 있으나, 위에서 생성한 venv가상 환경 이름과 동일한 것을 선택해주면 된다.

가상환경 Interpreter선택2

 

이후 기존에 열려있던 터미널 창을 닫고, 다시 터미널 창을 열어준다 (Ctrl + Shift + `), 아래 사진과 같이 가상 환경으로 터미널이 나타난다면 가상 환경이 구축된 것이다.

가상환경 구축 성공

4. 가상환경에서의 빌드

빌드는 main.py에서 소스코드 작성 후 F5번을 눌리면 아래와 같이 나타나는데 그 중 Python File로 시작하는 첫번째 항목을 선택하게 되면 빌드(실행) 및 디버그를 시작한다. 콘솔창에서 python main.py로 실행해도 무관하다. (Sanic을 이용한 Framework를 만들예정이라 Sanic기본 코드를 적용해 보았다. 물론, pip3 install Sanic으로 설치 된 상태다)

build

 

* 가상환경은 활성화 된 이후 비활성화 되기전까지 유지됨으로 다른 프로젝트로 가기전에 꼭 비활성화 해줘야 한다. 비활성화 방법은 가상환경 폴더의 Script폴더 내에 deactivate.bat파일을 실행해 주면 된다.

 

5. 기타

위의 상태에서 아까 만들어놨던 main.py파일을 열어보면 우측 하단에 pylint(빌드나 컴파일 시 에러 외에 추가로 자잘한 오류 검사)를 설치할지 물어본다. Install버튼을 클릭해서 설치해본다.

가상환경에 pylint를 설치해보자

설치 버튼을 눌리면, 띄워진 가상 환경 터미널에 설치를 하게 되는데 아래 사진을 보면 생성한 가상환경 내의 Python.exe파일을 이용해서 설치를 하게 된다. 즉, 해당 가상 환경에만 적용되도록 설치가 된 것이다.

pylint 설치

 

확인을 한번 더 해볼 겸 "pip freeze"명령을 이용해 해당 가상환경에 설치된 목록을 확인한다. 

설치된 목록 확인

 

pylint이외에 유용한 설정을 짚고 가 본다면 black(코드 컨벤션)을 설정해주는 것이 좋다. Ctrl + P 혹은 .vscode 폴더 하위의 setting.json파일을 열어 아래와 같이 작성해주자

{
    "python.pythonPath": "d:\\workspace\\python_seed\\venv\\Scripts\\python.exe",
    "python.formatting.provider": "black",
    "python.formatting.blackArgs": [
        "--line-length",
        "100"
    ],
    "editor.formatOnSave": true
}

"python.pythonPath": 본인 설정 유지
"python.formatting.provider": "black", --코드 컨벤션 확장 프로그램 종류설정
"python.formatting.blackArgs": [ --세부 설정
    "--line-length",
    "100"
],
"editor.formatOnSave": true --저장 시 자동 적용여부

설정 및 저장 후 .py파일을 수정하게되면 아래와 같이 blank을 설치 여부를 묻는 창이 나타난다. 설치해주자

black설치

테스트를 위해 기본 예제 소스를 test.py에 생성해두고 저장해보자 (자동정렬이 됨을 알 수 있다.)

테스트 코드는 https://github.com/psf/black 에서 확인할 수 있다.

저장 전

저장 후

 

6. 삽질하면서 메모해둔 몇 개의 내 메모

pip 다운로드

curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py

 

pip 설치

python get-pip.py

 

pip 버전 업

pip install --upgrade pip

 pip 모든 설치 패키지 삭제

pip freeze > requirements.txt
pip uninstall -r requirements.txt -y

pip 모든 패키지 설치

pip install -r requirements.txt

---

7. 다음 시간 예습

이렇게 환경을 구축한 이유는 sanic을 이용해서 파이썬 프레임워크를 만들어 보기 위해서 이다. 아래의 명령을 이용해서 sanic을 설치해보자.

pip3 install sanic

sanic 설치

지금은 위와 같이 진행되며 설치가 되지만, 많은 시행착오가 있었다. 자세한 내용은 다음 작성될 글에서 다루게 될 예정이다.