API des fonctions et classes utilitaires Flask

Flask fournit un ensemble de fonctions disponibles globalement pour des opérations courantes telles que la génération d'URL, l'interruption de requêtes et la construction de réponses.

Tous réussisfrom flask import ...Import.


Objet proxy global

Object Type Description
current_app Proxy → Flask Pointe vers l'instance d'application Flask actuellement active. Disponible dans le contexte de l'application.

URL et redirections.

Fonction Signature Description
url_for (endpoint, *, _anchor, _method, _scheme, _external, **values) Générer une URL à partir du nom de la fonction de vue. _external=True génère une URL absolue.
redirect (location, code=303, Response=None) Créer une réponse de redirection. Le code a par défaut la valeur 303 (See Other).

Démontage de la requête et construction de la réponse.

Fonction Signature Description
abort (code, *args, **kwargs) Terminer immédiatement la requête et renvoyer une erreur HTTP. code est le code de statut, description est la description.
make_response (*args) Convertir la valeur de retour de la vue en un objet Response. Lorsque plusieurs arguments sont passés, les traiter comme un tuple.
after_this_request (func) Enregistre une fonction à exécuter une seule fois après la requête en cours. Utilisé pour ajouter dynamiquement after_request.

Vérification du contexte

Fonction Description
has_request_context() Retourne True s’il existe un contexte de requête actif.
has_app_context() Retourne True s’il existe un contexte d’application actif.
copy_current_request_context(func) Décorateur. Copie le contexte de requête courant afin que la fonction décorée puisse toujours accéder à request, g, etc. lorsqu’elle s’exécute en dehors du contexte.

Envoi de fichiers

Fonction Signature Description
send_file (path_or_file, mimetype, as_attachment, download_name, conditional, etag, last_modified, max_age) Envoyer le contenu du fichier. as_attachment=True déclenche un téléchargement. Prend en charge les requêtes conditionnelles et l'ETag.
send_from_directory (directory, path, **kwargs) Envoie en toute sécurité des fichiers depuis un répertoire spécifié. Utilise safe_join pour empêcher les attaques par traversée de chemin.

Exemples de code

Exemple

from flask import (Flask, current_app, url_for, redirect,
                   abort, make_response, after_this_request,
                   has_request_context, send_file, send_from_directory)

app = Flask(__name__)

@app.route("/")
def index():
    # url_for génère une URL
    login_url = url_for("login")
    # Générer une URL absolue (y compris le nom de domaine)
    full_url = url_for("profile", username="example", _external=True)
    return f'<a href="{login_url}">Connexion</a>'

@app.route("/redirect-me")
def redirect_me():
    # Rediriger vers la page d'accueil
    return redirect(url_for("index"))

@app.route("/profile/<username>")
def profile(username):
    return f"Profil : {username}"

@app.route("/admin")
def admin():
    # Accès non autorisé, renvoie 403
    abort(403, description="Accès refusé")

@app.route("/download")
def download():
    # Envoyer le fichier (déclencher le téléchargement dans le navigateur)
    return send_from_directory("uploads", "report.pdf",
                               as_attachment=True,
                               download_name="example_report.pdf")

@app.route("/custom-response")
def custom_response():
    # Construire manuellement l'objet de réponse
    resp = make_response("<h1>Personnalisé</h1>")
    resp.headers["X-Powered-By"] = "EXAMPLE"

    @after_this_request
    def log_response(response):
        app.logger.info(f"Requête vers {request.path} terminée, statut={response.status_code}")
        return response

    return resp
autres extensions