Como decorar uma asyncio.coroutine para manter seu __name__?
-
21-12-2019 - |
Pergunta
Eu tentei escrever uma função decoradora que envolve um asyncio.coroutine
e retorna o tempo que levou para ser concluído.A receita abaixo contém o código que está funcionando como eu esperava.Meu único problema é que de alguma forma perdi o nome da função decorada, apesar do uso de @functools.wraps
.Como manter o nome da corrotina original?Eu verifiquei a fonte de 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__))
O resultado:
= 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' =
Como você pode ver random_sleep()
retorna um objeto gerador com nome diferente.Gostaria de manter o nome da corrotina decorada.Não sei se esse problema é específico de asyncio.coroutines
ou não.Também tentei o código com diferentes pedidos de decoradores, mas todos tiveram o mesmo resultado.Se eu comentar @functools.wraps(coro)
então até random_sleep.__name__
torna-se wrapper
como eu esperava.
EDITAR:Publiquei esse problema no Python Issue Tracker e recebi a seguinte resposta de R.David Murray:"Acho que este é um caso específico de uma necessidade mais geral de melhorar os 'envoltórios' que foi discutida no python-dev há pouco tempo."
Solução
A questão é que functools.wraps
apenas alterações wrapper.__name__
e wrapper().__name__
fica wrapper
. __name__
é um atributo gerador somente leitura.Você poderia usar exec
para definir o nome apropriado:
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']
Uso:
def time_resulted(coro):
@wrap_coroutine(coro)
def wrapper(*args, **kargs):
# ...
return wrapper
Funciona, mas provavelmente existe uma maneira melhor do que usar exec()
.