Anforderungen.txt vs setup.py

Ich begann mit Python zu arbeiten. Ich habe requirements.txtund setup.pyzu meinem Projekt hinzugefügt . Aber ich bin immer noch verwirrt über den Zweck beider Dateien. Ich habe gelesen, dass dies setup.pyfür weiterverteilbare Dinge und requirements.txtfür nicht weiterverteilbare Dinge ausgelegt ist. Ich bin mir jedoch nicht sicher, ob dies korrekt ist.

Wie sollen diese beiden Dateien wirklich verwendet werden?

Anforderungen.txt

Dies hilft Ihnen beim Einrichten Ihrer Entwicklungsumgebung. Programme wie pipkönnen verwendet werden, um alle in der Datei aufgelisteten Pakete auf einen Schlag zu installieren. Danach können Sie mit der Entwicklung Ihres Python-Skripts beginnen. Besonders nützlich, wenn Sie vorhaben, dass andere zur Entwicklung beitragen oder virtuelle Umgebungen verwenden. So verwenden Sie es:

pip install -r requirements.txt

setup.py

Auf diese Weise können Sie Pakete erstellen, die Sie neu verteilen können. Dieses Skript soll Ihr Paket auf dem System des Endbenutzers installieren und die Entwicklungsumgebung nicht wie gewohnt vorbereiten pip install -r requirements.txt. Weitere Informationen zu setup.py finden Sie in dieser Antwort .

Die Abhängigkeiten Ihres Projekts sind in beiden Dateien aufgeführt.

Die kurze Antwort lautet, dass requirements.txtnur die Paketanforderungen aufgelistet werden. setup.pyAuf der anderen Seite ähnelt es eher einem Installationsskript. Wenn Sie nicht vorhaben, den Python-Code zu installieren, benötigen Sie normalerweise nur requirements.txt.

Die Datei setup.pybeschreibt zusätzlich zu den Paketabhängigkeiten die Gruppe von Dateien und Modulen, die gepackt (oder kompiliert werden sollen, im Fall von nativen Modulen (dh in C geschrieben)) und Metadaten, die zu den Python-Paketlisten hinzugefügt werden sollen ( zB Paketname, Paketversion, Paketbeschreibung, Autor, ...).

Da in beiden Dateien Abhängigkeiten aufgeführt sind, kann dies zu einer gewissen Duplizierung führen. Lesen Sie unten für Details.

Anforderungen.txt

Diese Datei listet die Anforderungen für Python-Pakete auf. Es ist eine einfache Textdatei (optional mit Kommentaren) , dass die Listen der Paketabhängigkeiten Ihrer Python - Projekt (eine pro Zeile). Es wird nicht beschrieben, wie Ihr Python-Paket installiert wird. Sie würden in der Regel die Anforderungsdatei mit verbrauchen pip install -r requirements.txt.

Der Dateiname der Textdatei ist willkürlich, wird jedoch häufig requirements.txtdurch Konvention festgelegt. Wenn Sie Quellcode-Repositorys anderer Python-Pakete durchsuchen, stoßen Sie möglicherweise auf andere Namen wie dev-dependencies.txtoder dependencies-dev.txt. Diese dienen demselben Zweck wie dependencies.txtzusätzliche Abhängigkeiten, die für Entwickler des jeweiligen Pakets von Interesse sind, jedoch im Allgemeinen, um den Quellcode (z. B. Pytest, Pylint usw.) vor der Veröffentlichung zu testen. Benutzer des Pakets benötigen im Allgemeinen nicht den gesamten Satz von Entwicklerabhängigkeiten, um das Paket auszuführen.

Wenn mehrere requirements-X.txtVarianten vorhanden sind, listet normalerweise eine Laufzeitabhängigkeiten und die andere Build-Time- oder Testabhängigkeit auf. Einige Projekte kaskadieren auch ihre Anforderungsdatei, dh wenn eine Anforderungsdatei eine andere Datei enthält ( Beispiel ). Dies kann die Wiederholung verringern.

setup.py

