[python] setuptools setup.py 파일의 install_requires kwarg에 대한 참조 requirements.txt

그것의 얼굴에, 그 보이지 않는 requirements.txt및 setup.py바보 중복, 그러나 그것은 형태가 유사한 반면, 의도 한 기능이 매우 다르다는 것을 이해하는 것이 중요합니다.

종속성을 지정할 때 패키지 작성자의 목표는 “이 패키지를 설치할 때마다이 패키지가 작동하기 위해 필요한 다른 패키지입니다”라고 말하는 것입니다.

반대로 배포 작성자 (다른 시간에 같은 사람 일 수 있음)는 “우리가 함께 모아서 테스트하여 설치해야하는 패키지 목록이 있습니다”라는 점에서 다른 역할을합니다.

패키지 작성자는 다양한 시나리오에 대해 작성합니다. 그들이 알지 못하는 방식으로 작업을 수행하고 패키지와 함께 어떤 패키지가 설치 될지 알 수 없기 때문입니다. 좋은 이웃이되고 다른 패키지와의 종속성 버전 충돌을 피하려면 가능한 한 다양한 종속성 버전을 지정해야합니다. 이것이하는 일 install_requires입니다 setup.py.

배포 작성자는 매우 다른 매우 구체적인 목표, 즉 특정 컴퓨터에 설치된 설치된 응용 프로그램 또는 서비스의 단일 인스턴스를 작성합니다. 배포를 정확하게 제어하고 올바른 패키지를 테스트하고 배포하려면 배포 작성자가 종속성 및 종속성의 종속성을 포함하여 설치할 모든 패키지의 정확한 버전과 소스 위치를 지정해야합니다. 이 사양을 사용하면 배포를 여러 컴퓨터에 반복적으로 적용하거나 테스트 컴퓨터에서 테스트 할 수 있으며 배포 작성자는 매번 동일한 패키지가 배포 될 것을 확신 할 수 있습니다. 이것이 무엇을 하는가 requirements.txt입니다.

패키지와 버전의 큰 목록처럼 보이지만이 두 가지 작업은 매우 다릅니다. 그리고 이것을 섞어서 틀리게 만드는 것은 확실히 쉽습니다! 그러나 이것을 생각하는 올바른 방법 requirements.txt은 모든 다양한 setup.py패키지 파일 의 요구 사항에 의해 제기 된 “질문”에 대한 “답변” 입니다. 직접 작성하는 대신, pip에게 setup.py원하는 패키지 세트의 모든 파일 을보고, 모든 요구 사항에 맞는 패키지 세트를 찾은 다음, 설치 후 “고정”으로 생성하여 생성됩니다. “해당 패키지 목록을 텍스트 파일로 저장합니다 (여기서 pip freeze이름이 나오는 곳).

따라서 테이크 아웃 :

• setup.py여전히 실행 가능한 가장 느슨한 종속성 버전을 선언해야합니다. 그 작업은 특정 패키지가 작동 할 수있는 것을 말하는 것입니다.
• requirements.txt전체 설치 작업을 정의하는 배포 매니페스트이며 어떤 패키지에 묶여 있다고 생각해서는 안됩니다. 배포 작업을 수행하는 데 필요한 모든 패키지의 전체 목록을 선언해야합니다.
• 이 두 가지 내용은 기존과 다른 내용과 이유를 가지고 있기 때문에 서로를 단순히 복사하는 것은 불가능합니다.

참고 문헌 :

• Python 패키징 사용자 안내서의 install_requires 및 요구 사항 파일

답변

import os
from setuptools import setup

with open('requirements.txt') as f:
    required = f.read().splitlines()

setup(...
install_requires=required,
...)

.

# fetch specific dependencies
--no-index
--find-links deps/

# install package
# NOTE: -e . for editable mode
.

from pip.req import parse_requirements
from pip.download import PipSession

install_reqs = parse_requirements(<requirements_path>, session=PipSession())

reqs = [str(ir.req) for ir in install_reqs]

setup(
    ...
    install_requires=reqs
    ....
)