2019.01.10 데이터 사이언스

Visual Studio Code로 편리한 Pylife!

엔씨의 데이터 전문가들이 여러분을 데이터의 세계에 가까워질 수 있도록 도와드립니다.

먼저 Python으로 코딩을 시작하려는 당신의 어둡고 막막한 분석길. 등불을 켜 드립니다.

조금 더 Python을 편리하게 잘~쓸 수 있도록 I&I실의 DANBI BLOG가 즐거운 Pylife를 위한 방법을 소개합니다.



들어가며 

아마 각자 알아서 잘 쓰는 Python 설정이 있을 것이다. 그대로 잘 쓰면 되겠다. 하지만 막 Python으로 코딩을 시작하려는 사람이 있다면 이런 글도 조금은 도움이 되지 않을까 한다. 이 가이드의 목표는 다음과 같다.

  1. 되도록 꼬이지 않게 Python 쓰기 (모든 것이 그렇듯이 쓰다 보면 이 녀석도 꼬인다.)
  2. 되도록 편리하게 쓰기
  3. OS를 가리지 않고 쓰기

Python이 무척 훌륭한 언어지만 가이드가 아주 친절하지는 않다. 입문서들을 봐도 혹은 웹서핑을 해봐도 그렇다. 아울러 같은 오픈소스 언어라도 RStudio 같은 편리한 개발 툴까지 손에 쥐여주는 R에 비해서 어딘가 불편하고 부족하다는 느낌을 받을 때도 있다. Python을 쓰면서 불편하다고 느껴본 적 없다, 라는 분들은 더 이상 글을 안 읽어도 된다.

이 가이드는 거의 R + RStudio에 근접한 수준으로 Python을 쓰게 하는 데 필요한 작업을 다룬다. 부디 이 글을 보는 분들에게 시간 단축의 축복 있으라! 가이드는 다음과 같은 세 가지 영역을 다룬다.

  1. 어떤 Python 배포판을 쓸까?
  2. 어떻게 쓸까?
  3. 무엇과 함께 쓸까?

어떤 Python 배포판을 쓸까?

나는 하드코어하게 그냥 바닐라(생짜) Python을 쓰겠어, 라고 결심해도 좋겠다. 하지만 초심자라면 곧 여러 장애물을 만나게 될 것이다. 특히 윈도우를 쓰는 이용자라면 더욱 그렇다. CLI(command line interface)를 맥OS나 리눅스 만큼 자유롭게 쓸 수 없기에 답답할 때가 많다. 게다가 PATH 걸기 등에서 문제가 생기면 꽤 난감하다. 각종 패키지 또한 누가 한 번 더 걸러서 잘 관리를 해주고 그 녀석들을 끌어다 쓰면 조금 더 편리하게 쓸 수 있지 않을까 싶다. 이러한 목적에 딱 맞는 것이 아나콘다(Anaconda) 사에서 배포하는 아나콘다 배포판이다. 아마도 Python을 쓰는 사람이라면 아나콘다를 한 번쯤은 깔아보았을 터다. 우리도 아나콘다를 쓸 것이다. 아나콘다 배포판이 좋은 이유는 두 가지 정도다.

  1. 아나콘다에서 패키지 관리를 성실하게 해준다.
    • 때로는 바닐라 버전보다 아나콘다 버전의 성능이 뛰어난 경우도 있다.
  2. 아나콘다에서 제공하는 가상 환경이 편리하고 훌륭하다.
    • 아래 가상 환경을 다시 설명할 것이다. 가상 환경을 쓰기 위해 virtualenv 패키지를 써도 좋겠지만 패키지 관리까지 한방에 해결할 수 있는 아나콘다의 가상환경이 조금 더 편리하다.

1이야 그렇다고 치고 2는 정말 중요하다. 보통 “Python + 필요 패키지”를 깔아서 쓰고 있을 것이다. 하지만 이렇게 여러 패키지를 깔면 깔수록 무거워지고 문제가 발생할 소지가 높다. 만일 작업 환경을 필요에 따라서 분리해 관리한다면, 문제가 생겼을 때 이 환경만 날려버리면 된다. 패키지 하나 잘못 깔았다고 낙담할 필요가 없다. 아울러 필요한 구성만 갖추기 때문에 다른 측면에서도 약간의 이익을 볼 수 있다.

