API en ligne de commande Flask

Flask a construit son outil en ligne de commande sur Click.

ViaflaskExécutez des applications et gérez des tâches avec des commandes.

Toutes les classes CLI sont dansflask.clidans le module.


FlaskGroup

Groupe de commandes principal de Flask. Utilisation de la commande viaflask.

Paramètre Description
add_default_commands=True Indique s'il faut ajouter des commandes par défaut telles que run, shell, routes
create_app=None La fonction de fabrique d'application, renvoie une instance Flask
add_version_option=True Indique s'il faut ajouter l'option --version
load_dotenv=True Indique s'il faut charger les fichiers .env et .flaskenv
set_debug_flag=True Indique s'il faut définir l'indicateur de débogage en fonction des variables d'environnement

AppGroup

Classe de base pour les groupes de commandes CLI d'application et de blueprint. Parapp.clioubp.cliAjoutez des commandes personnalisées.

Méthodes Description
command(*args, **kwargs) Enregistre les commandes CLI. Par défaut, encapsule automatiquement avec with_appcontext
group(*args, **kwargs) Enregistre les groupes de sous-commandes. Par défaut, AppGroup est utilisé comme classe de groupe

AppGroup.command() activé par défautwith_appcontext=True, ce qui signifie que vos fonctions de commande disposent automatiquement du contexte d'application. Si ce n'est pas nécessaire, passezwith_appcontext=False。


ScriptInfo

Stocke les informations d'exécution du script, utilisées pour charger l'application. Aucune opération manuelle n'est généralement nécessaire.

Propriété Description
app_import_path Chemin d'import de l'application (valeur de l'option --app)
create_app Fonction de fabrique d'application
data Un dictionnaire de données supplémentaires arbitraires
load_app() Charge et renvoie l'instance de l'application Flask

Fonctions utilitaires

Fonction Description
with_appcontext(f) Décorateur. Garantit que la fonction décorée s'exécute dans le contexte d'application
pass_script_info(f) Décorateur. Passe l'instance ScriptInfo à la fonction en tant que premier argument
load_dotenv(path) Charge les variables d'environnement depuis le fichier .env

Commandes par défaut

Commande Description Paramètres courants
flask run Démarrer le serveur de développement --host, --port, --debug, --reload/--no-reload
flask shell Lancer un shell Python interactif Charger automatiquement les variables de contexte telles que app, g
flask routes Lister toutes les routes enregistrées --sort (endpoint/methods/domain/rule/match), --all-methods

Options standard

Options Description
-A / --app IMPORT Spécifier le module et l'instance de l'application, tels que "app:create_app()"
--debug / --no-debug Activer/désactiver le mode debug
-e / --env-file FILE Spécifier le chemin du fichier .env
--version Afficher les versions de Flask et de ses dépendances

Exemples de code

Exemple

from flask import Flask

app = Flask(__name__)

# Enregistrer des commandes personnalisées
@app.cli.command("init-db")
def init_db_command():
    """Initialiser la base de données"""
    print("Base de données initialisée.")

# Enregistrer une commande avec des arguments
@app.cli.command("greet")
@app.cli.option("--name", "-n", default="EXAMPLE", help="Cible de salutation")
def greet_command(name):
    """Envoyer une salutation"""
    print(f"Bonjour, {name}!")

# Enregistrer un groupe de sous-commandes
user_cli = app.cli.group("user")

@user_cli.command("list")
def list_users():
    """Lister tous les utilisateurs"""
    print("Affichage des utilisateurs...")

@user_cli.command("create")
@user_cli.option("--username", required=True)
def create_user(username):
    """Créer un nouvel utilisateur"""
    print(f"Création de l'utilisateur : {username}")

# Utilisation :
# flask init-db
# flask greet --name World
# flask user list
# flask user create --username example
autres extensions