pip의 문제

Python으로 프로그래밍을 하다보면 의존성이 생기고, 의존성이 많아지면 골치아파지기 시작합니다. easy_install 시절에는 관리를 상상도 못 했지만 pip으로 세대교체가 된 뒤로는 그래도 시도는 해볼 수 있게 되었습니다. 하지만 pip도 다른 언어의 패키지 매니저에 비하면 만족스럽지 못합니다. 이유를 몇 가지 들어보겠습니다.

  1. 보통 사용하는 pip install -r requirements.txt 방식은 예상치 못한 결과를 일으킬 가능성이 너무나도 높습니다.
  2. PyPI에 배포하기 위해 주로 쓰이는 setup.py의 경우 정적인 파일이 아닙니다. 따라서 이 파일을 기준으로 설치를 할 수 없으므로 매번 실행을 해봐야 알 수 있습니다.
  3. 1과 2의 방법 모두 버전을 고정(==)하면 보안에 취약한 구버전을 쓰게 될 가능성이 있고, 추후 업그레이드 된 의존성에서 필요 없어진 의존성이 남아돌 수 있습니다.
  4. 1과 2의 방법 모두 버전을 명시하지 않거나 유동적(>=)으로 적용하면 설치할 때 마다 설치되는 의존성의 버전이 달라져서 의존성의 API가 바뀌는 등의 대형사고가 일어날 수 있습니다.
  5. pip을 효율적으로 쓰려면 virtualenv를 만들어서 직접 관리해야합니다. 안 그러면 전역에 설치되어 의존성 지옥이 연출됩니다.

이걸 해결하는 마법의 솔루션이 나왔으니, 그 이름하여 Pipenv입니다.

왜 Pipenv인가?

의존성 관리 도구는 프로그래밍의 역사와 함께 발전해왔습니다. 그리고 다른 언어들은 다들 현대적인 패키징 툴이 있습니다. 가령 node.js에겐 npm이나 yarn이 있고, Rust에겐 cargo가 있죠. 하지만 pip은 너무 옛날 물건이어서 저런 신문물을 따라갈 수 없었죠. 이 문제를 해결하기 위해 Pipenv가 나타납니다.

Pipenv는 다음과 같은 해결책을 제시합니다.

  1. virtualenv는 Pipenv가 알아서 관리한다. 이 기능은 Pyenv와도 연동된다.
  2. 의존성은 모두 Pipfile 으로 관리한다.
  3. 버전 교차 이슈를 해결하기 위해 Pipfile.lock 을 동시에 가진다.

말만 들어선 감이 잘 안오실텐데, 한번 직접 써봅시다.

Pipenv 설치하기

일단 pipenv를 설치해봅시다.

macOS

$ brew install pipenv

Ubuntu

$ sudo apt install software-properties-common python-software-properties
$ sudo add-apt-repository ppa:pypa/ppa
$ sudo apt update
$ sudo apt install pipenv

그 외

$ pip install pipenv

프로젝트 세팅하기

먼저 Project root로 사용할 디렉토리를 하나 만들고 그 안으로 이동합니다.

$ mkdir myproj
$ cd myproj

그 다음 의존성을 pipenv 명령어를 통해 설치합니다.

$ pipenv install requests

이 명령어를 실행하면 다음 3가지 작업이 이뤄집니다.

  1. Python을 찾아서 해당 executable을 이용해서 virtualenv를 생성합니다.
  2. 1에서 만들어진 virtualenv안에 의존성을 설치합니다.
  3. 설치된 의존성에 대한 Pipfile과 Pipfile.lock을 생성합니다.

1에서 생성된 virtualenv의 경우 수동으로 activate 할 수 있지만 굳이 그러지 않아도 pipenv 명령만으로도 사용할 수 있습니다. 2번은 별로 설명할 것이 없지만 3번은 이야기할 거리가 있습니다.

Pipfile과 Pipfile.lock

Pipfile을 열어보면 다음과 같습니다.

$ cat Pipfile
[[source]]
url = "https://pypi.python.org/simple"
verify_ssl = true
name = "pypi"

[packages]
requests = "*"

[dev-packages]

[requires]
python_version = "3.6"

어느 의존성을 어떤 버전으로 어디로부터 설치할지를 저장하고 있습니다. 아까 requests를 설치할 때 아무 버전도 명시하지 않았으므로 *으로 마킹되어있습니다. 이에 따라서 다른 의존성들과 맞춰서 적정한 버전이 설치될 것입니다.

Pipfile.lock을 열어보면 이러한 형태의 내용이 나옵니다. (실행 환경과 시점에 따라 동일하지 않습니다)

$ cat Pipfile.lock
{
    "_meta": {
        "hash": {
            "sha256": "33a0ec7c8e3bae6f62dd618f847de92ece20e2bd4efb496927e2524b9c7b8df8"
        },
        "pipfile-spec": 6,
        "requires": {
            "python_version": "3.6"
        },
        "sources": [
            {
                "name": "pypi",
                "url": "https://pypi.python.org/simple",
                "verify_ssl": true
            }
        ]
    },
    "default": {
        "certifi": {
            "hashes": [
                "sha256:13e698f54293db9f89122b0581843a782ad0934a4fe0172d2a980ba77fc61bb7",
                "sha256:9fa520c1bacfb634fa7af20a76bcbd3d5fb390481724c597da32c719a7dca4b0"
            ],
            "version": "==2018.4.16"
        },
        "chardet": {
            "hashes": [
                "sha256:84ab92ed1c4d4f16916e05906b6b75a6c0fb5db821cc65e70cbd64a3e2a5eaae",
                "sha256:fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691"
            ],
            "version": "==3.0.4"
        },
        "idna": {
            "hashes": [
                "sha256:2c6a5de3089009e3da7c5dde64a141dbc8551d5b7f6cf4ed7c2568d0cc520a8f",
                "sha256:8c7309c718f94b3a625cb648ace320157ad16ff131ae0af362c9f21b80ef6ec4"
            ],
            "version": "==2.6"
        },
        "requests": {
            "hashes": [
                "sha256:6a1b267aa90cac58ac3a765d067950e7dbbf75b1da07e895d1f594193a40a38b",
                "sha256:9c443e7324ba5b85070c4a818ade28bfabedf16ea10206da1132edaa6dda237e"
            ],
            "index": "pypi",
            "version": "==2.18.4"
        },
        "urllib3": {
            "hashes": [
                "sha256:06330f386d6e4b195fbfc736b297f58c5a892e4440e54d294d7004e3a9bbea1b",
                "sha256:cc44da8e1145637334317feebd728bd869a35285b93cbb4cca2577da7e62db4f"
            ],
            "version": "==1.22"
        }
    },
    "develop": {}
}

