Soll ich # setzen! (shebang) in Python-Skripten, und welche Form sollte es annehmen?

Soll ich den Shebang in meine Python-Skripte einfügen? In welcher Form?

#!/usr/bin/env python 

oder

#!/usr/local/bin/python

Sind diese gleichermaßen tragbar? Welches Formular wird am häufigsten verwendet?

Hinweis: Das Tornado- Projekt verwendet den Shebang. Auf der anderen Seitetutdas Django- Projekt dies nicht.

Die Shebang-Zeile in einem Skript bestimmt die Fähigkeit des Skripts, wie eine eigenständige ausführbare Datei ausgeführt zu werden, ohne pythonvorher in das Terminal einzugeben oder wenn Sie in einem Dateimanager darauf doppelklicken (bei ordnungsgemäßer Konfiguration). Es ist nicht notwendig, wird aber im Allgemeinen dort abgelegt. Wenn jemand die Datei in einem Editor geöffnet sieht, weiß er sofort, was er gerade sieht. Was jedoch shebang Linie , die Sie verwenden IS wichtig.

Die korrekte Verwendung für Python 3-Skripte lautet:

#!/usr/bin/env python3

Dies ist standardmäßig Version 3.latest. Für Python 2.7. Neueste Verwendung python2anstelle von python3.

Folgendes sollte NICHT verwendet werden (außer in dem seltenen Fall, dass Sie Code schreiben, der sowohl mit Python 2.x als auch mit 3.x kompatibel ist):

#!/usr/bin/env python

Der Grund für diese Empfehlungen in PEP 394 ist, dass pythonsie sich entweder auf python2oder python3auf verschiedenen Systemen beziehen können. Es bezieht sich derzeit auf die python2meisten Distributionen, aber das wird sich wahrscheinlich irgendwann ändern.

Verwenden Sie auch NICHT:

#!/usr/local/bin/python

"Python kann unter / usr / bin / python oder / bin / python installiert werden. In diesen Fällen schlägt das obige #! fehl."

- "#! / usr / bin / env python" vs "#! / usr / local / bin / python"

Es ist wirklich nur eine Frage des Geschmacks. Durch Hinzufügen des Shebang können Benutzer das Skript direkt aufrufen, wenn sie möchten (vorausgesetzt, es ist als ausführbar markiert). Wenn Sie es weglassen, muss es nur pythonmanuell aufgerufen werden.

Das Endergebnis der Programmausführung wird in keiner Weise beeinflusst. es sind nur Optionen der Mittel.

Soll ich den Shebang in meine Python-Skripte einfügen?

Fügen Sie einen Shebang in ein Python-Skript ein, um Folgendes anzuzeigen:

• Dieses Modul kann als Skript ausgeführt werden
• ob es nur auf python2, python3 ausgeführt werden kann oder ob es Python 2/3 kompatibel ist
• Unter POSIX ist es erforderlich, wenn Sie das Skript direkt pythonausführen möchten, ohne die ausführbare Datei explizit aufzurufen

Sind diese gleichermaßen tragbar? Welches Formular wird am häufigsten verwendet?

Wenn Sie einen Shebang manuell schreiben, verwenden #!/usr/bin/env pythonSie ihn immer, es sei denn, Sie haben einen bestimmten Grund, ihn nicht zu verwenden. Dieses Formular wird auch unter Windows (Python Launcher) verstanden.

Hinweis: installierte Skripte sollte eine bestimmte Python ausführbare zB verwenden, /usr/bin/pythonoder /home/me/.virtualenvs/project/bin/python. Es ist schlecht, wenn ein Tool kaputt geht, wenn Sie eine virtuelle Umgebung in Ihrer Shell aktivieren. Glücklicherweise wird der richtige Shebang in den meisten Fällen automatisch von setuptoolsoder Ihren Distributionspaket-Tools erstellt (unter Windows setuptoolskönnen Wrapper- .exeSkripte automatisch generiert werden).

Mit anderen Worten, wenn sich das Skript in einer Quellkasse befindet, werden Sie wahrscheinlich sehen #!/usr/bin/env python. Wenn es installiert ist, ist der Shebang ein Pfad zu einer bestimmten ausführbaren Python-Datei wie #!/usr/local/bin/python (HINWEIS: Sie sollten die Pfade aus der letzteren Kategorie nicht manuell schreiben).

Zu entscheiden , ob Sie verwenden sollen python, python2oder python3in dem shebang finden PEP 394 - Der „Python“ Befehl auf Unix-ähnliche Systemen :

• ... pythonsollte in der Shebang-Zeile nur für Skripte verwendet werden, die mit Python 2 und 3 quellkompatibel sind.

• In Vorbereitung auf eine eventuelle Änderung der Standardversion von Python sollten nur Python 2-Skripte entweder aktualisiert werden, um mit Python 3 quellkompatibel zu sein, oder python2in der Shebang-Zeile verwendet werden.

Wenn Sie mehr als eine Version von Python haben und das Skript unter einer bestimmten Version ausgeführt werden muss, kann der She-Bang sicherstellen, dass die richtige Version verwendet wird, wenn das Skript direkt ausgeführt wird, zum Beispiel:

