Python: декораторы

Функция — такое же значение, как число#

Без этого дальше не пойдёт: функцию в Python можно положить в переменную,
передать аргументом и вернуть из другой функции.

def shout(text):
    return text.upper()

f = shout                 # без скобок — сама функция, не результат
print(f("привет"))        # ПРИВЕТ
print(list(map(shout, ["a", "b"])))   # ['A', 'B']

Скобки означают вызов. f = shout — это ссылка, f = shout("x") — результат
вызова. Путаница между ними — источник половины ошибок в этой теме.

Простейший декоратор#

Декоратор принимает функцию, определяет внутри обёртку и возвращает её.

def loud(func):
    def wrapper(*args, **kwargs):
        print("вызов", func.__name__)
        result = func(*args, **kwargs)
        print("результат", result)
        return result
    return wrapper

@loud
def add(a, b):
    return a + b

print(add(2, 3))
  # вызов add
  # результат 5
  # 5

Запись @loud над def add равнозначна строке add = loud(add) после
определения. Ничего больше в ней нет.

Обёртка принимает *args, **kwargs, чтобы подойти к функции с любой
сигнатурой, и обязательно возвращает результат — иначе декорированная функция
начнёт молча отдавать None. Это ошибка, которую ищут дольше всего.

Сохранить имя функции#

Без дополнительных мер декорированная функция подменяется обёрткой, и об этом
узнаёт всё, что смотрит на имя и документацию:

print(add.__name__)   # wrapper

Лечится одной строкой — functools.wraps копирует имя, документацию и
аннотации из исходной функции в обёртку:

import functools

def loud(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    return wrapper

@loud
def add(a, b):
    """Сложить два числа."""
    return a + b

print(add.__name__, "|", add.__doc__)   # add | Сложить два числа.

Декоратор с аргументами#

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

import functools

def repeat(times):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            for _ in range(times):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator

@repeat(times=3)
def hello():
    print("привет")
    return "ок"

print(hello())
  # привет / привет / привет / ок

Отсюда правило: декоратор с аргументами пишется со скобками — @repeat(3), а
без аргументов скобок нет — @loud. Перепутать легко: @repeat без скобок
передаст саму функцию в параметр times, и падение случится не при
объявлении, а при первом вызове.

Порядок и готовые декораторы#

Несколько декораторов применяются снизу вверх — ближний к def оборачивает
первым:

@a
@b
def f():
    ...
  # равнозначно f = a(b(f))

В стандартной библиотеке уже есть полезные декораторы. functools.lru_cache
запоминает результаты вызовов:

import functools

@functools.lru_cache(maxsize=None)
def fib(n):
    return n if n < 2 else fib(n - 1) + fib(n - 2)

print(fib(30))            # 832040
print(fib.cache_info().hits)   # 28

Без кеша тот же fib(30) считался бы больше миллиона раз. Ещё из привычных —
@property, @staticmethod и @classmethod, которые применяются к методам
и разобраны в статье про классы.

Практика на полчаса: напиши декоратор timed, который печатает время
выполнения через time.perf_counter, и декоратор retry(times), повторяющий
вызов при исключении, — второй опирается на
обработку ошибок.

План по этапам

1. Функция в переменнойПрисвоить функцию переменной без скобок, вызвать через новое имя, сравнить с присваиванием результата.
2. Обёртка вручнуюНаписать wrapper и применить его строкой f = deco(f), без знака @.
3. Перевести на @Заменить ручное присваивание на декоратор и убедиться, что поведение то же.
4. Добавить functools.wrapsПроверить __name__ до и после добавления wraps.
5. Декоратор с параметромСделать repeat(times) и вызвать функцию с разными значениями параметра.

Проверь себя

Источники

• Модуль functoolswraps, lru_cache, cache и другие готовые обёртки
  бесплатно
• Справочник языка: декораторыФормальное описание, во что разворачивается знак @
  бесплатно
• StepikКурсы по Python, где декораторы идут с автопроверкой
  бесплатно

Было полезно?

Да Нет