API des fonctions de vue Flask

Les fonctions de vue peuvent avoir des attributs spéciaux attachés pour contrôler le comportement du routage. Ces attributs n'ont généralement pas besoin d'être définis manuellement, mais sont très utiles dans certains scénarios avancés.


Attributs des fonctions de vue

Propriété Type Valeur par défaut Description
__name__ str Nom de la fonction Utilisé comme nom de point de terminaison. Dans les blueprints, le préfixe du nom du blueprint est automatiquement ajouté.
methods liste Aucune Les méthodes HTTP acceptées par la fonction de vue. Si elles ne sont pas spécifiées dans add_url_rule, cette valeur est utilisée.
required_methods set Aucune Méthodes HTTP qui doivent être ajoutées. Même si add_url_rule spécifie explicitement des méthodes, ces méthodes seront quand même ajoutées de force.
provide_automatic_options bool Aucune Indique s'il faut gérer automatiquement les requêtes OPTIONS. Définir sur False pour personnaliser la réponse OPTIONS.

Cas d'utilisation

Scénarios Attribut utilisé Description
Réponse OPTIONS personnalisée provide_automatic_options=False Empêcher Flask de générer automatiquement OPTIONS ; laisser la fonction de vue s'en charger elle-même.
Définition des méthodes dans les décorateurs methods Les décorateurs peuvent prédéfinir la liste des méthodes de la fonction de vue.
Forcer l'ajout de méthodes required_methods S'assurer que des méthodes spécifiques sont toujours enregistrées

Exemples de code

Exemple

from flask import Flask, request

app = Flask(__name__)

# Exemple 1 : réponse OPTIONS personnalisée
def custom_endpoint():
    if request.method == "OPTIONS":
        # Renvoyer une réponse OPTIONS personnalisée
        return "", 200, {"Allow": "GET, POST"}
    return "Hello, EXAMPLE!"

# Désactiver les OPTIONS automatiques
custom_endpoint.provide_automatic_options = False
custom_endpoint.methods = ["GET", "POST", "OPTIONS"]

app.add_url_rule("/custom", view_func=custom_endpoint)

# Exemple 2 : Définir un décorateur pour définir automatiquement les méthodes
def api_view(func):
    """Décorateur personnalisé : définit automatiquement les méthodes pour les fonctions de vue"""
    func.methods = ["GET", "POST"]
    return func

@api_view
def api_handler():
    return {"status": "ok"}

app.add_url_rule("/api", view_func=api_handler)
# À ce stade, les méthodes seront automatiquement lues à partir des attributs de la fonction
autres extensions