Декораторы с аргументамиА теперь попробуем написать декоратор, принимающий аргументы:
>>> def decorator_maker():
... print("Я создаю декораторы! Я буду вызван только раз: когда ты попросишь меня создать декоратор.")
... def my_decorator(func):
... print("Я - декоратор! Я буду вызван только раз: в момент декорирования функции.")
... def wrapped():
... print ("Я - обёртка вокруг декорируемой функции.\n"
... "Я буду вызвана каждый раз, когда ты вызываешь декорируемую функцию.\n"
... "Я возвращаю результат работы декорируемой функции.")
... return func()
... print("Я возвращаю обёрнутую функцию.")
... return wrapped
... print("Я возвращаю декоратор.")
... return my_decorator
...
>>> # Давайте теперь создадим декоратор. Это всего лишь ещё один вызов функции
>>> new_decorator = decorator_maker()
Я создаю декораторы! Я буду вызван только раз: когда ты попросишь меня создать декоратор.
Я возвращаю декоратор.
>>>
>>> # Теперь декорируем функцию
>>> def decorated_function():
... print("Я - декорируемая функция.")
...
>>> decorated_function = new_decorator(decorated_function)
Я - декоратор! Я буду вызван только раз: в момент декорирования функции.
Я возвращаю обёрнутую функцию.
>>> # Теперь наконец вызовем функцию:
>>> decorated_function()
Я - обёртка вокруг декорируемой функции.
Я буду вызвана каждый раз, когда ты вызываешь декорируемую функцию.
Я возвращаю результат работы декорируемой функции.
Я - декорируемая функция.
Теперь перепишем данный код с помощью декораторов:
>>> @decorator_maker()
... def decorated_function():
... print("Я - декорируемая функция.")
...
Я создаю декораторы! Я буду вызван только раз: когда ты попросишь меня создать декоратор.
Я возвращаю декоратор.
Я - декоратор! Я буду вызван только раз: в момент декорирования функции.
Я возвращаю обёрнутую функцию.
>>> decorated_function()
Я - обёртка вокруг декорируемой функции.
Я буду вызвана каждый раз когда ты вызываешь декорируемую функцию.
Я возвращаю результат работы декорируемой функции.
Я - декорируемая функция.
Вернёмся к аргументам декораторов, ведь, если мы используем функцию, чтобы создавать декораторы "на лету", мы можем передавать ей любые аргументы, верно?
>>> def decorator_maker_with_arguments(decorator_arg1, decorator_arg2):
... print("Я создаю декораторы! И я получил следующие аргументы:",
... decorator_arg1, decorator_arg2)
... def my_decorator(func):
... print("Я - декоратор. И ты всё же смог передать мне эти аргументы:",
... decorator_arg1, decorator_arg2)
... # Не перепутайте аргументы декораторов с аргументами функций!
... def wrapped(function_arg1, function_arg2):
... print ("Я - обёртка вокруг декорируемой функции.\n"
... "И я имею доступ ко всем аргументам\n"
... "\t- и декоратора: {0} {1}\n"
... "\t- и функции: {2} {3}\n"
... "Теперь я могу передать нужные аргументы дальше"
... .format(decorator_arg1, decorator_arg2,
... function_arg1, function_arg2))
... return func(function_arg1, function_arg2)
... return wrapped
... return my_decorator
...
>>> @decorator_maker_with_arguments("Леонард", "Шелдон")
... def decorated_function_with_arguments(function_arg1, function_arg2):
... print ("Я - декорируемая функция и я знаю только о своих аргументах: {0}"
... " {1}".format(function_arg1, function_arg2))
...
Я создаю декораторы! И я получил следующие аргументы: Леонард Шелдон
Я - декоратор. И ты всё же смог передать мне эти аргументы: Леонард Шелдон
>>> decorated_function_with_arguments("Раджеш", "Говард")
Я - обёртка вокруг декорируемой функции.
И я имею доступ ко всем аргументам
- и декоратора: Леонард Шелдон
- и функции: Раджеш Говард
Теперь я могу передать нужные аргументы дальше
Я - декорируемая функция и я знаю только о своих аргументах: Раджеш Говард
Таким образом, мы можем передавать декоратору любые аргументы, как обычной функции. Мы можем использовать и распаковку через *args и **kwargs в случае необходимости. Некоторые особенности работы с декораторами
Последняя проблема частично решена добавлением в модуле functools функции functools.wraps, копирующей всю информацию об оборачиваемой функции (её имя, из какого она модуля, её документацию и т.п.) в функцию-обёртку. Забавным фактом является то, что functools.wraps тоже является декоратором.
>>> def foo():
... print("foo")
...
>>> print(foo.__name__)
foo
>>> # Однако, декораторы мешают нормальному ходу дел:
... def bar(func):
... def wrapper():
... print("bar")
... return func()
... return wrapper
...
>>> @bar
... def foo():
... print("foo")
...
>>> print(foo.__name__)
wrapper
>>> import functools # "functools" может нам с этим помочь
>>> def bar(func):
... # Объявляем "wrapper" оборачивающим "func"
... # и запускаем магию:
... @functools.wraps(func)
... def wrapper():
... print("bar")
... return func()
... return wrapper
...
>>> @bar
... def foo():
... print("foo")
...
>>> print(foo.__name__)
foo
Примеры использования декораторовДекораторы могут быть использованы для расширения возможностей функций из сторонних библиотек (код которых мы не можем изменять), или для упрощения отладки (мы не хотим изменять код, который ещё не устоялся). Также полезно использовать декораторы для расширения различных функций одним и тем же кодом, без повторного его переписывания каждый раз, например:
>>> def benchmark(func):
... """
... Декоратор, выводящий время, которое заняло
... выполнение декорируемой функции.
... """
... import time
... def wrapper(*args, **kwargs):
... t = time.clock()
... res = func(*args, **kwargs)
... print(func.__name__, time.clock() - t)
... return res
... return wrapper
...
>>> def logging(func):
... """
... Декоратор, логирующий работу кода.
... (хорошо, он просто выводит вызовы, но тут могло быть и логирование!)
... """
... def wrapper(*args, **kwargs):
... res = func(*args, **kwargs)
... print(func.__name__, args, kwargs)
... return res
... return wrapper
...
>>> def counter(func):
... """
... Декоратор, считающий и выводящий количество вызовов
... декорируемой функции.
... """
... def wrapper(*args, **kwargs):
... wrapper.count += 1
... res = func(*args, **kwargs)
... print("{0} была вызвана: {1}x".format(func.__name__, wrapper.count))
... return res
... wrapper.count = 0
... return wrapper
...
>>> @benchmark
... @logging
... @counter
... def reverse_string(string):
... return ''.join(reversed(string))
...
>>> print(reverse_string("А роза упала на лапу Азора"))
reverse_string была вызвана: 1x
wrapper ('А роза упала на лапу Азора',) {}
wrapper 0.00011799999999997923
арозА упал ан алапу азор А
>>> print(reverse_string("A man, a plan, a canoe, pasta, heros, rajahs, a coloratura,"
... "maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag,"
... "a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash,"
... "a jar, sore hats, a peon, a canal: Panama!"))
reverse_string была вызвана: 2x
wrapper ('A man, a plan, a canoe, pasta, heros, rajahs, a coloratura,maps, snipe, ...',) {}
wrapper 0.00017800000000001148
!amanaP :lanac a ,noep a ,stah eros ,raj a,hsac ,oloR a ,tur a ,mapS ,sni
| |
| |
Просмотров: 332 | |
Всего комментариев: 0 | |