gereksinimleri.txt ile setup.py karşılaştırması

Python ile çalışmaya başladım. Ben ekledik requirements.txtve setup.pyprojeme. Ancak, her iki dosyanın amacı konusunda hala kafam karışık. setup.pyYeniden dağıtılabilir şeyler için tasarlanmış ve yeniden dağıtılamayan şeyler için tasarlanmış olanları okudum requirements.txt. Ancak bunun doğru olduğundan emin değilim.

Bu iki dosyanın gerçekten nasıl kullanılması amaçlanıyor?

requirements.txt:

Bu, geliştirme ortamınızı kurmanıza yardımcı olur.

Gibi programlar pip, dosyada listelenen tüm paketleri tek bir hamlede kurmak için kullanılabilir. Bundan sonra python betiğinizi geliştirmeye başlayabilirsiniz. Başkalarının gelişime katkıda bulunmasını veya sanal ortamları kullanmasını planlıyorsanız özellikle yararlıdır. Bunu nasıl kullanıyorsun:

pip install -r requirements.txt

setup.py:

Bu, yeniden dağıtabileceğiniz paketler oluşturmanıza yardımcı olur.

setup.pyKomut olarak geliştirme ortamı hazırlamak için değil, son kullanıcının sisteminde paketi kurmak anlamına gelir pip install -r requirements.txtyapar. Daha fazla ayrıntı için bu yanıta bakın setup.py.

Projenizin bağımlılıkları her iki dosyada da listelenmiştir.

Kısa cevap, requirements.txtyalnızca paket gereksinimlerini listelemek içindir. setup.pydiğer yandan daha çok bir kurulum betiği gibidir. Python kodunu yüklemeyi planlamıyorsanız, genellikle yalnızca ihtiyacınız olur requirements.txt.

Dosya setup.py, paket bağımlılıklarına ek olarak, paketlenmesi (veya yerel modüller olması durumunda derlenmesi (yani C ile yazılması)) gereken dosya ve modül kümesini ve python paket listelerine eklenecek meta verileri ( örneğin paket adı, paket sürümü, paket açıklaması, yazar, ...).

Her iki dosya da bağımlılıkları listelediği için, bu biraz çoğaltmaya yol açabilir. Ayrıntılar için aşağıyı okuyun.

gereksinimler.txt

Bu dosya python paketi gereksinimlerini listeler. Python projenizin paket bağımlılıklarını (satır başına bir tane ) listeleyen düz bir metin dosyasıdır (isteğe bağlı olarak yorumlarla birlikte ). O değil senin piton paket yüklü olduğu yolu tarif eder. Genellikle gereksinimler dosyasını pip install -r requirements.txt.

Metin dosyasının dosya adı keyfidir, ancak genellikle requirements.txtkural gereğidir. Diğer python paketlerinin kaynak kodu depolarını keşfederken, dev-dependencies.txtveya gibi başka adlarla karşılaşabilirsiniz dependencies-dev.txt. Bunlar dependencies.txt, belirli bir paketin geliştiricileriyle aynı amaca hizmet eder, ancak genellikle, yani yayınlamadan önce kaynak kodunu (ör. Pytest, pylint, vb.) Test etmek için ek ilgi bağımlılıklarını listeler. Paketin kullanıcıları genellikle paketi çalıştırmak için tüm geliştirici bağımlılıkları setine ihtiyaç duymazlar.

Birden çok requirements-X.txtvaryant varsa , genellikle biri çalışma zamanı bağımlılıklarını ve diğer oluşturma zamanı veya test bağımlılıklarını listeler. Bazı projeler, gereksinim dosyalarını da basamaklandırır, yani bir gereksinim dosyası başka bir dosya içerdiğinde ( örnek ). Bunu yapmak tekrarı azaltabilir.

setup.py

