[TIL] pyenv + poetry로 개발환경세팅 하기 (+ python interpreter setting)

<WHY? 개념 먼저 알기>

(가상환경을 사용하는 이유에 대해서는 설명하지 않음)

더 세부적인, 각각의 서드파티들의 사용 목적 이유에 대해 설명

pyenv & pip & poetry 의 차이점

 

- venv : python 가상환경을 만들어줌

- pyenv: 여러 버전의 python을 설치하고 원하는 python version을 선택할 수 있도록 도와줌

• 사용자별로 글로벌 파이썬 버전을 설정할 수 있어요.
  (Let you change the global Python version on a per-user basis.)
• 프로젝트별로 파이썬 버전을 설정할 수 있어요.
  (Provide support for per-project Python versions.)
• 환경변수로 파이썬 버전을 대체할 수 있어요.
  (Allow you to override the Python version with an environment variable.)
• 한 번에 여러 버전의 파이썬을 사용할 수 있어요.
  (Search commands from multiple versions of Python at a time.)

 

- poetry: 가상환경 안의 패키지 버전 관리 해주는 친구 (== ex. requirement.txt)

 

 

 

 

 

ref.&nbsp;https://dev.to/bowmanjd/python-tools-for-managing-virtual-environments-3bko

 

 

 

---

<APPLY TO> 가상환경 만들어주기

0️⃣ pyenv 를 설치해주자

(brew 설치는 되어있다고 가정! 만약 없다면 intel, m1 잘 구분해서 구글링하기!)

 

0-1. pyenv 를 설치해준다. (아래 명령어 입력)

$ brew install pyenv

 

0-2. vi/vim 에디터를 사용해서 ~/.zshrc 안에 맨 마지막에 아래 내용을 추가한다. ($ vi ~/.zshrc)

export PYENV_ROOT="$HOME/.pyenv"
export PATH="$PYENV_ROOT/bin:$PATH"
if command -v pyenv 1>/dev/null 2>&1; then
  eval "$(pyenv init --path)"
fi

Added syntax when installing pyenv

 

0-3. (아래의 명령어를 통해) 수정된 ~/.zshrc를 현재 shell에 반영한다.

$ source ~/.zshrc

 

[TIP]

linux에서 source 명령어는 shell의 초기화 파일(~/.bash_profile, ~/.zshrc) 을 수정했을 경우 logoff 와 login 을 하지 않고 현재 shell session에 설정을 반영하기 위해서 사용된다.

 

 

0-4. (아래 명령어를 통해): pyenv-virtualenv 설치

$ brew install pyenv-virtualenv

[TIP] pyenv 뿐만 아니라 pyenv-virtualenv도 함께 사용하는 이유

- (이유, 용도의 구분) pyenv가 Python 버전을 바꿔주기 위한 용도라면, pyenv-virtualenv는 가상환경의 패키지의 버전도 함께 바꿔주기 위한 용도 이다.

- (순서) pyenv의 목록에 virtualenv가 포함되기 때문에, pyenv를 먼저 설치한 후 virtualenv를 설치한다.

 

 

0-5. (아래 명령어를 통해) 변경 및 적용

$ echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.zshrc
$ source ~/.zshrc

잘 변경된 것을 확인

0-6. 쉘을 다시 실행한다.

$ exec "$SHELL"

 

 

 

1️⃣ pyenv 를 이용해서 여러가지 python-version 을 설치해주기

 

1-1. (아래 명령어): pyenv를 통해 설치 가능한 python-version 목록 확인

$ pyenv install —list

아래로 더 길게 있음~!

1-2. (아래 명령어): 원하는 파이썬 버전 설치

$ pyenv install [python-version]

 

1-3. (아래 명령어): 특정 파이썬 버전 삭제 == 가상환경 삭제

$ pyenv uninstall [python-version]

 

1-4. (아래 명령어): 내 컴퓨터에 설치된 파이썬 (전체) 목록 확인

$ pyenv versions

 

1-5. (아래 명령어): 지금 내 로컬(내 컴퓨터 전체)에서 사용할 버전 설정

$ pyenv global [python-version]

[Description]

