Setup.py'deki pip gereksinimleri dosyası yerine install_requires dosyası ne zaman kullanılır?

Bazı Python kitaplıklarını paketlemek ve yüklemek için virtualenv ile pip kullanıyorum.

Yaptığım şeyin oldukça yaygın bir senaryo olduğunu hayal ediyorum. Bağımlılıklarını açıkça belirleyebileceğim birkaç kitaplığın bakımcısıyım. Kütüphanelerimden birkaçı, üzerinde kontrolüm olmayan geçişli bağımlılıkları olan üçüncü taraf kitaplıklara bağımlı.

Başarmaya çalıştığım şey, pip installkütüphanelerimden birinin tüm yukarı akış bağımlılıklarını indirmesi / yüklemesidir. Pip dokümantasyonunda uğraştığım şey, gereksinim dosyalarının bunu kendi başlarına yapıp yapamayacakları / nasıl yapabilecekleri veya gerçekten kullanmanın bir eki olup olmadıklarıdır install_requires.

Kullandığım misiniz install_requiresbir çatışmayı çözmek ve / veya üretim yapı için bunları dondurmak için bağımlılıkları ve sürüm aralıklarını belirlemek için benim kütüphanelerin hepsi ve daha sonra sadece bir gereklilik dosyasını kullanmak?

Hayali bir dünyada yaşadığımı varsayalım (biliyorum, biliyorum) ve yukarı akış bağımlılıklarım basittir ve asla çatışmayacak veya geriye dönük uyumluluğu bozmayacaktır. Bir pip gereksinimleri dosyası kullanmaya mecbur kalacak mıyım yoksa sadece pip / setuptools / distribute'un her şeyi temel alarak yüklemesine izin verecek install_requiresmiyim?

Burada pek çok benzer soru var, ancak birini veya diğerini ne zaman kullanacağım veya ikisini birlikte uyumlu bir şekilde kullanacağım kadar basit bir soru bulamadım.

Benim felsefem, install_requiresihtiyacınız olan şeylerin minimum bir kısmını belirtmek. Bazı sürümlerin çalışmayacağını biliyorsanız sürüm gereksinimlerini içerebilir ; ancak emin olmadığınız durumlarda sürüm gereksinimleri olmamalıdır (örneğin, bir bağımlılığın gelecekteki bir sürümünün kitaplığınızı bozup bozmayacağından emin değilsiniz).

Öte yandan gereksinimler dosyaları , işe yaradığını bildiğiniz şeyleri belirtmelidir ve önerdiğiniz isteğe bağlı bağımlılıkları içerebilir. Örneğin, SQLAlchemy'yi kullanabilir, ancak MySQL'i önerebilirsiniz ve bu nedenle MySQLdb'yi gereksinimler dosyasına koyun).

Yani özetle: install_requiresİnsanları işe yaramadığını bildiğiniz şeylerden uzak tutmak, gereklilik dosyaları ise insanları işe yaradığını bildiğiniz şeylere yönlendirmektir. Bunun bir nedeni, install_requiresgereksinimlerin her zaman kontrol edilmesi ve paket meta verilerini gerçekten değiştirmeden devre dışı bırakılamamasıdır. Böylece yeni bir kombinasyonu kolayca deneyemezsiniz. Gereksinim dosyaları yalnızca yükleme sırasında kontrol edilir.

setup.py'ye koyduğum şey şu:

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

setup(
    .....
    install_requires=REQUIREMENTS
)

Python Paketleme Kullanıcı Kılavuzunda bu konuyla ilgili bir sayfa var, kesinlikle okumanızı tavsiye ederim:

• install_requires vs Gereksinimler dosyaları

Özet:

install_requirespaketin çalışması için mutlaka yüklenmesi gereken paketin bağımlılıklarını listelemek için var mı? Bağımlılıkları belirli sürümlere sabitlemek anlamına gelmez, ancak örneğin aralıklar kabul edilir install_requires=['django>=1.8']. ve diğer araçlar install_requirestarafından gözlemlenir pip install name-on-pypi.

requirements.txtsadece bir metin dosyasıdır ve çalıştırmayı seçebilirsiniz pip install -r requirements.txt. Böyle, sabitlenmiş bütün bağımlılıkları ve subdependencies sürümlerini olması gerekiyordu var: django==1.8.1. Kullanarak bir tane oluşturabilirsiniz pip freeze > requirements.txt. (Heroku gibi bazı hizmetler pip install -r requirements.txtsizin için otomatik olarak çalışır .) Sadece pip install name-on-pypibakmaz .requirements.txtinstall_requires

Ben sadece hiç bir kullanma setup.pyve install_requiresbakmak için tek bir yer olduğu için. Bir gereksinimler dosyasına sahip olmak kadar güçlüdür ve sürdürülecek çoğaltma yoktur.