Dies ist ein Python-Skript, das das setuptoolsModul verwendet, um ein Python-Paket zu definieren (Name, enthaltene Dateien, Paketmetadaten und Installation). Es werden requirements.txtauch Laufzeitabhängigkeiten des Pakets aufgelistet. Setuptools ist die de-facto-Methode zum Erstellen und Installieren von Python-Paketen, weist jedoch Mängel auf, die im Laufe der Zeit zur Entwicklung neuer "Meta-Paket-Manager" wie pip geführt haben. Beispielhafte Mängel von setuptools sind die Unfähigkeit, mehrere Versionen desselben Pakets zu installieren, und das Fehlen eines Deinstallationsbefehls.

Wenn ein Python-Benutzer dies tut pip install ./pkgdir_my_module(oder pip install my-module), wird pip setup.pyin dem angegebenen Verzeichnis (oder Modul) ausgeführt. In ähnlicher Weise , die jedes Modul eine hat setup.pykann pipdurch Ausführen -Installierte, zB pip install .aus dem gleichen Ordner.

Brauche ich wirklich beides

Kurze Antwort ist nein, aber es ist schön, beides zu haben. Sie erfüllen unterschiedliche Zwecke, können jedoch beide zum Auflisten Ihrer Abhängigkeiten verwendet werden.

Es gibt einen Trick, den Sie in Betracht ziehen können, um zu vermeiden, dass Ihre Abhängigkeitsliste zwischen requirements.txtund dupliziert wird setup.py. Wenn Sie bereits ein voll funktionsfähiges setup.pyPaket für Ihr Paket geschrieben haben und Ihre Abhängigkeiten größtenteils extern sind, können Sie ein einfaches requirements.txtmit nur den folgenden Optionen in Betracht ziehen :

 # 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)
 # .

Dies -eist eine spezielle pip installOption, mit der das angegebene Paket im bearbeitbaren Modus installiert wird . Wenn pip -r requirements.txtdiese Datei ausgeführt wird, installiert pip Ihre Abhängigkeiten über die Liste in ./setup.py. Die bearbeitbare Option platziert einen Symlink in Ihrem Installationsverzeichnis (anstelle eines Eies oder einer archivierten Kopie). Entwickler können damit Code aus dem Repository bearbeiten, ohne ihn neu installieren zu müssen.

Sie können auch die sogenannten "Setuptools-Extras" nutzen, wenn Sie beide Dateien in Ihrem Paket-Repository haben. Sie können optionale Pakete in setup.py unter einer benutzerdefinierten Kategorie definieren und diese Pakete aus nur dieser Kategorie mit pip installieren:

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

und dann in der Anforderungsdatei:

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

Dies würde alle Ihre Abhängigkeitslisten in setup.py behalten.

Hinweis : Normalerweise führen Sie pip und setup.py in einer Sandbox aus, z. B. mit dem Programm virtualenv. Dadurch wird vermieden, dass Python-Pakete außerhalb des Kontexts der Entwicklungsumgebung Ihres Projekts installiert werden.

Der Vollständigkeit halber sehe ich es hier in 3 4 verschiedenen Winkeln.

1. Ihre Designzwecke sind unterschiedlich

Dies ist die genaue Beschreibung aus der offiziellen Dokumentation (Schwerpunkt Mine):

Während install_requires (in setup.py) die Abhängigkeiten für ein einzelnes Projekt definiert , werden Anforderungsdateien häufig verwendet, um die Anforderungen für eine vollständige Python-Umgebung zu definieren .

Während die Anforderungen für install_requires minimal sind, enthalten Anforderungsdateien häufig eine vollständige Liste der angehefteten Versionen, um wiederholbare Installationen einer vollständigen Umgebung zu erreichen.

Es ist jedoch möglicherweise immer noch nicht leicht zu verstehen. Im nächsten Abschnitt werden zwei sachliche Beispiele aufgeführt, um zu demonstrieren, wie die beiden Ansätze unterschiedlich verwendet werden sollen.