global 이라고 표현하는 이유는, 나의 로컬 PC를 '전체'라고 했을 때, 가상 환경과 그곳에 적용되는 버전은 그 전체의 부분들이다.

부분에 해당되는 것은 local, 전체에 적용한다는 의미로 global이라는 키워드를 사용한다.

 

[Add]

(아래에서 더 나오겠지만,) 가상환경 안에서 $ pyenv local <environment_name> 을 입력하면, 해당 가상환경을 만들었을 때 지정해줬던 python 버전을 local(가상환경, 부분)에서만 사용하겠다는 의미가 된다!

 

 

python global version을 바꿔주는 과정

 

 

2️⃣ pyenv-virtualenv 이용해서 가상 환경 생성

2-1. (아래 명령어로) 의 가상환경 생성

$ pyenv virtualenv (python-version) <environment_name> : python-version 지정
$ pyenv virtualenv <environment_name> : python-version 생략

<environment_name>는 보통 프로젝트와 동일한 이름으로 사용

python-version 을 생략하고 가상환경을 생성하면 내 컴퓨터에서 사용하는 python 버전으로 자동 입력된다.

'fastapi-blog'라는 가상환경을 만들고, 의존하는 python-version도 함께 확인

 

2-2. 애플리케이션 별(=프로젝트 별 =가상환경 별) = loacl 별 파이썬 버전을 설정 (또는 표시) 해둔다.

가상환경을 적용하고 싶은 위치에서 (아래 명령어를 통해) <environment_name>이라는 가상환경 적용

$ pyenv local <environment_name>

가상환경을 해당 위치(local)에 지정 후, 가상환경에서의 python-version 확인

2-1. (위의 명령어 실행하면): 아래 이미지 같이 (현 폴더 위치에) 가상환경 이름을 가진 .python-version 파일이 생성됨 

environment_name 이 fastapi-blog인 경우

 

정확하게 버전이 몇인지는 가상환경 안에서 $ python --version으로 확인할 수 있다.

(위의 명령어는 암묵적으로 python 버전을 알려줌!)

 

가상환경애플리케이션 별 파이썬 버전

 

 

 

 

 

[TIP]

2-1. 만들어진 가상환경의 파이썬 (버전이 있는 위치) 확인하기: $ pyenv which python

2-2. 설치된(=제공하는) 파일들 (위치) 확인하기: $ pyenv which pip

 

 

3. (아래 명령어): 가상환경 삭제하기

pyenv uninstall <가상환경이름>

 

 

 

 

 

3️⃣ 가상환경 활성 & 비활성화 명령어

[활성]
$ pyenv activate <environment_name>
[비활성]
$ pyenv deactivate

만약 현재 폴더 위치에 (위의 pyenv local <environment_name> 명령어로 생성된) .python-version 파일이 있다면

$ pyenv shell 이라는 명령어로 가상환경을 활성화 해줄 수 있다.

 

[TIP]

사실 pyenv shell 명령어는 내가 직접 입력해주지 않아도

.python-version 파일이 있는 폴더에 들어가면 pyenv가 자동으로 .python-version 파일이 가리키고 있는 가상환경을 활성화해준다.

 

 

 

4️⃣ poetry 이용해서 "패키지 버전관리" 해주기!

4-0. 가상환경 활성화 되었다는 전제, pip도 설치되어있다는 전제 (pip는 python설치시 자동 설치됨)

4-1. (아래 명령어): poetry 설치하기

$ pip3 install poetry

 

4-2. (아래 명령어): 애플리케이션 위치(= 가상환경 실행된 위치)에서 사용할 프로젝트 패키지 관리자(poetry)를 생성

poetry init

(위의 명령어 후) 계속 enter(기본 설정값)하면 아래 이미지처럼 toml 파일이 생성됨

기본 설정값으로 poetry 세팅

위의 명령어로 생성된 pyproject.toml 파일 (=poetry package 관리자)

 

4-3. (아래 명령어로) 패키지 설치하기 (in 가상환경)

$ poetry add [package-name]

 

이 경우, 추가한 패키지&버전은 pyproject.toml 파일 안의 [tool.peotry.dependencies] 아래에 적힌다.

