Modulschnittstelle

Das zipapp-Modul bietet die folgenden Funktionen:

Befehlszeilen-Nutzung

Das zipapp-Modul kann mit dem Flag python -m ausgeführt werden. Die Befehlszeilenschnittstelle lautet wie folgt:

python -m zipapp directory [options]

    Create an archive from the given directory.  An archive will
    be created from the contents of that directory.  The archive
    will have the same name as the source directory with a .pyz
    extension.

    The following options can be specified:

    -o archive / --output archive

        The destination archive will have the specified name.  The
        given name will be used as written, so should include the
        ".pyz" or ".pyzw" extension.

    -p interpreter / --python interpreter

        The given interpreter will be written to the shebang line
        of the archive.  If this option is not given, the archive
        will have no shebang line.

    -m pkg.mod:fn / --main pkg.mod:fn

        The source directory must not have a __main__.py file. The
        archiver will write a __main__.py file into the target
        which calls fn from the module pkg.mod.

Das Verhalten der Befehlszeilenschnittstelle entspricht dem von zipapp.create_archive().

Darüber hinaus ist es möglich, die Befehlszeilenschnittstelle zur Bearbeitung eines bestehenden Archivs zu verwenden:

python -m zipapp app.pyz --show

    Displays the shebang line of an archive.  Output is of the
    form

        Interpreter: /usr/bin/env
    or
        Interpreter: <none>

    and is intended for diagnostic use, not for scripts.

python -m zipapp app.pyz -o newapp.pyz [-p interpreter]

    Copy app.pyz to newapp.pyz, modifying the shebang line based
    on the -p option (as for creating an archive, no -p option
    means remove the shebang line).  Specifying a destination is
    mandatory.

    In-place modification of an archive is *not* supported, as the
    risk of damaging archives is too great for a simple tool.

Wie erwähnt, sind die Archive Standard-Zip-Dateien und können daher mit jedem Standard-ZIP-Dienstprogramm oder dem zipfile-Modul von Python entpackt werden. Aus diesem Grund werden keine Schnittstellen zum Auflisten des Inhalts eines Archivs oder zum Entpacken bereitgestellt oder benötigt.

FAQ

Sind Sie sicher, dass ein Standard-ZIP-Dienstprogramm #! am Anfang verarbeiten kann?

Absolut. Die ZIP-Datei-Spezifikation erlaubt es, beliebige Daten vor einer ZIP-Datei einzufügen. Dieses Feature wird häufig von "selbstextrahierenden ZIP"-Programmen verwendet. Wenn Ihr Archivprogramm dies nicht verarbeiten kann, ist das ein Fehler in Ihrem Archivprogramm.

Ist zipapp nicht nur ein sehr dünner Wrapper um das zipfile-Modul?

Ja. Wenn Sie es vorziehen, Ihre eigenen Python ZIP-Anwendungsarchive mit anderen Werkzeugen zu erstellen, werden diese genauso gut funktionieren. Das zipapp-Modul ist eine Bequemlichkeit, nichts weiter.

Warum nicht einfach eine .zip- oder .py-Erweiterung verwenden?

Benutzer erwarten, dass eine .zip-Datei mit einem Archiv-Tool geöffnet wird, und erwarten, dass eine .py-Datei lesbaren Text enthält. Beides wäre für diesen Anwendungsfall verwirrend.

Wie verhält sich dies im Vergleich zu bestehenden Paketformaten?

Die Formate sdist, bdist und wheel sind für die Verpackung von Modulen konzipiert, die in einer bestehenden Python-Installation installiert werden sollen. Sie sind nicht dafür gedacht, ohne Installation verwendet zu werden. Das ausführbare ZIP-Format ist speziell für die eigenständige Verwendung konzipiert, ohne dass eine Installation erforderlich ist. Sie sind im Grunde eine Mehrfachdatei-Version eines eigenständigen Python-Skripts.

Bequeme Werte für Shebang-Zeilen

