Fonctions de vue Flask

Les fonctions de vue sont la partie centrale d'une application Flask ; elles traitent les requêtes et génèrent des réponses.

Les fonctions de vue sont étroitement liées au routage, en utilisant des routes pour associer les URL à des fonctions de vue spécifiques.

Ce qui suit est une explication détaillée des fonctions de vue Flask, y compris comment les définir, utiliser les données de requête, renvoyer des réponses et gérer les erreurs.

  1. Définir une fonction de vue: Les fonctions de vue sont la fonctionnalité centrale qui traite les requêtes et renvoie des réponses.
  2. Recevoir les données de requête: UtiliserrequestUtiliser l'objet pour obtenir les paramètres d'URL, les données de formulaire, les paramètres de requête, etc.
  3. Renvoyer une réponse: peut renvoyer des chaînes, du HTML, du JSON ou des objets de réponse personnalisés.
  4. Gérer les requêtes et les réponses: Utiliserrequestobjet etmake_responseUtilisé pour gérer les requêtes et générer des réponses personnalisées.
  5. gérer les erreurs: gérer les exceptions dans les fonctions de vue ou utiliser le mécanisme de gestion des erreurs de Flask.
  6. Décorateurs pour les fonctions de vue: Utiliser@app.before_request、@app.after_requestLes décorateurs gèrent la logique avant et après les requêtes.
  7. Codes d’état renvoyés par les fonctions de vuePeut spécifier des codes d’état HTTP pour indiquer le résultat du traitement de la requête.

1. Définir les fonctions de vue

Une fonction de vue est une fonction Python ordinaire qui reçoit des requêtes et renvoie des réponses. Les fonctions de vue sont généralement utilisées avec des routes, associant les URL aux fonctions de vue via des décorateurs.

Exemple

from flask import Flask

app = Flask(__name__)

@app.route('/')
def home():
    return 'Hello, World!'

  • @app.route('/'): Associer l'URL racine/àhomela fonction de vue.
  • def home()Fonction de vue, renvoie une chaîne'Hello, World!'comme réponse.

2. Recevoir les données de requête

Les fonctions de vue peuvent recevoir différents types de données de requête, notamment les paramètres d'URL, les données de formulaire, les paramètres de requête, etc.

Obtenir les paramètres d'URL :

Exemple

@app.route('/greet/<name>')
def greet(name):
    return f'Hello, {name}!'
  • <name>est un paramètre d'URL transmis à la fonction de vue.greet。

Obtenir les données de formulaire :

Exemple

from flask import request

@app.route('/submit', methods=['POST'])
def submit():
    username = request.form.get('username')
    return f'Formulaire soumis par {username}!'

request.form.get('username'): Récupérer le champ username à partir des données du formulaire dans une requête POST.

Obtenir les paramètres de requête :

Exemple

@app.route('/search')
def search():
    query = request.args.get('query')
    return f'Résultats de recherche pour : {query}'

request.args.get('query'): Récupérer le paramètre de requête query à partir d'une requête GET.

3. Renvoyer la réponse

Les fonctions de vue peuvent renvoyer plusieurs types de réponses, notamment des chaînes, du HTML, du JSON ou des objets de réponse personnalisés.

Renvoyer une chaîne :

Exemple

@app.route('/message')
def message():
    return 'This is a simple message.'

Renvoyer des modèles HTML :

Exemple

from flask import render_template

@app.route('/hello/<name>')
def hello(name):
    return render_template('hello.html', name=name)

render_template('hello.html', name=name)Rendre le modèle HTML hello.html, et transmettre la variable name au modèle.

Renvoyer des données JSON :

Exemple

from flask import jsonify

@app.route('/api/data')
def api_data():
    data = {'key': 'value'}
    return jsonify(data)

jsonify(data)Convertir un dictionnaire Python en une réponse JSON.

Renvoyer des objets de réponse personnalisés :

Exemple

from flask import Response

@app.route('/custom')
def custom_response():
    response = Response('Custom response with headers', status=200)
    response.headers['X-Custom-Header'] = 'Value'
    return response

Response('Custom response with headers', status=200): Créez un objet de réponse personnalisé et définissez les en-têtes de réponse.

4. Gérer les requêtes et les réponses

Les fonctions de vue peuvent accéder à l'objet request et générer des réponses en fonction des données de la requête. Vous pouvez utiliser l'objet request pour obtenir des informations sur la requête et make_response pour créer des réponses personnalisées.

Utilisation de l'objet request :

Exemple

from flask import request

@app.route('/info')
def info():
    user_agent = request.headers.get('User-Agent')
    return f'Votre agent utilisateur est {user_agent}'

request.headers.get('User-Agent'): Récupérez les informations User-Agent à partir des en-têtes de la requête.

Utilisez make_response:

Exemple

from flask import make_response

@app.route('/header')
def custom_header():
    response = make_response('Réponse avec un en-tête personnalisé')
    response.headers['X-Custom-Header'] = 'Value'
    return response

make_response('Réponse avec un en-tête personnalisé'): Créez un objet de réponse et définissez les informations d'en-tête personnalisées.

5. Gérer les erreurs

Les exceptions peuvent être gérées à l'intérieur des fonctions de vue, ou les erreurs peuvent être gérées à l'aide du mécanisme de gestion des erreurs de Flask.

Gérer les erreurs dans les fonctions de vue:

Exemple

@app.route('/divide/<int:x>/<int:y>')
def divide(x, y):
    try:
        result = x / y
        return f'Résultat : {result}'
    except ZeroDivisionError:
        return 'Erreur : division par zéro', 400

Utilisez une instruction try-except pour gérer les erreurs de division par zéro et renvoyer un message d'erreur personnalisé et un code d'état.

Gestion globale des erreurs :

Exemple

@app.errorhandler(404)
def not_found(error):
    return 'Page not found', 404

@app.errorhandler(404): Définissez une fonction qui gère les erreurs 404.

6. Décorateurs pour les fonctions de vue

En plus de @app.route, Flask prend également en charge d'autres décorateurs pour implémenter des fonctionnalités plus complexes.

Exemple :

  • @app.before_requestFonctions qui s'exécutent avant que chaque requête ne soit traitée.
  • @app.after_requestFonctions qui s'exécutent après que chaque requête est traitée.
  • @app.teardown_requestFonctions qui s'exécutent après la fin de la requête, utilisées pour le nettoyage.

Exemple d'utilisation de décorateur :

Exemple

@app.before_request
def before_request():
    print('Before request')

@app.after_request
def after_request(response):
    print('After request')
    return response

@app.teardown_request
def teardown_request(exception):
    print('Teardown request')

7. Codes d'état renvoyés par les fonctions de vue

Les fonctions de vue peuvent non seulement renvoyer du contenu, mais aussi spécifier des codes d'état HTTP.

Exemple

@app.route('/status')
def status():
    return 'Everything is OK', 200

Le renvoi du code d'état 200 indique une requête réussie.

Renvoie un objet de réponse avec un code d'état :

Exemple

from flask import Response

@app.route('/error')
def error():
    return Response('An error occurred', status=500)

Le renvoi du code d'état 500 indique une erreur interne du serveur.

autres extensions