이제 아나콘다를 쓰기로 했다고 치자. 아나콘다도 두 가지로 배포판이 제공한다. 종합 배포판인 아나콘다 보다 핵심 만을 발라낸 Miniconda가 좋다. 보통 아나콘다를 풀 버전을 깔면 (내 기준으로는) 쓸 데 없는 것들이 같이 깔린다. 일종의 합집합 개념의 여러 소프트웨어를 제공하는데, 아나콘다 회사에서 권장하는 방식에 꼭 적응해야 할 필요는 없다. 예를 들어, 개발 환경으로 Spyder를 쓰지 않는데 깔 필요는 없지 않을까? 하드 디스크의 용량이 부족한 시대는 아니지만, 잘 쓰지 않는 것을 갖고 있을 필요도 없다.


어떻게 쓸까?

일단 미니콘다를 Python 3.x 버전으로 (전부 “Next”를 눌러) 깔았다고 가정하자. 대신 미니콘다를 쓰려면 약간의 CLI를 활용할 줄 알아야 한다. 맥OS나 리눅스에서는 그냥 터미널을 열고 쓰면 되니, 윈도우를 기준으로 설명하겠다.

일단, 탐색창에서 anaconda prompt를 검색하면 다음과 같이 뜬다. 윈도우에서 발생할 수 있는 각종 문제를 해결한 아나콘다 전용창이라고 생각하면 되겠다. 아나콘다 관련 명령어들은 이 녀석을 띄우고 실행시키면 좋다.

아나콘다의 각종 명령어에 대한 자세한 해설은 링크와 같다. 하지만 엑기스만 뽑아서 간단히 설명하도록 하자. 창을 실행하면 “(base)”라는 문구가 보일 것이다. 이는 현재 아나콘다가 실행되고 있는 환경을 뜻한다. 이미 Python 가상환경이 들어와 있다! Miniconda의 클라이언트와 함께 Python 3.x 버전이 깔려 있고 녀석을 기본으로 쓰겠다는 의미다.

  • conda의 활용법을 자세히 알고 싶다면 LINK를 참고하라.
  • 가상 환경에 관한 자세한 내용은 LINK를 참고하라.

Update Conda

  • 매번 콘다를 실행하고 실행해야 할 명령이다.
  • 아나콘다 배포판을 관리하는 메타툴이 conda이고 이 녀석을 업데이트하라는 뜻이다. 제 머리 깎는 중인 셈이다.

Create

  • 앞으로 사용자가 각자 지정해주는 부분은 한글로 표기하도록 한다. 여기서는 “환경이름”이 이에 해당한다.
  • create 명령어에 여러가지 옵션이 있지만 여기서는 Python 버전만 지정하도록 하겠다.
  • 이렇게 설치된 아나콘다의 환경은 윈도우 기준으로 ProgramData\Miniconda3\envs 에 설치되어 있다. ProgramData가 보통 숨은 폴더 처리가 되어 있다. 이 폴더를 보려면 탐색기 옵션을 고쳐야 한다. LINK1LINK2를 참고 하라.

Activate env, and…

다음으로 환경으로 진입해야 한다.

위의 명령어는 윈도우 기준이다. 맥OS나 리눅스는 source activate 환경이름을 쓰면 된다. 이제 원하는 패키지를 깔면 된다.

사례로 numpy 패키지를 깔아 보았다. 위 명령어는 conda 명령어로 conda-forge 채널을 통해 numpy를 설치한 것이다. 통상적으로 pip 명령어를 써서 패키지를 인스톨해도 상관없다.

View env

  • 현재 콘다 내에서 사용할 수 있는 환경을 보여준다.

Remove env

환경에 문제가 생겼을 경우 이렇게 지우면 된다.

  • 아니면 앞서 봤던 폴더에 환경 이름의 폴더를 지워도 된다.
  • env의 이름을 바꾸고 싶으면 해당 폴더의 이름을 바꿔주면 된다.

Copy env

이미 설치된 환경(클론 되는 환경)을 다른 이름(클론 될 환경)으로 카피하고 싶으면 아래의 명령어를 활용하자.

  • 환경을 복제하고 싶으면 그냥 해당 폴더를 복사에 붙인 후 다른 이름을 붙여주면 된다.