7개의 패키지가 설치된 것을 볼 수 있다.

 

[TIP]

[개발하는 입장에서 그때그때 필요한 패키지 설치시] add 명령어를 이용하는게 좋다.

add로 패키지를 설치(추가)했다면 해당 패키지&버전을 바로 사용할 수 있다는 장점이 있다.

 

BUT

[만약 이미 개발이 완료된, 또는 가상환경을 공유하고 싶을 때 전체 패키지&버전을 pyproject.toml 파일로 공유 받는다면]

아래의 명령어로 pyproject.toml 파일에 적혀있는 패키지&버전을 해당 가상환경에 설치해주는 것이 더 빠르다.

$ poetry update
or
$ poetry lock

poetry update 명령어로 다른 패키지를 버전 지정해서 설치하는 모습

(추가 내용)

'poetry lock'와 'poetry update'의 차이점은?

둘 다 Python 패키지 관리 도구인 Poetry를 사용할 때 사용되는 명령어이다.

1. 'poetry lock' 명령은 현재 프로젝트의 의존성을 고정시키는 작업을 수행한다.
Poetry는 'pyproject.toml' 파일을 통해 프로젝트의 의존성 정보를 관리한다.

'poetry lock' 명령은 'pyproject.toml' 파일에 명시된 의존성 버전을 'poetry.lock' 파일에 고정시킨다.

이렇게 하면 프로젝트를 다른 환경에서 재현하거나 배포할 때 정확한 의존성 버전이 사용된다.

2. 'poetry update' 명령은 프로젝트의 의존성을 업데이트하는 작업을 수행한다.
이 명령을 실행하면 'pyproject.toml' 파일에서 정의된 의존성을 최신 버전으로 업데이트하고 'poetry.lock' 파일도 갱신된다.

이렇게 하면 프로젝트가 최신 버전의 패키지를 사용하게 된다.

주의할 점: 의존성을 업데이트할 때 의존성 간의 호환성을 유지해야 하며, 때로는 업데이트 후에 프로젝트 코드가 동작하지 않을 수도 있으므로 테스트가 필요하다.

 

poetry가 실행되면 poetry.lock 파일이 생긴다.

 

4-4. (아래 명령어): 패키지 삭제하기

$ poetry remove [package-name]

 

---

⭐️ 아래 내용은 컴바컴 일 것 같다!!!! 필요한 사람만 참고하기! 😉

위의 내용대로

내가 사용할 패키지들을 poetry 이용해서 install(add, 설치)했는데도

아래 이미지처럼 import fastapi ⬅️ 에 warning 되어있고,

'Import "fastapi" could not be resolved' 라고 나온다면?!?!

‼️ 이유는: python interpreter가 fastapi를 잡지 못하고 있는 상황이다.

python 설정을 다시 해줘서 fastapi(가 있는 위치로) 잘 잡도록 해주자!

 

 

1. $ poetry env info : 현재 가상환경의 python Path가 어디인지 확인한다.

2. (에디터가 vsc인 경우) 하단의 python-interpreter가 위의 1번에 나온 virtualenv-path를 가리키도록(선택,select하도록) 바꿔줄 것이다. 아래 사진의 Select Interpreter 를 선택한다.

python interpreter를 설정해주기 위해서 select interpreter를 선택한다.

3. (에디터가 vsc인 경우) 에디터의 위쪽에 아래 사진과 같이 나온다. 현재 가리키고 있는 python path는 '~/.pyenv/versions/3.10.9/bin/python' 이다.

하지만 우리가 fastapi, pydantic 등 여러 패키지를 설치한 가상환경(local python)의 path는 그 아래에 있는 '~/.pyenv/versions/3.10.9/envs/fastapi-blog/bin/python' 이다.

따라서 우리는 두번째 친구를 선택해주면 된다.

4. 그러면 하단의 python-interpreter 이름도 바뀌게 되고, import 해준 여러 패키지들도 warning 없이 잘 가져와지는 것을 볼 수 있다. 

 

개발환경세팅! 이제 완전 끝!!!!!

시작이 절반이라구,,,! 이제 절반했으니까 나머지 절반(개발+이슈해결+배포)도 화이팅!!!!!🔥