Коли використовувати файл вимог pip проти install_requires у setup.py?

Я використовую pip з virtualenv для пакування та встановлення деяких бібліотек Python.

Я думаю, те, що я роблю, є досить поширеним сценарієм. Я є супровідником декількох бібліотек, для яких я можу чітко вказати залежності. Деякі мої бібліотеки залежать від сторонніх бібліотек, які мають транзитивні залежності, над якими я не маю контролю.

Я намагаюся домогтися того, щоб pip installодна з моїх бібліотек завантажила / встановила всі її залежності вище за течією. Я борюся з документацією pip, це якщо / як файли вимог можуть це зробити самостійно або якщо вони насправді є лише доповненням до використання install_requires.

Чи використовував би я install_requiresу всіх своїх бібліотеках вказати залежності та діапазони версій, а потім використовувати лише файл вимог, щоб вирішити конфлікт та / або заморозити їх для виробничої збірки?

Давайте зробимо вигляд, що я живу в уявному світі (я знаю, я знаю), і мої залежності вище за течією прямолінійні і гарантовано ніколи не конфліктують і не порушують зворотну сумісність. Чи змушений би я взагалі використовувати файл вимог pip, або просто дозволити pip / setuptools / distribute встановити все, що базується install_requires?

Тут є багато подібних запитань, але я не міг знайти таких, що були б такими основними, як коли використовувати той чи інший або гармонічно використовувати їх обидва.

Моя філософія полягає в тому, що він install_requiresповинен вказувати мінімум того, що вам потрібно. Він може включати вимоги до версії, якщо ви знаєте, що деякі версії не будуть працювати; але він не повинен мати вимог до версії там, де ви не впевнені (наприклад, ви не впевнені, чи майбутній випуск залежності зламає вашу бібліотеку чи ні).

Файли вимог, з іншого боку, повинні вказувати, що ви знаєте , працює, і можуть включати додаткові залежності, які ви рекомендуєте. Наприклад, ви можете використовувати SQLAlchemy, але запропонувати MySQL, і тому розмістіть MySQLdb у файлі вимог).

Отже, підсумовуючи: install_requiresце тримати людей подалі від речей, які, як ви знаєте, не працюють, тоді як файли вимог спрямовують людей до того, що, як ви знаєте, працює. Однією з причин цього є те, що install_requiresвимоги є завжди перевіряються і не можуть бути відключені без фактичної зміни метаданих пакета. Тож ви не можете легко спробувати нову комбінацію. Файли вимог перевіряються лише під час встановлення.

ось що я помістив у своєму setup.py:

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

setup(
    .....
    install_requires=REQUIREMENTS
)

У Посібнику користувача з упаковки Python є сторінка на цю тему, і я настійно рекомендую вам прочитати її:

• install_requires vs Файли вимог

Короткий зміст:

install_requiresє там, щоб перерахувати залежності пакета, які абсолютно необхідно встановити, щоб пакет міг працювати. Він не призначений для прив’язки залежностей до конкретних версій, але, наприклад, приймаються діапазони install_requires=['django>=1.8']. install_requiresспостерігається pip install name-on-pypiта іншими інструментами.

requirements.txt- це лише текстовий файл, pip install -r requirements.txtпроти якого можна вибрати . Це означало мати версії усіх залежностей і subdependencies покладали, як це: django==1.8.1. Ви можете створити його за допомогою pip freeze > requirements.txt. (Деякі служби, такі як Heroku, автоматично запускаються pip install -r requirements.txtдля вас.) pip install name-on-pypiНе дивиться requirements.txt, лише на install_requires.

Я коли-небудь використовую a setup.pyі install_requiresтому, що є лише одне місце, на яке можна подивитися. Це настільки ж потужне, як наявність файлу вимог, і його не потрібно дублювати.