2. Ihre tatsächlichen Verwendungen sind daher (sollen) unterschiedlich

   • Wenn Ihr Projekt fooals eigenständige Bibliothek veröffentlicht werden soll (was wahrscheinlich andere tun würden import foo), möchten Sie (und Ihre nachgeschalteten Benutzer) eine flexible Abhängigkeitserklärung haben, damit Ihre Bibliothek dies nicht tut (und dies auch nicht muss) ) Seien Sie "wählerisch", wie genau Ihre Abhängigkeiten aussehen sollen. Normalerweise enthält Ihre setup.py folgende Zeilen:

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

   • Wenn Sie Ihre EXAKTE aktuelle Umgebung für Ihre Anwendung nur irgendwie "dokumentieren" oder "anheften" möchten bar, dh Sie oder Ihre Benutzer möchten Ihre Anwendung barunverändert verwenden, dh ausführen python bar.py, möchten Sie möglicherweise Ihre Umgebung einfrieren, damit sie einfriert würde sich immer gleich verhalten. In diesem Fall würde Ihre Anforderungsdatei folgendermaßen aussehen:

     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. Welches verwende ich in Wirklichkeit?

   • Wenn Sie eine Anwendung entwickeln, bardie von verwendet wird python bar.py, auch wenn dies "nur zum Spaß ein Skript" ist, wird Ihnen dennoch empfohlen, die Datei "resources.txt" zu verwenden, da Sie, wer weiß, nächste Woche (was zufällig Weihnachten ist) eine erhalten würden neuer Computer als Geschenk, daher müssten Sie dort Ihre genaue Umgebung erneut einrichten.

   • Wenn Sie eine Bibliothek entwickeln, foodie von verwendet wird import foo, müssen Sie eine setup.py vorbereiten. Zeitraum. Sie können sich jedoch auch dafür entscheiden, gleichzeitig eine require.txt bereitzustellen, die Folgendes kann:

     (a) entweder im A==1.2.3Stil sein (wie in # 2 oben erklärt);

     (b) oder nur eine magische Single enthalten .

     .

     Dies würde in etwa "Installieren der Anforderungen basierend auf setup.py" ohne Duplizierung bedeuten. Persönlich denke ich, dass dieser letzte Ansatz die Linie verwischt, die Verwirrung erhöht und NICHT wirklich einen Mehrwert schafft, aber dennoch ein Trick ist, der aus einem Ansatz abgeleitet wurde, den Python-Verpackungsbetreuer Donald in seinem Blogbeitrag erwähnt hat .

4. Unterschiedliche Untergrenzen.

   Selbst nachdem Sie die oben genannten 3 Kriterien befolgt und richtig entschieden haben, dass Ihre Bibliothek a hybrid-engineverwendet setup.py, um ihre Abhängigkeit zu deklarieren engine>=1.2.0, und Ihre Beispielanwendung reliable-carverwendet requirements.txt, um ihre Abhängigkeit zu deklarieren engine>=1.2.3, obwohl die neueste Version von enginebereits 1.4.0 ist. Wie Sie sehen, unterscheidet sich Ihre Wahl für die Anzahl der unteren Grenzen immer noch geringfügig. Und hier ist warum.

   • hybrid-enginehängt davon ab engine>=1.2.0, dass hypothetisch gesehen die erforderliche Fähigkeit zur "internen Verbrennung" erstmals eingeführt engine 1.2.0wurde und diese Fähigkeit die Notwendigkeit ist hybrid-engine, unabhängig davon, ob in einer solchen Version einige (geringfügige) Fehler vorhanden sind und in nachfolgenden Versionen 1.2.1 behoben wurden , 1.2.2 und 1.2.3.

   • reliable-carhängt davon ab, engine>=1.2.3da dies die früheste Version OHNE bekannte Probleme ist. Sicher, in späteren Versionen gibt es neue Funktionen, z. B. "Elektromotor" engine 1.3.0und "Kernreaktor" engine 1.4.0, aber sie sind für das Projekt nicht erforderlich reliable-car.