Enter your env

이제 필요한 패키지들을 깔아서 쓰면 된다. 그전에 잠깐! 필요한 패키지들은 해당 환경 안에 깔아줘야 의도한 대로 쓸 수 있다! 환경에 진입하도록 하자.


환경에서 나가기 위해서는

  • 윈도우에서는 이렇게 하면 된다. 요즘 miniconda 윈도우 버전에서는 conda 명령어를 생략해도 환경에 잘 진입된다.
  • 맥OS나 Linux라면 conda 대신 source를 치면 된다.

무엇과 함께 쓸까?

이제 conda와 잘 어울리는 짝으로는 MS에서 무료로 배포하는 Visual Studio Code(VSC)를 권한다. 개인적으로 마소에서 낸 제품 중 최고의 걸작이 아닐까 싶다. VSC에 대한 자세한 설명은 생략하자.

Python을 VSC와 함께 쓸 때의 장점은 다음과 같다.

  • 여느 에디터의 장점들
    • 다양한 테마
    • 단축키
    • 탭으로 필요 명령어 채우기
    • 내부에서 터미널(cmd)를 실행 가능
  • Git이 통합되어 있어서 git 관리가 편리
  • 다양한 익스텐션과 편리한 설치
  • conda 환경을 지정해 실행 가능
  • Jupyter의 환경을 그대로 가져와서 실행 결과를 바로 보여주기

이런 것들을 구현해주기 위해서 작업 환경에 두 가지 Python 패키지를 깔면 된다.

  • Jupyter or Jupyerlab
  • pylint

생성한 작업환경 내에서 아래와 같이 두 개의 패키지를 설치한다.

위에서 Jupyterlab 대신에 Jupyter를 깔아도 무방하겠다. pylint의 경우 해당 conda 환경에 안 깔려 있으면 VSC에서 깔지 않겠느냐고 물어보고, conda로 깔지 pip로 깔지까지 물어본다. 혹시 생략했다면 VSC안에서 처리가 가능하다.

이렇게 깔아 놓고 *.py을 불러오자. 에디터 창에서 매직 코멘트로 #%%을 쓴다. 매직 코멘트는 pylint 패키지가 해당 명령어를 Jupyter로 넘길 수 있도록 지정한다. VSC에서 pylint가 제대로 작동한다면 매직 코멘트 위로 다음과 같은 화면을 보게 될 것이다.

위 그림의 빨간색 박스에서 “Run Call”은 해당 매직 코멘트 블록을 실행하라는 의미다. Jupyter 내에서 한 블록으로 이해하면 된다. pylint의 작동원리는 해당 코멘트를 Jupyter로 넘겨 실행한 후 이를 받아서 다시 VSC 내에 뿌려준다. 결과는 아래와 같이 제법 번듯하다! 화면의 오른쪽 창은 jupyter의 실행 결과와 동일하다.

앞서 conda를 통해서 다양한 가상 환경을 설치했다면 이 환경을 선택해 VSC에서 실행할 수 있어야 할 것이다. 위의 창에서 창 하단의 보라색 줄을 보자.

저 위치를 클릭하면 에디터 위쪽으로 아래 같은 화면이 뜬다. 화면에서 해당 환경을 선택하면 된다.


주의 사항

Python 환경이 제대로 뜨지 않을 때

가끔 콘다 환경을 세팅한 후 해당 환경이 VSC에서 안 뜨는 상황이 발생할 수 있다. 그럴 때에는 해당 환경에 pylint가 설치되어 있는지 확인한 후 설치되어 있다면 환경 선택 부분에 리로드 아이콘을 눌러주자. 그냥 에디터를 다시 실행해도 된다. 그러면 해당 환경을 확인해 선택할 수 있을 것이다.

Jupyter 환경이 로딩되지 않을 때

이 글을 위해서 새로 깔린 윈도우에서 위의 환경을 테스트해 봤다. 다 괜찮았는데 Jupyter notebook이 없다는 메시지가 뜨기도 하더라. 이때는 File → Preferences → Extensions로 가서 필요한 확장팩을 깔아 주자. 옆에 뜬 검색창에 Python이라고 치면 설치 가능한 VSC 확장팩들이 뜬다. Windows 10에서 “Anaconda Extension Pack”을 깔아서 문제가 해결되었다. VSC의 매력 중 하나는 광범위한 확장팩에 있다. 패기 있게 다른 패키지들도 실험해보시면 좋겠다.

