Procesadores de Contexto en Flask: Guía Completa con Ejemplos

---

¿Cómo funcionan los Procesadores de Contexto?

En Flask, un procesador de contexto se define utilizando el decorador @app.context_processor. Este decorador envuelve una función que retorna un diccionario, en el cual cada clave será el nombre de la variable disponible en las plantillas, y su valor el dato que deseas compartir.

Ejemplo 1: Variable Global para Información del Sitio

Supongamos que deseas mostrar el nombre del sitio en todas las páginas de la aplicación. Puedes crear un procesador de contexto que contenga esa información.

from flask import Flask, render_template

app = Flask(__name__)

# Definir el procesador de contexto
@app.context_processor
def inject_site_info():
  return {
      'site_name': 'Mi Sitio Web'
  }

@app.route('/')
def home():
  return render_template('index.html')

# Corriendo la app 
if __name__ == '__main__':
  app.run(debug=True, port=5000)

En las plantillas, site_name estará disponible en todas partes sin necesidad de pasarlo desde cada vista:

<!-- index.html -->
<h1>Bienvenido a {{ site_name }}</h1>
<!-- Salida: Mi Sitio Web -->

Este procesador permite que el nombre del sitio esté disponible globalmente, manteniendo el código de cada vista más limpio y evitando la duplicación.

Ejemplo 2: Mostrar Información del Usuario Autenticado

En una aplicación con autenticación, podrías querer que la información del usuario autenticado esté disponible en todas las plantillas, como el nombre o el rol del usuario. Puedes hacerlo con un procesador de contexto que recupere estos datos.

from flask import Flask, render_template, g

app = Flask(__name__)

# El decorador @app.before_request en Flask se utiliza para definir funciones que se ejecutarán antes de cada petición en la aplicación.
@app.before_request
def load_user():
  # Suponiendo que g.user es cargado en cada request
  g.user = {'name': 'Urian', 'role': 'admin'}

# Definir el procesador de contexto
@app.context_processor
def inject_user():
  return {'user': g.user}

@app.route('/')
def home():
  return render_template('index.html')

# Corriendo la app 
if __name__ == '__main__':
  app.run(debug=True, port=5000)

En la plantilla index.html, puedes mostrar el nombre del usuario autenticado directamente:

<!-- index.html -->
{% if user %}
  <p>Bienvenido, {{ user.name }} (Rol: {{ user.role }})</p>
  <!-- Salida: Bienvenido, Urian (Rol: admin )  -->
{% else %}
  <p>Bienvenido, Invitado</p>
{% endif %}

Ejemplo 3: Función para Formatear Fechas

Si deseas formatear fechas de una manera específica en varias plantillas, puedes definir una función en un procesador de contexto. Esto es útil para estandarizar la visualización de fechas en todo el sitio.

from flask import Flask, render_template
from datetime import datetime

app = Flask(__name__)

# Definir el procesador de contexto
@app.context_processor
def inject_format_date():
  def format_date(date):
      return date.strftime('%d/%m/%Y %H:%M')
  return {'format_date': format_date}

@app.route('/')
def home():
  current_time = datetime.now()
  return render_template('index.html', current_time=current_time)

En index.html, puedes usar la función format_date para formatear fechas:

<!-- index.html -->
<p>Fecha actual: {{ format_date(current_time) }}</p>

Este procesador permite que cualquier fecha en el sitio pueda ser formateada de manera consistente usando la función format_date, sin tener que definir la función en cada vista.