팀 피터스의 파이썬 선(Zen of Python)에 나온 말이지만 파이썬이 항상 이 원칙을 따르는 것은 아니다. 파이썬이 이 이상에 부합하지 않는 영역 가운데 하나는 바로 프로젝트 관리(project management)다. 파이썬 프로젝트를 관리하기 위한 툴과 방법론은 오랫동안 뒤죽박죽이었다. 그러나 지금 떠오르는 포에트리(Poetry)가 사실상의 표준이 될 가능성이 있다.
포에트리는 고(Go)와 러스트(Rust)가 오래 전부터 누려온 올인원 프로젝트 관리 툴을 파이썬에 제공한다. 포에트리는 프로젝트에서 특정 패키지 버전에 대한 결정적(deterministic) 종속성을 가질 수 있도록 하므로 여러 곳에서 일관적인 빌드가 가능하다. 또한 포에트리를 사용하면 프로젝트와 라이브러리를 더 쉽게 빌드, 패키징해서 파이파이(PyPI)에 게시해 다른 사람과 공유할 수 있다.
이번 기사에서는 파이썬 개발 프로젝트에 포에트리를 사용하는 방법, 즉 포에트리를 설정하는 방법과 포에트리를 사용해 프로젝트 종속성과 가상 환경을 구성하는 방법, 그리고 포에트리의 독특한 작동 방식에서 비롯되는 몇 가지 함정을 피해가는 방법을 알아본다.
파이썬에서 포에트리 설정하기
포에트리는 설정부터 다른 파이썬 종속성 및 프로젝트 관리 툴과는 다르다. 포에트리는 pip 대신 맞춤형 설치 프로그램을 사용한다. 설치 프로그램은 사용자 프로필 디렉터리에 포에트리 앱을 추가해서 현재는 물론 앞으로 시스템에 설치할 모든 파이썬에서 포에트리를 사용할 수 있도록 한다.pip install poetry를 사용해 특정 파이썬 설치본에 포에트리를 설치할 수 있지만 이 방법은 1) 다른 시스템 파일과의 충돌 가능성이 있고 2) 다양한 버전의 파이썬과 여러 가상 환경에서 일관적으로 포에트리를 사용하기가 어렵게 되므로 추천하지 않는다.
포에트리로 관리하는 파이썬 프로젝트 만들기
포에트리를 설치했으면 poetry new <project_name>을 입력해 포에트리로 관리하는 프로젝트 디렉터리를 만들 수 있다. 이 명령은 <project_name>이라는 하위 디렉터리를 생성해 프로젝트에 필요한 파일을 배치한다.포에트리 프로젝트를 위한 파일 중에는 다음과 같은 요소가 포함된다.
- pyproject.toml: 프로젝트의 정의 파일. 포에트리는 이 정의 파일을 자동으로 관리한다. 숙련된 사용자라면 직접 이 파일을 편집할 수도 있지만 대부분의 경우 그럴 필요가 없다.
- README.rst: 파이썬 문서에 사용되는 ReStructuredText 파일 형식의 빈 README 파일(문서에 .rst 형식을 사용해야 한다는 규칙은 없다. 단순한 경우에는 마크다운(Markdown)을 사용해도 된다).
- tests: 단위 테스트에 필요한 파일이 포함된 하위 디렉터리. 새 프로젝트에 대한 테스트를 작성하는 습관을 들여야 한다.
- 마지막으로, 프로젝트 이름으로 된 하위 디렉터리가 있다. 프로젝트의 코드는 이 디렉터리에 들어간다.
포에트리에서 파이썬 가상 환경 관리하기
새 포에트리 프로젝트에서 사람들이 가장 먼저 원하는 것은 보통 파이썬 가상 환경이다. 포에트리는 독자적인 방법으로 가상 환경을 다룬다. 프로젝트 디렉터리 내에 가상 환경을 두는 대신, 포에트리는 운영체제에 따라 다음과 같은 중앙화된 캐시 디렉터리에 둔다.- 유닉스: ~/.cache/pypoetry/virtualenvs
- 맥OS: ~/Library/Caches/pypoetry/virtualenvs
- 윈도우: C:\Users\<username>\AppData\Local\pypoetry\Cache\virtualenvs or %LOCALAPPDATA%\pypoetry\Cache\virtualenvs
포에트리식 방법의 장점은 필요할 때 여러 프로젝트에 걸쳐 가상 환경을 공유할 수 있다는 것이다. 다만 이를 위해서는 작업 습관을 바꿔야 한다.
포에트리에서 가상 환경을 설정하려면 프로젝트 디렉터리로 이동해 poetry env use python을 입력한다. 그러면 포에트리가 새 가상 환경을 만들어 캐시 디렉터리에 저장하고 무작위로 생성된 가상 환경 이름을 표시한다(나중에 참고할 수 있도록 이 이름을 따로 기록해 둬야 한다).
부가적인 편의 기능으로, 포에트리는 프로젝트의 pyproject.toml 파일에 나열된 종속성도 설치한다. 다른 곳의 포에트리 프로젝트를 자신의 시스템에 복사해서 설정할 때 정말 유용한 기능이다.
이미 포에트리에서 할당한 가상 환경이 있는 프로젝트 디렉터리에서 poetry env use python을 실행하면 포에트리는 해당 CLI 세션의 컨텍스트에서 그 가상 환경을 활성화한다.
다음 단계는 조금 까다롭다. 포에트리에서 관리하는 가상 환경을 IDE와 함께 작동하도록 하는 부분이다. 예를 들어 비주얼 스튜디오 코드는 프로젝트 디렉터리 내의 가상 환경 존재를 자동으로 탐지하지만 포에트리로 관리되는 가상 환경의 존재를 (아직은) 따로 탐지하지 않는다. 단기적인 해결책은 프로젝트의 settings.json 파일에 포에트리가 가상 환경을 두는 위치를 명시하는 다음과 같은 라인을 추가하는 것이다.
"python.venvPath": "C:\\Users\\username\\AppData\\Local\\pypoetry\\Cache\\virtualenvs"
변경 후 비주얼 스튜디오 코드를 다시 시작해야 한다. 포에트리가 가상 환경을 관리하는 기능을 원하지 않는다면 다음 명령으로 비활성화하면 된다.
poetry config virtualenvs.create false
포에트리에서 파이썬 프로젝트에 종속성 추가하기
포에트리는 프로젝트 실행을 위해 필요한 패키지(프로덕션 종속성), 개발 프로세스 중에만 필요한 패키지(개발 종속성)의 두 가지 프로젝트 종속성을 추적한다. 프로덕션 종속성에는 앱의 기능을 위해 사용하는 모든 서드파티 라이브러리가 포함되며 개발 종속성에는 블랙(black), 마이파이(mypy), 독유틸즈(doctuils)와 같은 코딩 툴이 포함된다.- 프로젝트에 프로덕션 종속성을 추가하려면 poetry add <dependency_name>을 사용한다.
- 개발 종속성을 추가하려면 poetry add <dependency_name> -D를 사용한다.
poetry remove <dependency_name>을 사용해 개발 종속성(-D 스위치를 사용해서 추가된 종속성)을 제거할 때도 마찬가지로 -D 스위치를 사용한다.
poetry add의 작동 방식은 패키지 이름 또는 깃 경로를 지정할 수 있다는 면에서 pip install과 비슷하다(예를 들어 git+https://github.com/developer/project.git#branchname). 비공개 리포지토리를 사용하도록 포에트리를 구성할 수도 있다.
종속성을 확인, 설치하고 나면 포에트리는 프로젝트 디렉터리에 poetry.lock이라는 파일을 생성한다. 이 파일은 모든 다운로드된 종속성의 매니페스트이며 프로젝트의 나머지 부분과 함께 저장해야 한다. 그러면 소스 제어에서 이 프로젝트의 사본을 가져오는 누구나 모든 필수 패키지의 동일한 버전을 받게 된다.
이제 본격적으로 프로젝트를 시작할 준비가 됐다. 이 시점에서 기억해야 할 것은 앞으로 포에트리, 오직 포에트리만 사용해 모든 종속성과 가상 환경을 관리해야 한다는 점이다. editor@itworld.co.kr
함께 보면 좋은 콘텐츠
Sponsored
Surfshark
“유료 VPN, 분명한 가치 있다” VPN 선택 가이드
ⓒ Surfshark VPN(가상 사설 네트워크, Virtual Private Network)은 인터넷 사용자에게 개인 정보 보호와 보안을 제공하는 중요한 도구로 널리 인정받고 있다. VPN은 공공 와이파이 환경에서도 데이터를 안전하게 전송할 수 있고, 개인 정보를 보호하는 데 도움을 준다. VPN 서비스의 수요가 증가하는 것도 같은 이유에서다. 동시에 유료와 무료 중 어떤 VPN을 선택해야 할지 많은 관심을 가지고 살펴보는 사용자가 많다. 가장 먼저 사용자의 관심을 끄는 것은 별도의 예산 부담이 없는 무료 VPN이지만, 그만큼의 한계도 있다. 무료 VPN, 정말 괜찮을까? 무료 VPN 서비스는 편리하고 경제적 부담도 없지만 고려할 점이 아예 없는 것은 아니다. 보안 우려 대부분의 무료 VPN 서비스는 유료 서비스에 비해 보안 수준이 낮을 수 있다. 일부 무료 VPN은 사용자 데이터를 수집해 광고주나 서드파티 업체에 판매하는 경우도 있다. 이러한 상황에서 개인 정보가 유출될 우려가 있다. 속도와 대역폭 제한 무료 VPN 서비스는 종종 속도와 대역폭에 제한을 생긴다. 따라서 사용자는 느린 인터넷 속도를 경험할 수 있으며, 높은 대역폭이 필요한 작업을 수행하는 데 제약을 받을 수 있다. 서비스 제한 무료 VPN 서비스는 종종 서버 위치가 적거나 특정 서비스 또는 웹사이트에 액세스하지 못하는 경우가 생긴다. 또한 사용자 수가 늘어나 서버 부하가 증가하면 서비스의 안정성이 저하될 수 있다. 광고 및 추적 위험 일부 무료 VPN은 광고를 삽입하거나 사용자의 온라인 활동을 추적하여 광고주에게 판매할 수 있다. 이 경우 사용자가 광고를 보아야 하거나 개인 정보를 노출해야 할 수도 있다. 제한된 기능 무료 VPN은 유료 버전에 비해 기능이 제한될 수 있다. 예를 들어, 특정 프로토콜이나 고급 보안 기능을 지원하지 않는 경우가 그렇다. 유료 VPN의 필요성 최근 유행하는 로맨스 스캠은 인터넷 사기의 일종으로, 온라인 데이트나 소셜 미디어를 통해 가짜 프로필을 만들어 상대를 속이는 행위다. 이러한 상황에서 VPN은 사용자가 안전한 연결을 유지하고 사기 행위를 방지하는 데 도움이 된다. VPN을 통해 사용자는 상대방의 신원을 확인하고 의심스러운 활동을 감지할 수 있다. 서프샤크 VPN은 구독 요금제 가입 후 7일간의 무료 체험을 제공하고 있다. ⓒ Surfshark 그 외에도 유료 VPN만의 강점을 적극 이용해야 하는 이유는 다음 3가지로 요약할 수 있다. 보안 강화 해외 여행객이 증가함에 따라 공공 와이파이를 사용하는 경우가 늘어나고 있다. 그러나 공공 와이파이는 보안이 취약해 개인 정보를 노출할 위험이 있다. 따라서 VPN을 사용하여 데이터를 암호화하고 개인 정보를 보호하는 것이 중요하다. 서프샤크 VPN은 사용자의 개인 정보를 안전하게 유지하고 해킹을 방지하는 데 유용하다. 개인정보 보호 인터넷 사용자의 검색 기록과 콘텐츠 소비 패턴은 플랫폼에 의해 추적될 수 있다. VPN을 사용하면 사용자의 IP 주소와 로그를 숨길 수 있으며, 개인 정보를 보호할 수 있다. 또한 VPN은 사용자의 위치를 숨기고 인터넷 활동을 익명으로 유지하는 데 도움이 된다. 지역 제한 해제 해외 여행 중에도 한국에서 송금이 필요한 경우가 생길 수 있다. 그러나 IP가 해외 주소이므로 은행 앱에 접근하는 것이 제한될 수 있다. VPN을 사용하면 지역 제한을 해제해 해외에서도 한국 인터넷 서비스를 이용할 수 있다. 따라서 해외에서도 안전하고 편리하게 인터넷을 이용할 수 있다. 빠르고 안전한 유료 VPN, 서프샤크 VPN ⓒ Surfshark 뛰어난 보안 서프샤크 VPN은 강력한 암호화 기술을 사용하여 사용자의 인터넷 연결을 안전하게 보호한다. 이는 사용자의 개인 정보와 데이터를 보호하고 외부 공격으로부터 사용자를 보호하는 데 도움이 된다. 다양한 서버 위치 서프샤크 VPN은 전 세계 곳곳에 여러 서버가 위치하고 있어, 사용자가 지역 제한된 콘텐츠에 액세스할 수 있다. 해외에서도 로컬 콘텐츠에 손쉽게 접근할 수 있음은 물론이다. 속도와 대역폭 서프샤크 VPN은 빠른 속도와 무제한 대역폭을 제공하여 사용자가 원활한 인터넷 경험을 누릴 수 있도록 지원한다. 온라인 게임, 스트리밍, 다운로드 등 대역폭이 필요한 활동에 이상적이다. 다양한 플랫폼 지원 서프샤크 VPN은 다양한 플랫폼 및 디바이스에서 사용할 수 있다. 윈도우, 맥OS, iOS, 안드로이드 등 다양한 운영체제 및 디바이스에서 호환되어 사용자가 어디서나 안전한 인터넷을 즐길 수 있다. 디바이스 무제한 연결 서프샤크 VPN은 무제한 연결을 제공하여 사용자가 필요할 때 언제든지 디바이스의 갯수에 상관없이 VPN을 사용할 수 있다.