Quando utilizzare il file dei requisiti pip rispetto a install_requires in setup.py?

Sto usando pip con virtualenv per pacchettizzare e installare alcune librerie Python.

Immagino che quello che sto facendo sia uno scenario piuttosto comune. Sono il manutentore di diverse librerie per le quali posso specificare esplicitamente le dipendenze. Alcune delle mie librerie dipendono da librerie di terze parti che hanno dipendenze transitive sulle quali non ho alcun controllo.

Quello che sto cercando di ottenere è che una pip installdelle mie librerie scarichi / installi tutte le sue dipendenze a monte. Quello con cui sto lottando nella documentazione pip è se / come i file dei requisiti possono farlo da soli o se sono davvero solo un supplemento all'utilizzo install_requires.

Userei install_requiresin tutte le mie librerie per specificare le dipendenze e gli intervalli di versione e quindi userei solo un file dei requisiti per risolvere un conflitto e / o congelarli per una build di produzione?

Facciamo finta che io viva in un mondo immaginario (lo so, lo so) e le mie dipendenze a monte sono dirette e garantite per non entrare mai in conflitto o rompere la retrocompatibilità. Sarei costretto a utilizzare un file dei requisiti pip o semplicemente lasciare che pip / setuptools / distribute installi tutto in base a install_requires?

Ci sono molte domande simili qui, ma non sono riuscito a trovarne nessuna così basilare come quando usare l'una o l'altra o usarle entrambe insieme armoniosamente.

La mia filosofia è che install_requiresdovrebbe indicare un minimo di ciò di cui hai bisogno. Potrebbe includere requisiti di versione se sai che alcune versioni non funzioneranno; ma non dovrebbe avere requisiti di versione in cui non sei sicuro (ad esempio, non sei sicuro se un futuro rilascio di una dipendenza interromperà la tua libreria o meno).

Requisiti file d'altra parte devono indicare ciò che si sa fa il lavoro, e possono includere dipendenze opzionali che vi consigliamo. Ad esempio, potresti usare SQLAlchemy ma suggerire MySQL e quindi inserire MySQLdb nel file dei requisiti).

Quindi, in sintesi: install_requiresè tenere le persone lontane da cose che sai non funzionano, mentre i file di requisiti per guidare le persone verso cose che sai funzionano. Uno dei motivi è che i install_requiresrequisiti vengono sempre controllati e non possono essere disabilitati senza modificare effettivamente i metadati del pacchetto. Quindi non puoi provare facilmente una nuova combinazione. I file dei requisiti vengono controllati solo al momento dell'installazione.

ecco cosa metto nel mio setup.py:

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

setup(
    .....
    install_requires=REQUIREMENTS
)

La Python Packaging User Guide ha una pagina su questo argomento, ti consiglio vivamente di leggerla:

• install_requires vs file dei requisiti

Sommario:

install_requiresè lì per elencare le dipendenze del pacchetto che deve essere assolutamente installato affinché il pacchetto funzioni. Non ha lo scopo di bloccare le dipendenze a versioni specifiche, ma sono accettati intervalli, ad esempio install_requires=['django>=1.8']. install_requiresè osservato da pip install name-on-pypie altri strumenti.

requirements.txtè solo un file di testo, su cui puoi scegliere di eseguire pip install -r requirements.txt. E 'destinata ad avere versioni di tutte le dipendenze e subdependencies appuntato, in questo modo: django==1.8.1. Puoi crearne uno usando pip freeze > requirements.txt. (Alcuni servizi, come Heroku, vengono eseguiti automaticamente pip install -r requirements.txtper te.) pip install name-on-pypiNon guarda requirements.txt, ma solo install_requires.

Uso sempre e solo setup.pye install_requiresperché c'è solo un posto da guardare. È potente quanto avere un file dei requisiti e non ci sono duplicazioni da mantenere.