¿Cómo decorar una asyncio.coroutine para conservar su __nombre__?
-
21-12-2019 - |
Pregunta
Intenté escribir una función decoradora que envuelva un asyncio.coroutine
y devuelve el tiempo que tardó en realizarse.La siguiente receta contiene el código que funciona como esperaba.Mi único problema es que de alguna manera pierdo el nombre de la función decorada a pesar del uso de @functools.wraps
.¿Cómo conservar el nombre de la corrutina original?Revisé la fuente 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__))
El 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 se puede ver random_sleep()
devuelve un objeto generador con nombre diferente.Me gustaría conservar el nombre de la corrutina decorada.No sé si este problema es específico de asyncio.coroutines
O no.También probé el código con diferentes órdenes de decoradores, pero todos tienen el mismo resultado.si comento @functools.wraps(coro)
entonces incluso random_sleep.__name__
se convierte wrapper
como yo esperaba.
EDITAR:Publiqué este problema en Python Issue Tracker y recibí la siguiente respuesta de R.David Murray:"Creo que este es un caso específico de una necesidad más general de mejorar las 'envolturas' que se discutió en python-dev no hace mucho tiempo".
Solución
La cuestión es que functools.wraps
solo cambios wrapper.__name__
y wrapper().__name__
corsé wrapper
. __name__
es un atributo generador de solo lectura.Podrías usar exec
para establecer el nombre apropiado:
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, pero probablemente haya una manera mejor que usar exec()
.