Khi nào sử dụng tệp yêu cầu pip so với install_requires trong setup.py?

Tôi đang sử dụng pip với virtualenv để đóng gói và cài đặt một số thư viện Python.

Tôi tưởng tượng những gì tôi đang làm là một kịch bản khá phổ biến. Tôi là người bảo trì một số thư viện mà tôi có thể chỉ định các phụ thuộc một cách rõ ràng. Một số thư viện của tôi phụ thuộc vào các thư viện của bên thứ ba có các phụ thuộc bắc cầu mà tôi không có quyền kiểm soát.

Những gì tôi đang cố gắng đạt được là pip installtrên một trong các thư viện của tôi tải xuống / cài đặt tất cả các phụ thuộc ngược dòng của nó. Điều tôi đang gặp khó khăn trong tài liệu về pip là nếu / cách các tệp yêu cầu có thể tự thực hiện điều này hoặc nếu chúng thực sự chỉ là một phần bổ sung để sử dụng install_requires.

Tôi có sử dụng install_requirestrong tất cả các thư viện của mình để chỉ định phụ thuộc và phạm vi phiên bản rồi chỉ sử dụng tệp yêu cầu để giải quyết xung đột và / hoặc đóng băng chúng cho bản dựng sản xuất không?

Hãy giả sử tôi đang sống trong một thế giới tưởng tượng (tôi biết, tôi biết) và các phụ thuộc ngược dòng của tôi rất đơn giản và được đảm bảo không bao giờ xung đột hoặc phá vỡ khả năng tương thích ngược. Tôi có bị bắt buộc phải sử dụng tệp yêu cầu pip hay chỉ để pip / setuptools / phân phối cài đặt mọi thứ dựa trên install_requires?

Có rất nhiều câu hỏi tương tự ở đây, nhưng tôi không thể tìm thấy câu nào cơ bản như khi nào sử dụng cái này hay cái kia hoặc sử dụng cả hai một cách hài hòa.

Triết lý của tôi là install_requireschỉ ra tối thiểu những gì bạn cần. Nó có thể bao gồm các yêu cầu về phiên bản nếu bạn biết rằng một số phiên bản sẽ không hoạt động; nhưng nó không nên có các yêu cầu về phiên bản mà bạn không chắc chắn (ví dụ: bạn không chắc liệu bản phát hành phụ thuộc trong tương lai có phá vỡ thư viện của bạn hay không).

Mặt khác, các tệp yêu cầu phải cho biết những gì bạn biết có hoạt động không và có thể bao gồm các phụ thuộc tùy chọn mà bạn đề xuất. Ví dụ: bạn có thể sử dụng SQLAlchemy nhưng đề xuất MySQL, và vì vậy hãy đặt MySQLdb vào tệp yêu cầu).

Vì vậy, tóm lại: install_requireslà giữ cho mọi người tránh xa những thứ mà bạn biết là không hoạt động, trong khi các tệp yêu cầu để dẫn dắt mọi người đến những thứ bạn biết có tác dụng. Một lý do cho điều này là các install_requiresyêu cầu luôn được kiểm tra và không thể bị vô hiệu hóa nếu không thực sự thay đổi siêu dữ liệu gói. Vì vậy, bạn không thể dễ dàng thử một sự kết hợp mới. Các tệp yêu cầu chỉ được kiểm tra tại thời điểm cài đặt.

đây là những gì tôi đã đưa vào setup.py:

# this grabs the requirements from requirements.txt
REQUIREMENTS = [i.strip() for i in open("requirements.txt").readlines()]

setup(
    .....
    install_requires=REQUIREMENTS
)

Hướng dẫn sử dụng bao bì Python có một trang về chủ đề này, tôi thực sự khuyên bạn nên đọc nó:

• install_requires so với các tệp Yêu cầu

Tóm lược:

install_requireslà có để liệt kê các phụ thuộc của gói hoàn toàn phải được cài đặt để gói hoạt động. Nó không có nghĩa là để ghim các phụ thuộc vào các phiên bản cụ thể, nhưng các phạm vi được chấp nhận, chẳng hạn install_requires=['django>=1.8']. install_requiresđược quan sát bởi pip install name-on-pypivà các công cụ khác.

requirements.txtchỉ là một tệp văn bản mà bạn có thể chọn chạy pip install -r requirements.txtngược lại. Nó có nghĩa là để có các phiên bản của tất cả phụ thuộc và subdependencies pinned, như thế này: django==1.8.1. Bạn có thể tạo một cái bằng cách sử dụng pip freeze > requirements.txt. (Một số dịch vụ, như Heroku, tự động chạy pip install -r requirements.txtcho bạn.) pip install name-on-pypiKhông nhìn vào requirements.txt, chỉ ở install_requires.

Tôi chỉ sử dụng một setup.py và install_requiresbởi vì chỉ có một nơi để xem xét. Nó cũng mạnh mẽ như có một tệp yêu cầu và không có sự trùng lặp để duy trì.