Lohnt es sich, "Bequemlichkeits"-Formen für gängige Interpreterwerte zu haben? Zum Beispiel, -p 3 bedeutet dasselbe wie -p "/usr/bin/env python3". Dies würde viel Tipparbeit für die häufigsten Fälle sparen und auch plattformübergreifende Optionen für Leute bieten, die die Feinheiten der Shebang-Handhabung auf "anderen" Plattformen nicht verstehen wollen oder müssen.

Nachteile sind, dass nicht klar ist, wie die Abkürzungen übersetzt werden sollen. Soll zum Beispiel "3" bedeuten "/usr/bin/env python3", "/usr/bin/python3", "python3" oder etwas anderes? Außerdem gibt es keine offensichtliche Kurzform für den wichtigsten Fall von "/usr/bin/env python" (jede verfügbare Python-Version), was leicht dazu führen könnte, dass Skripte mit zu restriktiven Shebang-Zeilen geschrieben werden.

Insgesamt scheint es hier mehr Probleme als Vorteile zu geben, und deshalb wurde dies aus der Überlegung gestrichen.

Registrierung von .pyz als Medientyp

Es wurde vorgeschlagen [3], dass die Erweiterung .pyz in der Unix-Datenbank der Erweiterungen registriert werden sollte. Obwohl es sinnvoll wäre, dies als Äquivalent zur Registrierung der Erweiterung durch den Windows-Installer zu tun, ist die Erweiterung .py nicht in der Medientypen-Datenbank aufgeführt [4]. Es scheint nicht ratsam, .pyz ohne .py zu registrieren, daher wurde diese Idee aus diesem PEP weggelassen. Eine interessierte Partei könnte dafür sorgen, dass zu einem späteren Zeitpunkt *sowohl* .py als auch .pyz registriert werden.

Standard-Interpreter

Der erste Entwurf dieses PEP schlug die Verwendung von /usr/bin/env python als Standard-Interpreter vor. Unix-Benutzer haben Probleme mit diesem Verhalten, da der Standard für den Befehl python auf vielen Distributionen Python 2 ist, und es wird davon ausgegangen, dass dieses PEP standardmäßig Python 3 bevorzugen sollte. Die Verwendung des Befehls python3 kann jedoch zu unerwartetem Verhalten für Windows-Benutzer führen, wo das Standardverhalten des Launchers für den Befehl python häufig von Benutzern angepasst wird, das Verhalten von python3 jedoch möglicherweise nicht entsprechend geändert wird.

Infolgedessen wurde das Prinzip "Im Angesicht von Mehrdeutigkeit, weigere dich zu raten" angewendet, und Archive haben keine Shebang-Zeile, es sei denn, sie wird explizit angefordert. Unter Windows werden die Archive weiterhin vom Launcher ausgeführt (mit dem Standard-Python), und unter Unix können die Archive ausgeführt werden, indem der gewünschte Python-Interpreter explizit aufgerufen wird.

Befehlszeilentool zur Verwaltung von Shebang-Zeilen

Es ist denkbar, dass Benutzer die Shebang-Zeile für ein bestehendes Archiv ändern möchten oder sogar nur die aktuelle Shebang-Zeile anzeigen möchten. Dies ist mit vorhandenen Werkzeugen schwierig zu bewerkstelligen (ZIP-Programme ignorieren vorangestellte Daten normalerweise vollständig, und Texteditoren können Schwierigkeiten haben, Dateien mit Binärdaten zu bearbeiten).

Das zipapp-Modul bietet Funktionen zur Handhabung der Shebang-Zeile, enthält jedoch keine Befehlszeilenschnittstelle für diese Funktionalität. Dies liegt daran, dass unklar ist, wie eine solche bereitgestellt werden kann, ohne dass die resultierende Schnittstelle zu komplex und potenziell verwirrend wird. Das Ändern der Shebang-Zeile wird als ungewöhnliche Anforderung angesehen.