Bu, setuptoolsmodülü bir python paketini (ad, dahil edilen dosyalar, paket meta verileri ve kurulum) tanımlamak için kullanan bir python betiğidir . Aynı requirements.txtzamanda paketin çalışma zamanı bağımlılıklarını da listeleyecektir. Setuptools, python paketleri oluşturmanın ve kurmanın fiili yoludur, ancak zamanla pip gibi yeni "meta-paket yöneticilerinin" geliştirilmesini sağlayan eksiklikleri vardır. Kurulum araçlarının örnek eksiklikleri, aynı paketin birden çok sürümünü yükleyememesi ve bir kaldırma komutunun olmamasıdır.

Bir python kullanıcısı yaptığında pip install ./pkgdir_my_module(veya pip install my-module), setup.pyverilen dizinde (veya modülde) pip çalışacaktır . Benzer şekilde, bir modülü olan herhangi bir modül , örneğin aynı klasörden çalıştırılarak setup.pykurulabilir .pippip install .

İkisine de gerçekten ihtiyacım var mı?

Kısa cevap hayır, ama ikisine de sahip olmak güzel. Farklı amaçlara ulaşırlar, ancak her ikisi de bağımlılıklarınızı listelemek için kullanılabilir.

Eğer arasındaki bağımlılıkları listenizi çoğaltma önlemek için düşünebilir bir hile vardır requirements.txtve setup.py. setup.pyZaten paketiniz için tam olarak çalışan bir yazdıysanız ve bağımlılıklarınız çoğunlukla dışarıdaysa, requirements.txtyalnızca aşağıdakileri içeren bir Simple'a sahip olmayı düşünebilirsiniz :

 # requirements.txt
 #
 # installs dependencies from ./setup.py, and the package itself,
 # in editable mode
 -e .

 # (the -e above is optional). you could also just install the package
 # normally with just the line below (after uncommenting)
 # .

Bu -e, pip installverilen paketi düzenlenebilir modda kuran özel bir seçenektir . Ne zaman pip -r requirements.txtbu dosya üzerinde çalıştırılır, pip listeye aracılığıyla bağımlılıkları kuracaktır ./setup.py. Düzenlenebilir seçeneği, kurulum dizininize bir sembolik bağlantı yerleştirir (yumurta veya arşivlenmiş bir kopya yerine). Geliştiricilerin, yeniden yüklemeden depodaki kodu yerinde düzenlemelerine olanak tanır.

Paket deponuzda her iki dosya da bulunduğunda, "kurulum araçları ekstraları" denen şeyden de yararlanabilirsiniz. Setup.py'de isteğe bağlı paketleri özel bir kategori altında tanımlayabilir ve bu paketleri pip ile sadece bu kategoriden kurabilirsiniz:

# setup.py
from setuptools import setup
setup(
   name="FOO"
   ...
   extras_require = {
       'dev': ['pylint'],
       'build': ['requests']
   }
   ...
)

ve ardından, gereksinimler dosyasında:

# install packages in the [build] category, from setup.py
# (path/to/mypkg is the directory where setup.py is)
-e path/to/mypkg[build]

Bu, tüm bağımlılık listelerinizi setup.py içinde tutacaktır.

Not : Normalde pip ve setup.py'yi programla oluşturulanlar gibi bir sanal alandan çalıştırırsınız virtualenv. Bu, python paketlerini projenizin geliştirme ortamının bağlamı dışında yüklemekten kaçınacaktır.

Tamlık adına, işte onu 3 4 farklı açıdan nasıl görüyorum .

1. Tasarım amaçları farklı

Bu, resmi belgelerden alıntılanan kesin tanımdır (vurgu benim):

İnstall_requires (setup.py içinde) tek bir proje için bağımlılıkları tanımlarken , Gereksinim Dosyaları genellikle eksiksiz bir Python ortamı için gereksinimleri tanımlamak için kullanılır .

İnstall_requires gereksinimleri minimum düzeydeyken, gereksinim dosyaları genellikle tam bir ortamın tekrarlanabilir yüklemelerini elde etmek amacıyla sabitlenmiş sürümlerin kapsamlı bir listesini içerir.

Ancak yine de anlaşılması kolay olmayabilir, bu nedenle bir sonraki bölümde, 2 yaklaşımın nasıl farklı şekilde kullanılması gerektiğini gösteren 2 gerçek örnek var.