뭔가 복잡한 JSON이 나왔습니다. 하지만 의미가 잘 보이진 않습니다.

두 파일은 Pipenv에 있어서 중요한데, 먼저 Pipfile의 경우 사람이 보기 위한 파일입니다. 실제로 사람이 직접 프로그램 코드 고치듯 고쳐도 상관 없습니다. 반면 Pipfile.lock의 경우는 자동생성되는 내용입니다. 위에서 언급한 버전 교차 문제와 의존성 버전을 찾기 위해 매번 반복되는 작업을 줄이기 위해 필요합니다. 예전의 requirements.txt를 대신하여 PipfilePipfile.lock을 버전관리하면 됩니다.

잠시만요, 이건 개발할때만 쓰는 건데요

의존성중에는 실제 배포시에는 전혀 필요 없지만 개발단계에서만 필요한 의존성들이 있습니다. 가령 pytest같은 test runner나 flake8같은 linter들이 말이죠.

$ pipenv install --dev flake8

이런 요소들은 설치시에 --dev 인자를 주면 됩니다. 해당 인자를 주고 설치하면 해당 의존성은 [dev-packages]로 지정됩니다.

설치한 의존성 활용하기

설치한 의존성은 사용할 수 있어야 의미가 있습니다. 간단한 HTTP 요청을 하는 프로그램을 작성하여 사용해보겠습니다.

먼저 다음과 같은 내용의 Python script를 작성합니다.

# run.py
import requests

resp = requests.get('https://httpbin.org/ip')
print('IP Address is {}'.format(resp.json()['origin']))

그리고 다음 명령어를 실행합니다.

$ pipenv run python run.py

성공했다면 실행한 환경의 IP Address가 나올 것입니다. 이와같이 pipenv run <명령어>의 형태로 설치한 의존성이 있는 환경에서 명령어를 구동시킬 수 있습니다.

다른 곳에서 의존성 그대로 설치하기

PipfilePipfile.lock은 다른 환경에서 사용할 수 있습니다. 가령 아까 만든 프로젝트를 Git 저장소에 올렸다 치고, 다른 곳에서 clone을 받은 다음에 의존성을 설치하고 싶다면 다음과 같이 합니다.

$ git clone ~~~
$ cd ~~~
$ pipenv install

설치할 의존성 이름을 명시하지 않으면 자동으로 Pipfile.lock 의 모든 내용을 설치합니다.

혹시라도 [dev-packages]도 모두 설치해야한다면 pipenv install --dev 와 같이 --dev를 추가로 지정해주세요.

의존성의 취약점 검사

하지만 한 번 도입한 이후로 의존성을 방치할 것이라면 Pipenv를 쓰는 의미가 퇴색됩니다. 보다 효율적으로 쓰기 위해서는 의존성의 버전업등을 해야할 필요가 있죠.

의존성의 버전을 반드시 올려야하는 상황이라고 하면 역시 보안 취약점이겠죠. Pipenv는 이를 아주 간단한 방법으로 제공합니다.

$ pipenv check

문제가 있는게 있다면 다음 단락을 참조해서 버전을 올리시면 됩니다.

의존성의 업데이트

의존성의 버전을 올려야하는 상황이 있습니다. 그럴 때엔 다음 명령어를 사용합니다.

$ pipenv update

이 명령어를 실행하면 Pipfile에서 지정한 규칙에서 벗어나지 않는 선에서 Pipfile.lock을 가장 최신의 의존성으로 교체하고 그 내용을 기반으로 의존성도 버전업하여 설치합니다.

Pipenv의 한계

위 문단까지만 적고 이 글을 끝냈더라면 저는 사기꾼 약장수가 되었을 것입니다. Pipenv는 분명 좋은 툴이지만 몇 가지 한계가 있습니다.

  1. setup.py가 제공하던 extras_requirement를 지원하지 않습니다. 가령 배포환경용 의존성등을 따로 관리해야한다면 다소 난감한 느낌이 있습니다.
  2. 아직까지 Python의 공식 패키징 툴은 setuptools입니다. 따라서 PyPI에 배포해야하는 프로그램은 역으로 setup.py를 따로 만들어야만합니다.
  3. 버전은 벌써 11이 넘었지만 아직도 가끔씩 불안정한 모습을 보입니다.
  4. lock 파일 생성이 상당히 느립니다. 아마도 Python 패키징 생태계의 태생적인 문제(setup.py)로 보입니다.

결론

그런 이유에서 저는 Pipenv는 아직 Production-ready한 물건은 아니라고 생각합니다. 하지만 간단한 Python App 개발에 있어서는 유용한 프로그램임에 틀림 없습니다. 새로운 App 프로젝트를 시작하신다면 Pipenv를 도입해보시는건 어떨까요?