Декораторы в Python (2)

Обновлённая версия презентации
https://speakerdeck.com/cogwheelhead/python-decorators

Transcript

2. Упаковки и распаковки
3. def func(*args, **kwargs): print(type(args), args) print(type(kwargs), kwargs) func(1, 2, 3, a=1, b=2, c=3) >>> <class 'tuple'> (1, 2, 3) <class 'dict'> {'a': 1, 'b': 2, 'c': 3}
4. def somefunc(a, b, ..., *other_args, kw_a=1, kw_b=2, ..., **other_kwargs)
5. first, second, *other = [1, 2, 3, 4, 5] print(first, second, other) >>> 1 2 [3, 4, 5] first, second, *other = (1, 2, 3, 4, 5) print(first, second, other) >>> 1 2 [3, 4, 5]
6. def sum_of_three(a, b, c): return a + b + c three = [1, 2, 3] print(sum_of_three(*three)) >>> 6
7. Атрибуты функций
8. def identity(x): '''Identity function''' return x f = identity for attribute in (f.__name__, f.__doc__, f.__module__, f.__class__): print(attribute) >>> identity Identity function __main__ <class 'function'>
9. Анонимные функции
10. def add_f(x, y): return x + y add_l = lambda x, y: x + y print(add_f(17, 25), add_l(29, 13), (lambda x, y: x + y)(11, 31)) >>> 42 42 42
11. Области видимости
12. def a(a_arg): a_var = 20 def inner(inner_arg): inner_var = 42 def innermost(innermost_arg): innermost_var = 101 def b(b_arg): b_var = 31415
13. Функции первого класса
14. compute_square = {'circle': lambda r: pi * r**2, 'rectangle': lambda a, b: a * b}
15. xs = [3, 14, 15, 92, 65] max_index = max((0, 1, 2, 3, 4), key=lambda i: xs[i]) print(max_index) >>> 3
16. Функции высшего порядка
18. def D(f): def derivative(x): return (f(x + 0.00001) - f(x)) / 0.00001 return derivative def f(x): return x**2 g = D(f) print(g(5)) >>> 10.000009999799886
19. Замыкания
20. def make_greeter(phrase): prefix = phrase + ', ' def greeter(name): return prefix + name return greeter casual_greeter = make_greeter('Hello') informal_greeter = make_greeter('Sup') mysterious_greeter = make_greeter('So we meet again')
21. print('\n'.join((casual_greeter('World'), informal_greeter('Dvach'), mysterious_greeter('my heartache')))) >>> Hello, World Sup, Dvach So we meet again, my heartache
23. Мотивирующий пример
24. from time import time tmp = time() func1('<...>') print('func1 execution time:', time() - tmp) from time import time tmp = time() func2('<...>') print('func2 execution time:', time() - tmp)
25. Ctrl-c, ctrl-v
26. def execution_time(func, *args, **kwargs): from time import time tmp = time() func(*args, **kwargs) return time() - tmp
27. def print_execution_time(func, *args, **kwargs): from time import time tmp = time() result = func(*args, **kwargs) print(fun.__name__, 'executed; time:', time() - tmp) return result smth1 = print_execution_time(func1, '<...>') smth2 = print_execution_time(func2, '<...>')
28. Давайте помечтаем
29. def func1('<...>'): # заменим имя func1 на dreamfunc1 from time import time tmp = time() '<...>' print('func1 executed; time:', time() - tmp) return '<...>' def func2('<...>'): # заменим имя func2 на dreamfunc2 from time import time tmp = time() '<...>' print('func2 executed; time:', time() - tmp) return '<...>'
30. Ctrl-c, ctrl-v
31. def make_dreamfunc(func): def dreamfunc(*args, **kwargs): tmp = time() result = func(*args, **kwargs) print(func.__name__, 'executed, time:', time() - tmp) return result return dreamfunc dreamfunc1 = make_dreamfunc(func1) dreamfunc2 = make_dreamfunc(func2)
32. def timed(func): def timed_func(*args, **kwargs): tmp = time() result = func(*args, **kwargs) print(func.__name__, 'executed, time:', time() - tmp) return result return timed_func t_func1 = timed(func1) t_func2 = timed(func2)
33. t_func = timed(func) vs func = timed(func)
34. Пуды сахара
35. @decorator def func('<...>'): '<...>' # то же, что и def func('<...>'): '<...>' func = decorator(func)
36. А зачем?
37. @sends_emails_to_bob @logged @timed def fibonacci_number(n): '<...>' # здесь считается result return result # vs def fibonacci_number(n): from time import time tmp = time() logs = open('logs.txt', a) '<...>' # здесь считается result execution_time = time() - tmp logs.write(func.__name__, execution_time) print('fibonacci_number executed; time:', execution_time_) send_email_to_bob('Hey! Check out how fast it is! ', execution_time) return result
38. Подопытный кролик
39. @introduce def identity(x): return x print(identity(42)) >>> identity 42
40. def introduce('<...>'): return '<...>'
41. def introduce(func): def wrapper('<...>'): '<...>' return '<...>' return wrapper
42. def introduce(func): def wrapper(*args, **kwargs): '<...>' return func(*args, **kwargs) return wrapper
43. Мемоизация
44. def memoized(func): memory = {} def wrapper(*args, **kwargs): key = (args, tuple(sorted(kwargs.items()))) if key not in memory: memory[key] = func(*args, **kwargs) return memory[key]) return wrapper
45. Проведём испытание
46. @timed @memoized def collatz_sequence(n): while n != 1: print(n) n = (3*n + 1) if n % 2 else (n // 2)
47. collatz(2718281828459045235360287471352662497757) >>> 2718281828459045235360287471352662497757 8154845485377135706080862414057987493272 4077422742688567853040431207028993746636 2038711371344283926520215603514496873318 1019355685672141963260107801757248436659 3058067057016425889780323405271745309978 1529033528508212944890161702635872654989 <...> 16 8 4 2 wrapper executed, time: 0.2280245304107666
48. collatz(2718281828459045235360287471352662497757) wrapper executed, time: 0.0
49. Как перевернуть игру
50. @flip def div(x, y, show=False): res = x / y if show: print(res) return res div(2, 4, show=True) >>> 2.0
51. Как ничего не делать
52. @introduce_on_debug def identity(x): return x # включена оптимизация (программа запушена с флагом -O) identity(239) >>> 239 # в противном случае identity(57) >>> identity 57
53. Как добавить опций
54. @optional_introduce def identity(x): return x print(identity(20)) >>> 20 print(identity(42, introduce=True)) >>> identity 42
55. Как правильно оборачивать
56. Проблемы
57. @introduce def identity(x): return x identity(20) >>> identity print(identity.__name__) >>> wrapper
58. def decorator(func): def wrapper(*args, **kwargs): '<...>' return func(*args, **kwargs) wrapper.__name__ = func.__name__ wrapper.__doc__ = func.__doc__ '<...>' return wrapper
59. def is_wrapper(wrapper, func): wrapper.__name__ = func.__name__ wrapper.__doc__ = func.__doc__ '<...>' def decorator(func): def wrapper(*args, **kwargs): '<...>' return fun(*args, **kwargs) is_wrapper(wrapper, func) return wrapper
60. Давайте помечтаем
61. def decorator(func): @wrapper_decorator def wrapper(*args, **kwargs): '<...>' return func(*args, **kwargs) return wrapper
62. def wrapper_deocrator(wrapper): wrapper.__name__ = func.__name__ wrapper.__doc__ = func.__doc__ '<...>' return wrapper
63. def make_wrapper_decorator(func): def wrapper_decorator(wrapper): wrapper.__name__ = func.__name__ wrapper.__doc__ = func.__doc__ '<...>' return wrapper return wrapper_decorator
64. def decorator(func): wrapper_decorator = make_wrapper_decorator(func) @wrapper_decorator def wrapper(*args, **kwargs): '<...>' return func(*args, **kwargs) return wrapper
65. Финт ушами
66. def decorator(func): @make_wrapper_decorator(func) def wrapper(*args, **kwargs): '<...>' return func(*args, **kwargs) return wrapper
67. def wrapper_decorator(func): def actual_decorator(wrapper): wrapper.__name__ = func.__name__ wrapper.__doc__ = func.__doc__ '<...>' return wrapper return actual_decorator
68. def decorator(func): @wrapper_decorator(func) def wrapper(*args, **kwargs): '<...>' return func(*args, **kwargs) return wrapper
69. Изобрели велосипед
70. from functools import wraps
71. def decorator(func): @wraps(func) def wrapper(*args, **kwargs): '<...>' return func(*args, **kwargs) return wrapper
72. Декораторы с параметрами
73. Хотим ещё так
74. @introduce(4) def identity(x): return x print(identity(42)) >>> identity identity identity identity 42
75. # исходная версия def introduce(func): @wraps(func) def wrapper(*args, **kwargs): print(func.__name__) return func(*args, **kwargs) return wrapper
76. # используем “внешний” параметр n def introduce(func): @wraps(func) def wrapper(*args, **kwargs): print((func.__name__ + '\n') * n) return func(*args, **kwargs) return wrapper
77. # предоставляем параметр n def make_introduce(n): def introduce(func): @wraps(func) def wrapper(*args, **kwargs): print((func.__name__ + '\n') * n) return func(*args, **kwargs) return wrapper return introduce
78. # переименовываем всё для пущей красоты def introduce(n): def actual_decorator(func): @wraps(func) def wrapper(*args, **kwargs): print((func.__name__ + '\n') * n) return func(*args, **kwargs) return wrapper return actual_decorator
79. Давайте помечтаем
80. def introduce(func, n, newline=True): @wraps(func) def wrapper(*args, **kwargs): print(('\n' if newline else ' ').join([func.__name__] * n)) return func(*args, **kwargs) return wrapper
81. @introduce(3, newline=False) def identity(x): return x print(identity(42)) >>> identity identity identity 42
82. Декораторы для декораторов
83. @parameterized def introduce(func, n, newline=True): @wraps(func) def wrapper(*args, **kwargs): print(*([func.__name__]*n), sep='\n' if newline else ' ') return func(*args, **kwargs) return wrapper
84. def parameterized(init_deco): def param_deco(<...>): <...> return param_deco
85. def parameterized(init_deco): def param_deco(*decargs, **deckwargs): def res_deco(<...>): <...> return res_decorator return param_deco
86. def parameterized(init_deco): def param_deco(*decargs, **deckwargs): def res_deco(func): return init_deco(func, *decargs, **deckwargs) return res_deco return param_deco
87. Повторим успех
88. @decorator def deco(f, *args, **kwargs): # <...> делаем свои декораторские дела return f(*args, **kwargs)
89. @decorator def introduce(f, *args, **kwargs): print(f.__name__) return f(*args, **kwargs) @introduce def identity(x): return x print(identity(31415)) >>> identity 31415
90. def decorator(wanna_be_decorator): def res_decorator(<...>): <...> return res_decorator
91. def decorator(wanna_be_decorator): def res_decorator(func): def new_func(*args, **kwargs): return <...> return new_func return res_decorator
92. Одна косметическая деталь
93. def introduce(num=1): def decorator(func): @wraps(func) def wrapper(*args, **kwargs): print((func.__name__ + ' ') * num) return func(*args, **kwargs) return wrapper return decorator
94. @introduce(2) def id(x): return x print(id(42)) >>> id id 42 @introduce() def id(x): return x print(id(42)) >>> id 42
95. A partial solution
96. from functools import partial
97. def multiply(x, y): return x * y def twice(y): twice = partial(multiply, 2) return multiply(2, y) def bin_to_int(b): bin_to_int = partial(int, base=2) return int(b, base=2) def printnext(string): printnext = partial(print, end=' ') print(string, end=' ')
98. def introduce(func=None, num=1): if func is None: return partial(introduce, num=num) @wraps(func) def wrapper(*args, **kwargs): print((func.__name__ + ' ') * num) return func(*args, **kwargs) return wrapper
99. @introduce(num=2) def id(x): return x print(id(42)) >>> id id 42 @introduce() def id(x): return x print(id(42)) >>> id 42
100. Я солгал
101. Декораторы возвращают не функции
102. @str def identity(x): return x print(identity, type(identity)) >>> <function identity at 0x...> <class 'str'>
103. def call(arg): def actual_decorator(func): return func(arg) return actual_decorator
104. n = 5 @call('la') def printfew(string): n = 3 print(string * n) >>> lalala
105. Декораторы принимают не функции
106. def defined(obj): (defined.info).append(obj) defined.info = [] @defined class SomeClass: pass print(defined.info) >>> [__main__.SomeClass]
107. from operator import attrgetter as attribute @len @attribute('__name__') def twenty_four_symbols_long(): pass print(twenty_four_symbols_long) >>> 24
108. Декораторы – это не функции
109. class GentleFunction: def __init__(self, func): self._func = func self._name = func.__name__ def __call__(self, *args, **kwargs): print ('My name is', self._name) return self._func(*args, **kwargs)
110. @GentleFunction def identity(x): return x print(identity(42)) >>> My name is identity 42
111. И что теперь?
112. from types import MethodType def add_method(obj): def actual_decorator(func): func = MethodType(func, obj) setattr(obj, func.__name__, func) return func return actual_decorator
113. class Named: def __init__(self, name): self.name = name a = Named('Alice') @add_method(a) def introduce(self): print(self.name) a.introduce() >>> Alice
114. def check(*preconditions): def actual_decorator(func): @wraps(func) def wrapper(*args, **kwargs): arg_names = func.__code__.co_varnames environment = dict(zip(arg_names, args)) environment.update(kwargs) for cond, msg in preconditions: if not eval(cond, environment): raise ValueError(msg) return func(*args, **kwargs) return wrapper return actual_decorator
115. @check( ('all(xs[i] <= xs[i+1] for i in range(len(xs)-1))', 'The data is not sorted'), ('x != 0', 'Can not seek for zeros for some reason')) def binsearch(x, xs): pass binsearch(2, [1, 2, 3]) # всё хорошо binsearch(0, [1, 2, 3]) # исключение (нельзя искать нуль) binsearch(1, [1, 2, 1]) # исключение (данные не отсортированы)
116. @apply def e(): summand = n = acc = 1 threshold = 0.00001 while summand >= threshold: acc += summand n += 1 summand /= n return acc print(e, type(e)) >>> 2.71827876984127 <class 'float'>
117. @apply(2, 3) def multiply(x, y): return x * y print(multiply, type(multiply)) >>> 6, <class 'int'>
118. class Collection: def __init__(self, xs): self.data = xs def length(self): return len(self.data) some_collection = Collection([1, 2, 3]) print(some_collection.length()) >>> 3
119. class Field: def __init__(self, func_to_get): self.func_to_get = func_to_get def __get__(self, obj, objtype): return self.func_to_get(obj)
120. class Collection: def __init__(self, xs): self.data = xs @Field def length(self): return len(self.data) some_collection = Collection([1, 2, 3]) print(some_collection.length) >>> 3
121. from patterns import patterns @patterns def product(): if []: 1 if [x] + xs: x * product(xs)
122. def product(value): if value == []: return 1 if isinstance(value, list) and len(value) >= 1: x, xs = value[0], value[1:] return x * product(xs)
123. Подведение итогов
124. Декоратор как паттерн
125. from functools import wraps # <- всегда используем wraps def decorator(initial_function): @wraps(initial_function) def new_function(*args, **kwargs): # <...> всякие полезности return initial_function(*args, **kwargs) return new_function
126. Декоратор как особенность Python
127.  Изменение интерфейсов (в т.ч. при помощи “магии”)  Изменение объектов: атрибуты, методы (добавлять, менять значения)  Регистрация, аннотация объявляемых объектов (классов, функций)  Применение конструкторов классов, в т.ч. дескрипторов  Предпроверка условий, предобрабокта входных данных  И другие применения