Декораторы представлений

В Python есть очень интересная функция, называемая декораторами функций. Это позволяет делать очень интересные вещи для веб-приложений. Поскольку каждое представление в Flask — это функция, декораторы могут использоваться для вставки дополнительной функциональности в одну или несколько функций. Декоратор route() — это тот, который, вероятно, вы уже использовали. Но есть случаи использования для реализации собственного декоратора. Например, представьте, что у вас есть представление, которое должно использоваться только авторизованными пользователями. Если пользователь переходит на сайт и не авторизован, он должен быть перенаправлен на страницу входа в систему. Это хороший пример случая использования, где декоратор является отличным решением.

Декоратор, требующий входа в систему

Итак, давайте реализуем такой декоратор. Декоратор — это функция, которая оборачивает и заменяет другую функцию. Поскольку исходная функция заменяется, необходимо запомнить копирование информации из исходной функции в новую функцию. Используйте functools.wraps(), чтобы справиться с этим.

В этом примере предполагается, что страница входа называется 'login' и что текущий пользователь хранится в g.user и равен None если никто не авторизован.

from functools import wraps
from flask import g, request, redirect, url_for

def login_required(f):
    @wraps(f)
    def decorated_function(*args, **kwargs):
        if g.user is None:
            return redirect(url_for('login', next=request.url))
        return f(*args, **kwargs)
    return decorated_function

Для использования декоратора примените его как самый внутренний декоратор к функции представления. При применении дополнительных декораторов всегда помните, что декоратор route() является самым внешним.

@app.route('/secret_page')
@login_required
def secret_page():
    pass

<input type="hidden" value="{{ request.args.get('next', '') }}"/>

Декоратор кеширования

Представьте, что у вас есть функция представления, которая выполняет дорогостоящие вычисления, и поэтому вы хотели бы кэшировать полученные результаты на определенный период времени. Для этого пригодится декоратор. Мы предполагаем, что вы настроили кэш, как описано в Кэшировании.

Вот пример функции кэширования. Она генерирует ключ кэша из определенного префикса (на самом деле строка форматирования) и текущего пути запроса. Обратите внимание, что мы используем функцию, которая сначала создает декоратор, а затем применяет его к функции. Звучит ужасно? К сожалению, это немного сложнее, но код все еще должен быть легко читаемым.

Функция с декоратором будет работать следующим образом:

1. Получить уникальный ключ кэша для текущего запроса на основе текущего пути.
2. Получить значение для этого ключа из кэша. Если кэш вернул что-то, мы вернем это значение.
3. В противном случае вызывается исходная функция, и возвращаемое значение сохраняется в кэше на указанное время ожидания (по умолчанию 5 минут).

Вот код:

from functools import wraps
from flask import request

def cached(timeout=5 * 60, key='view/%s'):
    def decorator(f):
        @wraps(f)
        def decorated_function(*args, **kwargs):
            cache_key = key % request.path
            rv = cache.get(cache_key)
            if rv is not None:
                return rv
            rv = f(*args, **kwargs)
            cache.set(cache_key, rv, timeout=timeout)
            return rv
        return decorated_function
    return decorator

Обратите внимание, что это предполагает доступность экземпляра объекта cache, см. Кэширование для получения дополнительной информации.

Декоратор шаблонов

Распространенный паттерн, изобретенный парнями из TurboGears некоторое время назад, — это декоратор шаблонов. Идея этого декоратора заключается в том, что вы возвращаете словарь со значениями, переданными в шаблон из функции представления, и шаблон автоматически рендерится. В результате следующие три примера делают ровно то же самое:

@app.route('/')
def index():
    return render_template('index.html', value=42)

@app.route('/')
@templated('index.html')
def index():
    return dict(value=42)

@app.route('/')
@templated()
def index():
    return dict(value=42)

Как видите, если имя шаблона не указано, используется конечная точка карты URL с точками, преобразованными в косые черты + '.html'. В противном случае используется предоставленное имя шаблона. Когда функция с декоратором возвращает значение, возвращаемый словарь передается функции рендеринга шаблона. Если возвращается None, предполагается пустой словарь; если возвращается что-то другое, отличное от словаря, мы возвращаем его из функции без изменений. Таким образом, вы все еще можете использовать функцию перенаправления или возвращать простые строки.

Вот код этого декоратора:

from functools import wraps
from flask import request, render_template

def templated(template=None):
    def decorator(f):
        @wraps(f)
        def decorated_function(*args, **kwargs):
            template_name = template
            if template_name is None:
                template_name = request.endpoint \
                    .replace('.', '/') + '.html'
            ctx = f(*args, **kwargs)
            if ctx is None:
                ctx = {}
            elif not isinstance(ctx, dict):
                return ctx
            return render_template(template_name, **ctx)
        return decorated_function
    return decorator

Декоратор конечной точки

Если вы хотите использовать систему маршрутизации werkzeug для большей гибкости, вам необходимо сопоставить конечную точку, определенную в Rule, с функцией представления. Это возможно с помощью этого декоратора. Например:

from flask import Flask
from werkzeug.routing import Rule

app = Flask(__name__)
app.url_map.add(Rule('/', endpoint='index'))

@app.endpoint('index')
def my_index():
    return "Hello world"