Interface de ligne de commande de Flask

Introduction

Dans ce laboratoire, vous allez apprendre à utiliser l'interface de ligne de commande (CLI) de Flask pour gérer votre application Flask. L'interface de ligne de commande de Flask fournit un ensemble de commandes qui peuvent vous aider à exécuter le serveur de développement, à créer des commandes personnalisées et bien plus encore.

Note : Vous devez créer le fichier de code vous-même et l'exécuter dans l'environnement. Vous pouvez prévisualiser l'état du service Flask sur le Web 5000.

Installer Flask

Avant de commencer, assurez-vous d'avoir Flask installé dans votre environnement Python. Vous pouvez installer Flask à l'aide de pip :

pip install flask

Créer une application Flask

Créez un nouveau fichier Python nommé app.py et ajoutez le code suivant pour créer une application Flask de base :

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello():
    return 'Hello, Flask!'

if __name__ == '__main__':
    app.run()

Enregistrez le fichier et exécutez-le à l'aide de la commande suivante dans votre terminal :

python app.py

Exécuter le serveur de développement

Au lieu d'exécuter manuellement l'application Flask avec python app.py, vous pouvez utiliser l'interface de ligne de commande (CLI) de Flask pour démarrer le serveur de développement. Arrêtez l'application actuellement en cours d'exécution (le cas échéant) et exécutez la commande suivante :

flask run

Vous devriez voir le serveur de développement Flask démarrer et afficher l'URL où votre application est en cours d'exécution (généralement http://127.0.0.1:5000/). Ouvrez cette URL dans votre navigateur et vous devriez voir le message "Hello, Flask!".

Créer une commande personnalisée

L'interface de ligne de commande (CLI) de Flask vous permet de créer des commandes personnalisées qui peuvent être exécutées à partir de la ligne de commande. Créons une commande personnalisée nommée greet qui prend un nom en argument et affiche un message de salutation.

Créez un nouveau fichier Python nommé commands.py et ajoutez le code suivant :

import click

@click.command()
@click.argument('name')
def greet(name):
    click.echo(f'Hello, {name}!')

if __name__ == '__main__':
    greet()

Enregistrez le fichier et exécutez-le à l'aide de la commande suivante :

python commands.py John

Vous devriez voir le message "Hello, John!" affiché dans le terminal.

Enregistrer des commandes avec l'application Flask

Pour rendre vos commandes personnalisées disponibles via l'interface de ligne de commande (CLI) de Flask, vous devez les enregistrer avec votre application Flask. Ouvrez le fichier app.py et modifiez-le comme suit :

from flask import Flask
from commands import greet

app = Flask(__name__)
app.cli.add_command(greet)

@app.route('/')
def hello():
    return 'Hello, Flask!'

if __name__ == '__main__':
    app.run()

Enregistrez le fichier et redémarrez le serveur de développement Flask à l'aide de la commande flask run. Maintenant, vous pouvez exécuter votre commande personnalisée greet à partir de la ligne de commande :

flask greet John

Vous devriez voir le message "Hello, John!" affiché dans le terminal.

Récapitulatif

Dans ce laboratoire, vous avez appris à utiliser l'interface de ligne de commande (CLI) de Flask pour gérer votre application Flask. Vous avez appris comment exécuter le serveur de développement, créer des commandes personnalisées et enregistrer des commandes avec votre application Flask. L'interface de ligne de commande de Flask fournit un moyen pratique d'interagir avec votre application Flask à partir de la ligne de commande, facilitant la gestion et les tests de votre application.