VSC에서 터미널 쓰기

VSC 안에는 사실 터미널도 들어 있다. 즉, 외부 터미널 실행 없이도 VSC 안에서 다 해결 가능하다는 뜻이다. 메뉴를 뒤져 터미널을 실행시키고 콘다 명령어를 실행시켜보자. 아마 에러가 뜰 것이다. 현재 VSC가 호출한 터미널은 윈도우 기본 터미널이고, 여기에는 conda가 세팅되어 있지 않기 때문에 생기는 일이다. 어떻게 해야 할까?

  • conda prompt의 실행 환경을 바꾸자. 위 스크린 샷의 실행 환경에서 마우스 우클릭을 한 후 속성 창을 열어보자. 녀석이 각종 패키지를 깔고 하드를 조작할 수 있으려면 관리자 권한이 부여되어야 한다. “바로가기” 탭에 고급에서 설정할 수 있다.

  • 두번째로 “바로가기” 탭에 대상 항목의 내용을 복사해두자. 여기 내용은 conda prompt를 실행할 수 있는 구체적인 명령어가 담겨 있다. 이 글을 쓰는 컴퓨터의 세팅에서는 아래와 같다.

  • VSC에서 File → Perefrences → Settings로 간다. – VSC에서 File → Perefrences → Settings로 간다. 검색창에 “terminal”을 넣고 엔터를 치면 아래 스크린 샷과 같은 설정화면이 나타난다.

  • 검색창에 “terminal”을 치면 Features 아래 Terminal을 고르고 우측 창에서 “Edit in settings.json”을 선택한다.
  • 그리고 아래 스크린샷처럼 세팅 아래 위에서 복사한 주소를 넣는다. 주의할 점은 아래와 같이 되도록 넣어야 한다.

  • 이제 VSC에서 terminal을 실행하면 conda prompt와 동일한 환경이 뜬다.

A nice practice

이렇게 쓰면 좋다,라는 모델 케이스를 정리해보자. 물론 “이게 최선”은 아니겠지만, 그래도 꽤 삽질을 거친 결과니 참고하면 좋을 듯하다. 가장 번거롭고 난이도가 높은 윈도우 기준이다.

  1. miniconda 설치
  2. VSC 설치
  3. miniconda에 Python 작업 환경 설치 및 환경별 패키지 설치
  4. VSC 실행
  5. 필요한 *.py 생성 혹은 로딩
  6. VSC를 통해 작업

One more tip

매번 이렇게 환경을 설치해서 쓰기 귀찮을 수 있다. 그렇다면 많이 쓰는 공통 세팅을 하나 만들어 두고 이 녀석을 복사해서 쓰면 되겠다. 앞서 보았듯이 conda create.. 명령으로 환경을 복사해서 쓰거나 아니면 그냥 폴더/디렉토리로 들어가서 내용을 복사한 뒤 이름을 바꾸면 된다. 실은 나도 그렇게 쓰고 있다.

아울러 코드를 배포할 일이 있을 때 실행 환경을 담보해야 할 것이다. 이럴 때는 yml을 쓰면 좋다.

yml 사용하기

yml 파일을 생성해서 한방에 패키지들을 설치하는 방법은 다음과 같다.

현재 환경을 yml 파일로 저장한다. 해당 yml을 다시 환경으로 풀려면

해당 yml 파일에서 환경을 복원한다. 작업한 환경을 yml로 포팅해 두면 패키지의 버전까지 기억했다가 그대로 복원한다.


NCSOFT DANBI BLOG(https://danbi-ncsoft.github.io)
Data Analytics aNd Business Insights

엔씨소프트에 존재하는 다양한 데이터에 대한 분석을 통해 인사이트를 찾고 기계학습 및 통계 모델링을 이용해 고도화된 지표 및 시스템을 개발합니다.

엔씨의 살아있는 데이터 이야기 DANBI BLOG 바로가기(링크)

TOP