2. Dolayısıyla gerçek kullanımları farklıdır (olması gerekir)

   • Projeniz foobağımsız bir kitaplık olarak yayınlanacaksa (yani, başkaları muhtemelen yapacak import foo), o zaman siz (ve aşağı akış kullanıcılarınız) esnek bir bağımlılık bildirimine sahip olmak isteyeceksiniz, böylece kitaplığınız bunu yapmayacaktır (ve ) SİZİN bağımlılıklarınızın tam olarak hangi versiyonu olması gerektiği konusunda "seçici" olun. Bu nedenle, tipik olarak, setup.py dosyanız şuna benzer satırlar içerir:

     install_requires=[
         'A>=1,<2',
         'B>=2'
     ]
     

   • Uygulamanız için KESİN mevcut ortamınızı bir şekilde "belgelemek" veya "sabitlemek" istiyorsanız bar, yani siz veya kullanıcılarınız uygulamanızı barolduğu gibi kullanmak , yani çalışır durumda python bar.py, ortamınızı dondurmak isteyebilirsiniz. hep aynı şekilde davranırdı. Böyle bir durumda, gereksinimler dosyanız şöyle görünecektir:

     A==1.2.3
     B==2.3.4
     # It could even contain some dependencies NOT strickly required by your library
     pylint==3.4.5
     

3. Gerçekte, hangisini kullanıyorum?

   • barTarafından kullanılacak bir uygulama geliştiriyorsanız python bar.py, bu "eğlence için komut dosyası" olsa bile, yine de Required.txt kullanmanız önerilir çünkü, kim bilir, gelecek hafta (Noel olur) bir Hediye olarak yeni bir bilgisayar, böylece tam ortamınızı orada yeniden kurmanız gerekir.

   • Eğer bir kütüphane geliştiriyorsanız footarafından kullanılacak import foo, bir setup.py hazırlamalıyız. Dönem. Ancak yine de aynı anda bir requirements.txt sağlamayı seçebilirsiniz, bu da:

     (a) ya A==1.2.3stilde (yukarıda # 2'de açıklandığı gibi);

     (b) veya sadece büyülü bir single içerir .

     .
     

     bu, çoğaltma olmadan "gereksinimleri setup.py'ye dayalı olarak yükleme" ye eşittir. Şahsen ben bu son yaklaşımın çizgiyi bulanıklaştırdığını, kafa karışıklığına katkıda bulunduğunu ve gerçekten değer katmadığını düşünüyorum, ancak yine de Python ambalaj geliştiricisi Donald'ın blog yazısında bahsettiği bir yaklaşımdan türetilen bir hile .

4. Farklı alt sınırlar.

   Eğer 3 kritere yukarıda takip ve doğru kütüphane karar verdik sonra bile hybrid-enginebir kullanırsınız setup.pyolan bağımlılığını ilan etmek engine>=1.2.0, ve örnek uygulama reliable-carkullanmak istiyorsunuz requirements.txtolan bağımlılığını ilan etmek engine>=1.2.3son sürümü olsa bile, engine1.4.0 de zaten. Gördüğünüz gibi, alt sınır sayıları için seçiminiz hala ince bir şekilde farklı. Ve işte nedeni.

   • hybrid-enginebağlıdır engine>=1.2.0varsayımsal konuşuyorum, çünkü gerekli "içten yanmalı" özelliği ilk tanıtıldı engine 1.2.0ve bu kabiliyet gerekliliğidir hybrid-enginebakılmaksızın böyle versiyonu içinde bazı (küçük) hatalar olabilir bakılmaksızın, ve sonraki sürümlerinde 1.2.1 düzeltildi , 1.2.2 ve 1.2.3.

   • reliable-carengine>=1.2.3Şimdiye kadar bilinen sorunlar OLMADAN en eski sürüm olduğu için buna bağlıdır . Elbette sonraki sürümlerde yeni yetenekler var, mesela "elektrik motoru" ve tanıtılmış engine 1.3.0"nükleer reaktör" engine 1.4.0, ancak bunlar proje için gerekli değil reliable-car.