Poetry (v1.8.2)

<aside> 💡 패키지 의존성 및 가상환경을 하나의 툴에서 편리하게 관리 가능

</aside>

프로젝트 설정 후 pyproject.toml에 프로젝트 메타데이터와 의존성 기록됨
기록된 의존성을 설치할 때 poetry.lock 파일 참조 → Github에 커밋해야 협업 시 모두가 같은 버전의 의존성 위에서 작업할 수 있다
- poetry.lock 이 없는 최초의 경우 pyproject.toml 에 기록된 의존성을 설치하고 이를 poetry.lock 파일 생성 후 의존성과 버전을 명시하여 저장
- poetry.lock 이 존재하면 동일하게 pyproject.toml 에 기록된 의존성을 설치하지만, poetry.lock 에 명시된 버전 사용
- 결국 poetry.lock 만 형상 관리가 잘 되어 있다면 협업 시 문제가 없다

# poetry 버전 업그레이드
poetry self update

# 신규 프로젝트 설정
poetry new [new project name]

# 기존 프로젝트 설정(프로젝트 루트로 이동 후)
poetry init

# 의존성(패키지) 추가
**poetry add <package name>[==version]

# 이미 존재하는 패키지의 버전 수정
poetry add <package name><==version>
poetry add <package name>@latest**

# 의존성 삭제
**poetry remove <package name>**

# 의존성 설치
poetry install

# poetry.lock을 현재 환경에 반영
# --dry-run 옵션으로 실제 반영이 아닌 체크만 가능
**poetry install --sync**

# 가상환경 활성화
**poetry shell**

# 가상환경 비활성화/종료
deactivate
exit

# 스크립트 실행
poetry run <command>

# 현재 환경의 의존성을 poetry.lock에 반영
poetry update [dependency,]

# pyproject.toml 검증
# pyproject.toml과 poetry.lock 일관성 확인
poetry check

# 설치된 패키지 확인 (파일 기준)
# pip show <package name>으로 해야 가상환경의 패키지 버전을 보여주는 듯하다
poetry show [package name]

# lock file의 패키지들을 호환가능한 최신 버전으로 업데이트 (설치는 하지 않는다)
# --no-update 옵션으로 업데이트 없이 refresh (pyproject.toml에 맞게)
poetry lock

# 가상환경 정보
poetry env info

가상환경 활성화/비활성화
수동 패키지 관리

의존성 버전 표기 방식

참고

https://github.com/PREDICTIONAI/BE-QB-EDITOR/pull/315/files

requirements.txt에서 관리하던 의존성 마이그레이션
- poetry 가상환경 활성화 후
```
poetry add $(cat <requirements.txt 파일 경로>)
```
Dockerfile에서 의존성 설치 명령
- Poetry 기본 설치 설정이 editable 모드로 진행되기 때문에, 의존성 설치만 하고 싶은 경우 --no-root 옵션과 함께 설치해야 한다
```
poetry install --no-root
```

‣

pre commit

  # ...
  
  - repo: <https://github.com/python-poetry/poetry>
    rev: "1.8"
    hooks:
      - id: poetry-check
      - id: poetry-lock
        args: [ --no-update ]