#!/usr/bin/python2.7

Beachten Sie, dass das Skript weiterhin über eine vollständige Python-Befehlszeile oder über den Import ausgeführt werden kann. In diesem Fall wird der She-Bang ignoriert. Aber für Skripte, die direkt ausgeführt werden, ist dies ein guter Grund, den She-Bang zu verwenden.

#!/usr/bin/env python ist in der Regel der bessere Ansatz, aber dies hilft in besonderen Fällen.

Normalerweise ist es besser, eine virtuelle Python-Umgebung #!/usr/bin/env pythoneinzurichten. In diesem Fall identifiziert das Generikum die richtige Python-Instanz für die virtuelle Umgebung .

Sie sollten einen Shebang hinzufügen, wenn das Skript ausführbar sein soll. Sie sollten das Skript auch mit einer Installationssoftware installieren, die den Shebang so ändert, dass er auf der Zielplattform funktioniert. Beispiele hierfür sind distutils und Distribute.

Der Zweck von shebang besteht darin, dass das Skript den Interpretertyp erkennt, wenn Sie das Skript über die Shell ausführen möchten. Meistens und nicht immer führen Sie Skripte aus, indem Sie den Interpreter extern bereitstellen. Anwendungsbeispiel:python-x.x script.py

Dies funktioniert auch dann, wenn Sie keinen Shebang-Deklarator haben.

Der erste Grund ist, dass "portabler" ist, weil er /usr/bin/envIhre PATHDeklaration enthält, die alle Ziele berücksichtigt, an denen sich die ausführbaren Dateien Ihres Systems befinden.

HINWEIS: Tornado verwendet Shebangs nicht ausschließlich und Django nicht. Dies hängt davon ab, wie Sie die Hauptfunktion Ihrer Anwendung ausführen.

AUCH: Es variiert nicht mit Python.

Manchmal, wenn die Antwort ist nicht ganz klar (ich meine Sie nicht entscheiden können , ob ja oder nein), dann spielt es keine Rolle , zu viel, und man kann das Problem ignorieren , bis die Antwort ist klar.

Der #!einzige Zweck ist das Starten des Skripts. Django lädt die Quellen selbst und verwendet sie. Es muss nie entschieden werden, welcher Interpreter verwendet werden soll. Auf diese Weise #!macht das hier eigentlich keinen Sinn.

Wenn es sich um ein Modul handelt, das nicht als Skript verwendet werden kann, muss das im Allgemeinen nicht verwendet werden #!. Andererseits enthält eine Modulquelle häufig if __name__ == '__main__': ...zumindest einige triviale Tests der Funktionalität. Dann #!macht das wieder Sinn.

Ein guter Grund für die Verwendung #!ist, wenn Sie sowohl Python 2- als auch Python 3-Skripte verwenden - diese müssen von verschiedenen Versionen von Python interpretiert werden. Auf diese Weise müssen Sie sich merken, was pythonbeim manuellen Starten des Skripts (ohne das #!Innere) verwendet werden muss. Wenn Sie eine Mischung solcher Skripte haben, ist es eine gute Idee, das #!Innere zu verwenden, sie ausführbar zu machen und sie als ausführbare Dateien zu starten (chmod ...).

Bei der Verwendung von MS-Windows hatte das #!keinen Sinn - bis vor kurzem. Python 3.3 führt einen Windows Python Launcher (py.exe und pyw.exe) ein, der die #!Zeile liest , die installierten Versionen von Python erkennt und die richtige oder explizit gewünschte Version von Python verwendet. Da die Erweiterung einem Programm zugeordnet werden kann, können Sie unter Windows ein ähnliches Verhalten wie mit dem Ausführungsflag in Unix-basierten Systemen erzielen.

Als ich kürzlich Python 3.6.1 unter Windows 7 installiert habe, wurde auch der Python Launcher für Windows installiert, der die Shebang-Zeile verarbeiten soll. Ich stellte jedoch fest, dass der Python Launcher dies nicht tat: Die Shebang-Zeile wurde ignoriert und Python 2.7.13 wurde immer verwendet (es sei denn, ich habe das Skript mit py -3 ausgeführt).

Um dies zu beheben, musste ich den Windows-Registrierungsschlüssel bearbeiten HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Python.File\shell\open\command. Dies hatte immer noch den Wert

"C:\Python27\python.exe" "%1" %*

von meiner früheren Python 2.7-Installation. Ich habe diesen Registrierungsschlüsselwert in geändert

"C:\Windows\py.exe" "%1" %*

und die Python Launcher Shebang-Linienverarbeitung funktionierte wie oben beschrieben.

Wenn Sie verschiedene Module installiert haben und eine bestimmte Python-Installation verwenden müssen, scheint shebang zunächst eingeschränkt zu sein. Sie können jedoch Tricks wie die folgenden ausführen, damit der Shebang zuerst als Shell-Skript aufgerufen und dann Python ausgewählt werden kann. Das ist sehr flexibel imo:

#!/bin/sh
#
# Choose the python we need. Explanation:
# a) '''\' translates to \ in shell, and starts a python multi-line string
# b) "" strings are treated as string concat by python, shell ignores them
# c) "true" command ignores its arguments
# c) exit before the ending ''' so the shell reads no further
# d) reset set docstrings to ignore the multiline comment code
#
"true" '''\'
PREFERRED_PYTHON=/Library/Frameworks/Python.framework/Versions/2.7/bin/python
ALTERNATIVE_PYTHON=/Library/Frameworks/Python.framework/Versions/3.6/bin/python3
FALLBACK_PYTHON=python3

if [ -x $PREFERRED_PYTHON ]; then
    echo Using preferred python $PREFERRED_PYTHON
    exec $PREFERRED_PYTHON "$0" "$@"
elif [ -x $ALTERNATIVE_PYTHON ]; then
    echo Using alternative python $ALTERNATIVE_PYTHON
    exec $ALTERNATIVE_PYTHON "$0" "$@"
else
    echo Using fallback python $FALLBACK_PYTHON
    exec python3 "$0" "$@"
fi
exit 127
'''

__doc__ = """What this file does"""
print(__doc__)
import platform
print(platform.python_version())

Oder noch besser, um die Wiederverwendung von Code über mehrere Python-Skripte hinweg zu erleichtern:

#!/bin/bash
"true" '''\'; source $(cd $(dirname ${BASH_SOURCE[@]}) &>/dev/null && pwd)/select.sh; exec $CHOSEN_PYTHON "$0" "$@"; exit 127; '''

und dann select.sh hat:

PREFERRED_PYTHON=/Library/Frameworks/Python.framework/Versions/2.7/bin/python
ALTERNATIVE_PYTHON=/Library/Frameworks/Python.framework/Versions/3.6/bin/python3
FALLBACK_PYTHON=python3

if [ -x $PREFERRED_PYTHON ]; then
    CHOSEN_PYTHON=$PREFERRED_PYTHON
elif [ -x $ALTERNATIVE_PYTHON ]; then
    CHOSEN_PYTHON=$ALTERNATIVE_PYTHON
else
    CHOSEN_PYTHON=$FALLBACK_PYTHON
fi

Antwort: Nur wenn Sie vorhaben, daraus ein ausführbares Befehlszeilenskript zu machen.

Hier ist die Vorgehensweise:

Überprüfen Sie zunächst die richtige Shebang-Zeichenfolge:

which python

Nehmen Sie die Ausgabe davon und fügen Sie sie (mit der shebang #!) In die erste Zeile ein.

Auf meinem System reagiert es wie folgt:

$which python
/usr/bin/python

Ihr Schebang wird also so aussehen:

#!/usr/bin/python

Nach dem Speichern wird es weiterhin wie zuvor ausgeführt, da Python diese erste Zeile als Kommentar sieht.

python filename.py

Um daraus einen Befehl zu machen, kopieren Sie ihn, um die Erweiterung .py zu löschen.

cp filename.py filename

Teilen Sie dem Dateisystem mit, dass dies ausführbar sein wird:

chmod +x filename

Verwenden Sie zum Testen Folgendes:

./filename

Die beste Vorgehensweise besteht darin, es irgendwo in Ihrem $ PATH zu verschieben, sodass Sie nur den Dateinamen selbst eingeben müssen.

sudo cp filename /usr/sbin

Auf diese Weise funktioniert es überall (ohne das ./ vor dem Dateinamen)

Absoluter vs logischer Pfad:

Dies ist wirklich eine Frage, ob der Pfad zum Python-Interpreter in Bezug auf die Portabilität absolut oder logisch ( /usr/bin/env) sein sollte.

Als ich auf dieser und anderen Stack-Sites auf andere Antworten stieß, die allgemein über das Problem sprachen, ohne Beweise zu unterstützen, habe ich auf unix.stackexchange.com einige wirklich WIRKLICH granulare Tests und Analysen zu dieser Frage durchgeführt . Anstatt diese Antwort hier einzufügen, werde ich diejenigen, die an der vergleichenden Analyse interessiert sind, auf diese Antwort verweisen:

https://unix.stackexchange.com/a/566019/334294

Als Linux-Ingenieur ist es immer mein Ziel, meinen Entwickler-Clients die am besten geeigneten, optimierten Hosts bereitzustellen. Daher war das Problem der Python-Umgebungen etwas, auf das ich wirklich eine solide Antwort brauchte. Nach dem Testen war ich der Ansicht, dass der logische Pfad im She-Bang die bessere der (2) Optionen war.

Zuerst verwenden

which python

Dies gibt die Ausgabe als den Ort an, an dem mein Python-Interpreter (binär) vorhanden ist.

Diese Ausgabe kann eine beliebige sein

/usr/bin/python

oder

/bin/python

Wählen Sie nun die Shebang-Linie entsprechend aus und verwenden Sie sie.

Zur Verallgemeinerung können wir verwenden:

#!/usr/bin/env

oder

#!/bin/env