1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
from __future__ import print_function
import inspect
import unittest
import types
from typing import Iterable
import wrapt
from compat import PY2, exec_
DECORATORS_CODE = """
import wrapt
from typing import Iterable
def prototype1(arg1, arg2, arg3=None, *args, **kwargs) -> Iterable: pass
@wrapt.decorator(adapter=prototype1)
def adapter1(wrapped, instance, args, kwargs):
'''adapter documentation'''
return wrapped(*args, **kwargs)
def prototype2(arg1, arg2, arg3=None, *args, **kwargs) -> int: pass
@wrapt.decorator(adapter=prototype2)
def adapter2(wrapped, instance, args, kwargs):
'''adapter documentation'''
return wrapped(*args, **kwargs)
"""
decorators = types.ModuleType('decorators')
exec_(DECORATORS_CODE, decorators.__dict__, decorators.__dict__)
def function1(arg1, arg2) -> Iterable:
'''documentation'''
return arg1, arg2
function1o = function1
@decorators.adapter1
def function1(arg1, arg2) -> Iterable:
'''documentation'''
return arg1, arg2
function1d = function1
def function2(arg1, arg2) -> Iterable:
'''documentation'''
return arg1, arg2
function2o = function2
@decorators.adapter1
def function2(arg1, arg2) -> Iterable:
'''documentation'''
return arg1, arg2
function2d = function2
class TestAdapterAttributesWithAnnotations(unittest.TestCase):
def test_annotations(self):
# Test preservation of function __annotations__ attribute.
self.assertEqual(function1d.__annotations__, function1o.__annotations__)
class TestArgumentSpecificationWithAnnotations(unittest.TestCase):
def test_argspec(self):
# Test preservation of function argument specification. It
# actually needs to match that of the adapter function the
# prototype of which was supplied via the dummy function.
def _adapter(arg1, arg2, arg3=None, *args, **kwargs) -> Iterable: pass
function1a_argspec = inspect.getfullargspec(_adapter)
function1d_argspec = inspect.getfullargspec(function1d)
self.assertEqual(function1a_argspec, function1d_argspec)
# Now bind the function to an instance. The argspec should
# still match.
bound_function1d = function1d.__get__(object(), object)
bound_function1d_argspec = inspect.getfullargspec(bound_function1d)
self.assertEqual(function1a_argspec, bound_function1d_argspec)
def test_signature(self):
# Test preservation of function argument specification. It
# actually needs to match that of the adapter function the
# prototype of which was supplied via the dummy function.
if PY2:
return
def _adapter(arg1, arg2, arg3=None, *args, **kwargs) -> Iterable: pass
function1a_signature = str(inspect.signature(_adapter))
function1d_signature = str(inspect.signature(function1d))
self.assertEqual(function1a_signature, function1d_signature)
def test_isinstance(self):
# Test preservation of isinstance() checks.
self.assertTrue(isinstance(function1d, type(function1o)))
class TestDynamicAdapterWithAnnotations(unittest.TestCase):
def test_dynamic_adapter_function(self):
def _adapter1(arg1, arg2, arg3=None, *args, **kwargs) -> Iterable: pass
argspec1 = inspect.getfullargspec(_adapter1)
@wrapt.decorator(adapter=argspec1)
def _wrapper_1(wrapped, instance, args, kwargs):
return wrapped(*args, **kwargs)
@_wrapper_1
def _function_1():
pass
self.assertEqual(inspect.getfullargspec(_function_1), argspec1)
# Can't use a function signature with adapter factory which has
# annotations which reference a non builtin type, so use test
# function which returns int rather than Iterable.
def _adapter2(arg1, arg2, arg3=None, *args, **kwargs) -> int: pass
argspec2 = inspect.getfullargspec(_adapter2)
args = '(arg1, arg2, arg3=None, *args, **kwargs) -> int'
@wrapt.decorator(adapter=args)
def _wrapper_2(wrapped, instance, args, kwargs):
return wrapped(*args, **kwargs)
@_wrapper_2
def _function_2():
pass
self.assertEqual(inspect.getfullargspec(_function_2), argspec2)
def test_dynamic_adapter_instancemethod(self):
def _adapter1(self, arg1, arg2, arg3=None, *args, **kwargs) -> Iterable: pass
argspec1 = inspect.getfullargspec(_adapter1)
@wrapt.decorator(adapter=argspec1)
def _wrapper_1(wrapped, instance, args, kwargs):
return wrapped(*args, **kwargs)
class Class1(object):
@_wrapper_1
def function(self):
pass
instance1 = Class1()
self.assertEqual(inspect.getfullargspec(Class1.function), argspec1)
self.assertEqual(inspect.getfullargspec(instance1.function), argspec1)
# Can't use a function signature with adapter factory which has
# annotations which reference a non builtin type.
def _adapter2(self, arg1, arg2, arg3=None, *args, **kwargs) -> int: pass
argspec2 = inspect.getfullargspec(_adapter2)
args = '(self, arg1, arg2, arg3=None, *args, **kwargs) -> int'
@wrapt.decorator(adapter=args)
def _wrapper_2(wrapped, instance, args, kwargs):
return wrapped(*args, **kwargs)
class Class2(object):
@_wrapper_2
def function(self):
pass
instance2 = Class2()
self.assertEqual(inspect.getfullargspec(Class2.function), argspec2)
self.assertEqual(inspect.getfullargspec(instance2.function), argspec2)
def test_dynamic_adapter_classmethod(self):
def _adapter1(cls, arg1, arg2, arg3=None, *args, **kwargs) -> Iterable: pass
argspec1 = inspect.getfullargspec(_adapter1)
@wrapt.decorator(adapter=argspec1)
def _wrapper_1(wrapped, instance, args, kwargs):
return wrapped(*args, **kwargs)
class Class1(object):
@_wrapper_1
@classmethod
def function(cls):
pass
instance1 = Class1()
self.assertEqual(inspect.getfullargspec(Class1.function), argspec1)
self.assertEqual(inspect.getfullargspec(instance1.function), argspec1)
# Can't use a function signature with adapter factory which has
# annotations which reference a non builtin type.
def _adapter2(cls, arg1, arg2, arg3=None, *args, **kwargs) -> int: pass
argspec2 = inspect.getfullargspec(_adapter2)
args = '(cls, arg1, arg2, arg3=None, *args, **kwargs) -> int'
@wrapt.decorator(adapter=args)
def _wrapper_2(wrapped, instance, args, kwargs):
return wrapped(*args, **kwargs)
class Class2(object):
@_wrapper_2
@classmethod
def function(self):
pass
instance2 = Class2()
self.assertEqual(inspect.getfullargspec(Class2.function), argspec2)
self.assertEqual(inspect.getfullargspec(instance2.function), argspec2)
def test_adapter_factory(self):
def factory(wrapped):
argspec = inspect.getfullargspec(wrapped)
argspec.args.insert(0, 'arg0')
return argspec
@wrapt.decorator(adapter=wrapt.adapter_factory(factory))
def _wrapper_1(wrapped, instance, args, kwargs):
return wrapped(*args, **kwargs)
@_wrapper_1
def _function_1(arg1, arg2) -> Iterable:
pass
argspec = inspect.getfullargspec(_function_1)
self.assertEqual(argspec.args, ['arg0', 'arg1', 'arg2'])
self.assertEqual(argspec.annotations, {'return': Iterable})
if __name__ == '__main__':
unittest.main()
|
