Python Fire CLI erstellen: Eine Anleitung für Ubuntu 22.04

Einleitung

Python Fire ist eine Python-Bibliothek, mit der Sie automatisch CLIs (Command Line Interfaces) aus Python-Objekten erstellen können. CLIs sind Programme, die Texteingaben über die Befehlszeile entgegennehmen, und können hilfreich sein, um Workflows für Entwicklung und Debugging zu optimieren. Dies ist besonders nützlich für diejenigen, die mit Bash und der Befehlszeile vertraut sind.

Während die traditionelle Methode mit argparse aus der Standard-Python-Bibliothek ähnliche Ergebnisse erzielen kann, verbessert Python Fire das Prototyping und die Wartung erheblich. Wenn Sie vollständige Kontrolle benötigen, sehen Sie sich das Tutorial zur Verwendung von argparse zum Schreiben von Befehlszeilenprogrammen in Python an.

In diesem Tutorial installieren Sie Python Fire und verwenden es, um benutzerdefinierte CLIs zu erstellen. Diese CLIs können erstellt werden, ohne den Python-Quellcode zu ändern, oder indem Python Fire direkt in Ihre Funktionen und Klassen integriert wird, um mehr Kontrolle zu ermöglichen.

Voraussetzungen für Python Fire CLI erstellen

• Ein Ubuntu 22.04-Server, eingerichtet mit einem nicht-root Benutzer mit sudo-Rechten und einer aktivierten Firewall.
• Die neueste Version von Python 3, installiert mit einer virtuellen Umgebung.
• Vertrautheit mit der Python-Programmierung. Eine gute Einführung bietet die Serie "How to Code in Python 3".

Schritt 1 — Python Fire installieren

Python Fire ist auf PyPI gehostet und über pip installierbar. Stellen Sie sicher, dass Ihre virtuelle Umgebung aktiviert ist:

cd environments
source my_env/bin/activate
pip install fire

Diese Installation stellt sicher, dass globale pip-Installationen nicht beeinflusst werden, was zu Konflikten mit Paketmanagern wie apt führen könnte.

Schritt 2 — Eine CLI ohne Codeänderungen erstellen

Erstellen Sie eine neue Python-Datei:

nano example.py

Fügen Sie den folgenden Code hinzu:

def my_name(name):
  return "Mein Name ist {name}".format(name=name)

Speichern und schließen Sie die Datei. Führen Sie dies als CLI aus:

python -m fire example my_name --name=sammy

Ausgabe:

Mein Name ist sammy

Schritt 3 — Eine CLI mit Python Fire importiert erstellen

Bearbeiten Sie die Datei, um Python Fire hinzuzufügen:

import fire

def my_name(name):
  return "Mein Name ist {name}".format(name=name)

if __name__ == '__main__':
  fire.Fire()

Führen Sie nun die CLI aus mit:

python example.py my_name sammy

Ausgabe:

Mein Name ist sammy

Schritt 4 — Eine CLI aus einer Funktion erstellen

Aktualisieren Sie den Code, um eine Funktion zu spezifizieren:

import fire

def my_name(name):
  return "Mein Name ist {name}".format(name=name)

if __name__ == '__main__':
  fire.Fire(my_name)

Führen Sie aus:

python example.py sammy

Ausgabe:

Mein Name ist sammy

Schritt 5 — Eine CLI aus einer Klasse erstellen

Strukturieren Sie den Code in einer Klasse um:

import fire

class Namer(object):
    def my_name(self, name):
        return "Mein Name ist {name}".format(name=name)

if __name__ == '__main__':
  fire.Fire(Namer)

Verwenden Sie die CLI:

python example.py my_name sammy

Ausgabe:

Mein Name ist sammy

Fazit zu Python Fire CLI erstellen

In diesem Tutorial haben Sie Python Fire installiert und verschiedene Möglichkeiten erkundet, CLIs mit Python-Programmen, -Funktionen und -Klassen zu erstellen. Für einen tieferen Einblick sehen Sie sich die offizielle Dokumentation oder die Anleitung zur Verwendung von argparse an, um Befehlszeilenprogramme in Python zu schreiben.