Flask-Kommandozeilen-API
Flask hat sein Kommandozeilen-Tool auf Click aufgebaut.
MitflaskAnwendungen ausführen und Aufgaben mit Befehlen verwalten.
Alle CLI-Klassen sind inflask.cliim Modul.
FlaskGroup
Flask-Hauptbefehlgruppe. Befehlsverwendung überflask.
| Parameter | Beschreibung |
|---|---|
| add_default_commands=True | Ob Standardbefehle wie run, shell, routes hinzugefügt werden sollen |
| create_app=None | Die App-Factory-Funktion gibt eine Flask-Instanz zurück |
| add_version_option=True | Ob die Option --version hinzugefügt werden soll |
| load_dotenv=True | Ob .env- und .flaskenv-Dateien geladen werden sollen |
| set_debug_flag=True | Ob das Debug-Flag basierend auf Umgebungsvariablen gesetzt werden soll |
AppGroup
Basisklasse für CLI-Befehlsgruppen von Anwendung und Blueprint. Überapp.clioderbp.clibenutzerdefinierte Befehle hinzufügen.
| Methoden | Beschreibung |
|---|---|
| command(*args, **kwargs) | Registriert CLI-Befehle. Standardmäßig wird automatisch mit with_appcontext umhüllt |
| group(*args, **kwargs) | Registriert Unterbefehlsgruppen. Standardmäßig wird AppGroup als Gruppenklasse verwendet |
AppGroup.command() standardmäßig aktiviertwith_appcontext=True, was bedeutet, dass Ihre Befehlsfunktionen automatisch den Anwendungskontext haben. Wenn nicht benötigt, übergeben Siewith_appcontext=False。
ScriptInfo
Speichert die Informationen der Skriptlaufzeit, die zum Laden der Anwendung verwendet werden. Normalerweise ist kein manueller Eingriff erforderlich.
| Eigenschaft | Beschreibung |
|---|---|
| app_import_path | Anwendungsimportpfad (Wert der --app-Option) |
| create_app | Anwendungs-Factory-Funktion |
| data | Ein Dictionary mit beliebigen zusätzlichen Daten |
| load_app() | Lädt die Flask-Anwendungsinstanz und gibt sie zurück |
Hilfsfunktionen
| Funktion | Beschreibung |
|---|---|
| with_appcontext(f) | Dekorator. Stellt sicher, dass die dekorierte Funktion im Anwendungskontext ausgeführt wird |
| pass_script_info(f) | Dekorator. Übergibt die ScriptInfo-Instanz als erstes Argument an die Funktion |
| load_dotenv(path) | Lädt Umgebungsvariablen aus der .env-Datei |
Standardbefehle
| Befehl | Beschreibung | Häufige Parameter |
|---|---|---|
| flask run | Den Entwicklungsserver starten | --host, --port, --debug, --reload/--no-reload |
| flask shell | Eine interaktive Python-Shell starten | Kontextvariablen wie app, g automatisch laden |
| flask routes | Alle registrierten Routen auflisten | --sort (endpoint/methods/domain/rule/match), --all-methods |
Standardoptionen
| Optionen | Beschreibung |
|---|---|
| -A / --app IMPORT | Anwendungsmodul und Instanz angeben, z. B. "app:create_app()" |
| --debug / --no-debug | Debug-Modus aktivieren/deaktivieren |
| -e / --env-file FILE | Pfad zur .env-Datei angeben |
| --version | Flask- und Abhängigkeitsversionen anzeigen |
Codebeispiele
Beispiel
from flask import Flask
app = Flask(__name__)
# Benutzerdefinierte Befehle registrieren
@app.cli.command("init-db")
def init_db_command():
"""Die Datenbank initialisieren"""
print("Datenbank initialisiert.")
# Einen Befehl mit Argumenten registrieren
@app.cli.command("greet")
@app.cli.option("--name", "-n", default="EXAMPLE", help="Ziel der Begrüßung")
def greet_command(name):
"""Eine Begrüßung senden"""
print(f"Hallo, {name}!")
# Unterbefehlgruppe registrieren
user_cli = app.cli.group("user")
@user_cli.command("list")
def list_users():
"""Alle Benutzer auflisten"""
print("Benutzer werden aufgelistet...")
@user_cli.command("create")
@user_cli.option("--username", required=True)
def create_user(username):
"""Einen neuen Benutzer erstellen"""
print(f"Benutzer wird erstellt: {username}")
# Verwendung:
# flask init-db
# flask greet --name World
# flask user list
# flask user create --username example
app = Flask(__name__)
# Benutzerdefinierte Befehle registrieren
@app.cli.command("init-db")
def init_db_command():
"""Die Datenbank initialisieren"""
print("Datenbank initialisiert.")
# Einen Befehl mit Argumenten registrieren
@app.cli.command("greet")
@app.cli.option("--name", "-n", default="EXAMPLE", help="Ziel der Begrüßung")
def greet_command(name):
"""Eine Begrüßung senden"""
print(f"Hallo, {name}!")
# Unterbefehlgruppe registrieren
user_cli = app.cli.group("user")
@user_cli.command("list")
def list_users():
"""Alle Benutzer auflisten"""
print("Benutzer werden aufgelistet...")
@user_cli.command("create")
@user_cli.option("--username", required=True)
def create_user(username):
"""Einen neuen Benutzer erstellen"""
print(f"Benutzer wird erstellt: {username}")
# Verwendung:
# flask init-db
# flask greet --name World
# flask user list
# flask user create --username example