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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
from collections.abc import Iterator
from typing import Any
import pytest
from pluggy import HookimplMarker
from pluggy import HookspecMarker
from pluggy import PluginManager
from pluggy import PluginValidationError
hookspec = HookspecMarker("example")
hookimpl = HookimplMarker("example")
def test_argmismatch(pm: PluginManager) -> None:
class Api:
@hookspec
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
class Plugin:
@hookimpl
def hello(self, argwrong):
pass
with pytest.raises(PluginValidationError) as exc:
pm.register(Plugin())
assert "argwrong" in str(exc.value)
def test_only_kwargs(pm: PluginManager) -> None:
class Api:
@hookspec
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
with pytest.raises(TypeError) as exc:
pm.hook.hello(3) # type: ignore[call-arg]
message = "__call__() takes 1 positional argument but 2 were given"
assert message in str(exc.value)
def test_opt_in_args(pm: PluginManager) -> None:
"""Verify that two hookimpls with mutex args can serve
under the same spec.
"""
class Api:
@hookspec
def hello(self, arg1, arg2, common_arg):
"api hook 1"
class Plugin1:
@hookimpl
def hello(self, arg1, common_arg):
return arg1 + common_arg
class Plugin2:
@hookimpl
def hello(self, arg2, common_arg):
return arg2 + common_arg
pm.add_hookspecs(Api)
pm.register(Plugin1())
pm.register(Plugin2())
results = pm.hook.hello(arg1=1, arg2=2, common_arg=0)
assert results == [2, 1]
def test_call_order(pm: PluginManager) -> None:
class Api:
@hookspec
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
class Plugin1:
@hookimpl
def hello(self, arg):
return 1
class Plugin2:
@hookimpl
def hello(self, arg):
return 2
class Plugin3:
@hookimpl
def hello(self, arg):
return 3
class Plugin4:
@hookimpl(hookwrapper=True)
def hello(self, arg):
assert arg == 0
outcome = yield
assert outcome.get_result() == [3, 2, 1]
assert outcome.exception is None
assert outcome.excinfo is None
class Plugin5:
@hookimpl(wrapper=True)
def hello(self, arg):
assert arg == 0
result = yield
assert result == [3, 2, 1]
return result
pm.register(Plugin1())
pm.register(Plugin2())
pm.register(Plugin3())
pm.register(Plugin4()) # hookwrapper should get same list result
pm.register(Plugin5()) # hookwrapper should get same list result
res = pm.hook.hello(arg=0)
assert res == [3, 2, 1]
def test_firstresult_definition(pm: PluginManager) -> None:
class Api:
@hookspec(firstresult=True)
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
class Plugin1:
@hookimpl
def hello(self, arg):
return arg + 1 # pragma: no cover
class Plugin2:
@hookimpl
def hello(self, arg):
return arg - 1
class Plugin3:
@hookimpl
def hello(self, arg):
return None
class Plugin4:
@hookimpl(wrapper=True)
def hello(self, arg):
assert arg == 3
outcome = yield
assert outcome == 2
return outcome
class Plugin5:
@hookimpl(hookwrapper=True)
def hello(self, arg):
assert arg == 3
outcome = yield
assert outcome.get_result() == 2
pm.register(Plugin1()) # discarded - not the last registered plugin
pm.register(Plugin2()) # used as result
pm.register(Plugin3()) # None result is ignored
pm.register(Plugin4()) # wrapper should get same non-list result
pm.register(Plugin5()) # hookwrapper should get same non-list result
res = pm.hook.hello(arg=3)
assert res == 2
def test_firstresult_force_result_hookwrapper(pm: PluginManager) -> None:
"""Verify forcing a result in a wrapper."""
class Api:
@hookspec(firstresult=True)
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
class Plugin1:
@hookimpl
def hello(self, arg):
return arg + 1
class Plugin2:
@hookimpl(hookwrapper=True)
def hello(self, arg):
assert arg == 3
outcome = yield
assert outcome.get_result() == 4
outcome.force_result(0)
class Plugin3:
@hookimpl
def hello(self, arg):
return None
pm.register(Plugin1())
pm.register(Plugin2()) # wrapper
pm.register(Plugin3()) # ignored since returns None
res = pm.hook.hello(arg=3)
assert res == 0 # this result is forced and not a list
def test_firstresult_force_result(pm: PluginManager) -> None:
"""Verify forcing a result in a wrapper."""
class Api:
@hookspec(firstresult=True)
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
class Plugin1:
@hookimpl
def hello(self, arg):
return arg + 1
class Plugin2:
@hookimpl(wrapper=True)
def hello(self, arg):
assert arg == 3
outcome = yield
assert outcome == 4
return 0
class Plugin3:
@hookimpl
def hello(self, arg):
return None
pm.register(Plugin1())
pm.register(Plugin2()) # wrapper
pm.register(Plugin3()) # ignored since returns None
res = pm.hook.hello(arg=3)
assert res == 0 # this result is forced and not a list
def test_firstresult_returns_none(pm: PluginManager) -> None:
"""If None results are returned by underlying implementations ensure
the multi-call loop returns a None value.
"""
class Api:
@hookspec(firstresult=True)
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
class Plugin1:
@hookimpl
def hello(self, arg):
return None
pm.register(Plugin1())
res = pm.hook.hello(arg=3)
assert res is None
def test_firstresult_no_plugin(pm: PluginManager) -> None:
"""If no implementations/plugins have been registered for a firstresult
hook the multi-call loop should return a None value.
"""
class Api:
@hookspec(firstresult=True)
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
res = pm.hook.hello(arg=3)
assert res is None
def test_no_hookspec(pm: PluginManager) -> None:
"""A hook with hookimpls can still be called even if no hookspec
was registered for it (and call_pending wasn't called to check
against it).
"""
class Plugin:
@hookimpl
def hello(self, arg):
return "Plugin.hello"
pm.register(Plugin())
assert pm.hook.hello(arg=10, extra=20) == ["Plugin.hello"]
def test_non_wrapper_generator(pm: PluginManager) -> None:
"""A hookimpl can be a generator without being a wrapper,
meaning it returns an iterator result."""
class Api:
@hookspec
def hello(self) -> Iterator[int]:
raise NotImplementedError()
pm.add_hookspecs(Api)
class Plugin1:
@hookimpl
def hello(self):
yield 1
class Plugin2:
@hookimpl
def hello(self):
yield 2
yield 3
class Plugin3:
@hookimpl(wrapper=True)
def hello(self):
return (yield)
pm.register(Plugin1())
pm.register(Plugin2()) # wrapper
res = pm.hook.hello()
assert [y for x in res for y in x] == [2, 3, 1]
pm.register(Plugin3())
res = pm.hook.hello()
assert [y for x in res for y in x] == [2, 3, 1]
@pytest.mark.parametrize(
"kind",
[
pytest.param(hookimpl(wrapper=True), id="wrapper"),
pytest.param(hookimpl(hookwrapper=True), id="legacy-wrapper"),
],
)
def test_wrappers_yield_twice_fails(pm: PluginManager, kind: Any) -> None:
class Plugin:
@kind
def wrap(self):
yield
yield
pm.register(Plugin())
with pytest.raises(
RuntimeError, match="wrap_controller at 'wrap'.* has second yield"
):
pm.hook.wrap()
@pytest.mark.parametrize(
"kind",
[
pytest.param(hookimpl(wrapper=True), id="wrapper"),
pytest.param(hookimpl(hookwrapper=True), id="legacy-wrapper"),
],
)
def test_wrappers_yield_never_fails(pm: PluginManager, kind: Any) -> None:
class Plugin:
@kind
def wrap(self):
if False:
yield # type: ignore[unreachable]
pm.register(Plugin())
with pytest.raises(RuntimeError, match="wrap_controller at 'wrap'.* did not yield"):
pm.hook.wrap()
|
