Как украсить asyncio.coroutine, чтобы сохранить ее __name__?
-
21-12-2019 - |
Вопрос
Я попытался написать функцию-декоратор, которая обертывает asyncio.coroutine
и возвращает время, необходимое для завершения.Рецепт ниже содержит код, который работает так, как я ожидал.Моя единственная проблема в том, что каким-то образом я теряю имя декорированной функции, несмотря на использование @functools.wraps
.Как сохранить имя исходной сопрограммы?Я проверил источник asyncio.
import asyncio
import functools
import random
import time
MULTIPLIER = 5
def time_resulted(coro):
@functools.wraps(coro)
@asyncio.coroutine
def wrapper(*args, **kargs):
time_before = time.time()
result = yield from coro(*args, **kargs)
if result is not None:
raise TypeError('time resulted coroutine can '
'only return None')
return time_before, time.time()
print('= wrapper.__name__: {!r} ='.format(wrapper.__name__))
return wrapper
@time_resulted
@asyncio.coroutine
def random_sleep():
sleep_time = random.random() * MULTIPLIER
print('{} -> {}'.format(time.time(), sleep_time))
yield from asyncio.sleep(sleep_time)
if __name__ == '__main__':
loop = asyncio.get_event_loop()
tasks = [asyncio.Task(random_sleep()) for i in range(5)]
loop.run_until_complete(asyncio.wait(tasks))
loop.close()
for task in tasks:
print(task, task.result()[1] - task.result()[0])
print('= random_sleep.__name__: {!r} ='.format(
random_sleep.__name__))
print('= random_sleep().__name__: {!r} ='.format(
random_sleep().__name__))
Результат:
= wrapper.__name__: 'random_sleep' =
1397226479.00875 -> 4.261069174838891
1397226479.00875 -> 0.6596335046471768
1397226479.00875 -> 3.83421163259601
1397226479.00875 -> 2.5514027672929713
1397226479.00875 -> 4.497471439365472
Task(<wrapper>)<result=(1397226479.00875, 1397226483.274884)> 4.266134023666382
Task(<wrapper>)<result=(1397226479.00875, 1397226479.6697)> 0.6609499454498291
Task(<wrapper>)<result=(1397226479.00875, 1397226482.844265)> 3.835515022277832
Task(<wrapper>)<result=(1397226479.00875, 1397226481.562422)> 2.5536720752716064
Task(<wrapper>)<result=(1397226479.00875, 1397226483.51523)> 4.506479978561401
= random_sleep.__name__: 'random_sleep' =
= random_sleep().__name__: 'wrapper' =
Как вы видете random_sleep()
возвращает объект-генератор с другим именем.Я хотел бы сохранить имя декорированной сопрограммы.Я не знаю, специфична ли эта проблема для asyncio.coroutines
или нет.Я также пробовал код с разными порядками декораторов, но все получили тот же результат.Если я прокомментирую @functools.wraps(coro)
тогда даже random_sleep.__name__
становится wrapper
как я и предполагал.
РЕДАКТИРОВАТЬ:Я разместил эту проблему в Python Issue Tracker и получил следующий ответ от Р.Дэвид Мюррей:«Я думаю, что это конкретный случай более общей необходимости улучшения «оберток», которая не так давно обсуждалась на python-dev».
Решение
Проблема в том, что functools.wraps
меняется только wrapper.__name__
и wrapper().__name__
остается wrapper
. __name__
является атрибутом генератора только для чтения.Вы могли бы использовать exec
чтобы установить подходящее имя:
import asyncio
import functools
import uuid
from textwrap import dedent
def wrap_coroutine(coro, name_prefix='__' + uuid.uuid4().hex):
"""Like functools.wraps but preserves coroutine names."""
# attribute __name__ is not writable for a generator, set it dynamically
namespace = {
# use name_prefix to avoid an accidental name conflict
name_prefix + 'coro': coro,
name_prefix + 'functools': functools,
name_prefix + 'asyncio': asyncio,
}
exec(dedent('''
def {0}decorator({0}wrapper_coro):
@{0}functools.wraps({0}coro)
@{0}asyncio.coroutine
def {wrapper_name}(*{0}args, **{0}kwargs):
{0}result = yield from {0}wrapper_coro(*{0}args, **{0}kwargs)
return {0}result
return {wrapper_name}
''').format(name_prefix, wrapper_name=coro.__name__), namespace)
return namespace[name_prefix + 'decorator']
Использование:
def time_resulted(coro):
@wrap_coroutine(coro)
def wrapper(*args, **kargs):
# ...
return wrapper
Это работает, но, вероятно, есть лучший способ, чем использование exec()
.