API de funciones y clases prácticas de Flask
Flask proporciona una serie de funciones disponibles globalmente para generar URL, terminar solicitudes, construir respuestas y otras operaciones comunes.
Todo mediantefrom flask import ...la importación.
Objeto proxy global
| Objeto | Tipo | Descripción |
|---|---|---|
| current_app | Proxy → Flask | Apunta a la instancia activa actual de la aplicación Flask. Disponible en el contexto de la aplicación. |
URL y redirecciones
| Función | Firma | Descripción |
|---|---|---|
| url_for | (endpoint, *, _anchor, _method, _scheme, _external, **values) | Genera una URL a partir del nombre de la función de vista. _external=True genera una URL absoluta. |
| redirect | (location, code=303, Response=None) | Crea una respuesta de redirección. code por defecto es 303 (See Other). |
Terminación de solicitudes y construcción de respuestas
| Función | Firma | Descripción |
|---|---|---|
| abort | (code, *args, **kwargs) | Termina inmediatamente la solicitud y devuelve un error HTTP. code es el código de estado, description es la descripción. |
| make_response | (*args) | Convierte el valor de retorno de la vista en un objeto Response. Cuando se pasan varios argumentos, se tratan como una tupla. |
| after_this_request | (func) | Registra una función que se ejecuta una sola vez después de la solicitud actual. Se utiliza para añadir after_request dinámicamente. |
Verificación de contexto
| Función | Descripción |
|---|---|
| has_request_context() | Devuelve True si hay un contexto de solicitud activo actualmente. |
| has_app_context() | Devuelve True si hay un contexto de aplicación activo actualmente. |
| copy_current_request_context(func) | Decorador. Copia el contexto de solicitud actual, permitiendo que la función decorada aún pueda acceder a request, g, etc. cuando se ejecuta fuera del contexto. |
Envío de archivos
| Función | Firma | Descripción |
|---|---|---|
| send_file | (path_or_file, mimetype, as_attachment, download_name, conditional, etag, last_modified, max_age) | Envía el contenido del archivo. as_attachment=True activa la descarga. Admite solicitudes condicionales y ETag. |
| send_from_directory | (directory, path, **kwargs) | Envía archivos de forma segura desde un directorio especificado. Utiliza safe_join para prevenir ataques de path traversal. |
Ejemplo de código
Ejemplo
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 genera URL
login_url = url_for("login")
# Genera URL absoluta (con dominio)
full_url = url_for("profile", username="ejemplo", _external=True)
return f'<a href="{login_url}">Login</a>'
@app.route("/redirect-me")
def redirect_me():
# Redirige a la página de inicio
return redirect(url_for("index"))
@app.route("/profile/<username>")
def profile(username):
return f"Profile: {username}"
@app.route("/admin")
def admin():
# Acceso no autorizado, devuelve 403
abort(403, description="Access denied")
@app.route("/download")
def download():
# Envía archivo (activa descarga en el navegador)
return send_from_directory("uploads", "report.pdf",
as_attachment=True,
download_name="ejemplo_report.pdf")
@app.route("/custom-response")
def custom_response():
# Construye manualmente el objeto de respuesta
resp = make_response("<h1>Custom</h1>")
resp.headers["X-Powered-By"] = "EJEMPLO"
@after_this_request
def log_response(response):
app.logger.info(f"Request to {request.path} done, status={response.status_code}")
return response
return resp
abort, make_response, after_this_request,
has_request_context, send_file, send_from_directory)
app = Flask(__name__)
@app.route("/")
def index():
# url_for genera URL
login_url = url_for("login")
# Genera URL absoluta (con dominio)
full_url = url_for("profile", username="ejemplo", _external=True)
return f'<a href="{login_url}">Login</a>'
@app.route("/redirect-me")
def redirect_me():
# Redirige a la página de inicio
return redirect(url_for("index"))
@app.route("/profile/<username>")
def profile(username):
return f"Profile: {username}"
@app.route("/admin")
def admin():
# Acceso no autorizado, devuelve 403
abort(403, description="Access denied")
@app.route("/download")
def download():
# Envía archivo (activa descarga en el navegador)
return send_from_directory("uploads", "report.pdf",
as_attachment=True,
download_name="ejemplo_report.pdf")
@app.route("/custom-response")
def custom_response():
# Construye manualmente el objeto de respuesta
resp = make_response("<h1>Custom</h1>")
resp.headers["X-Powered-By"] = "EJEMPLO"
@after_this_request
def log_response(response):
app.logger.info(f"Request to {request.path} done, status={response.status_code}")
return response
return resp