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
|
import pytest
from napari_plugin_engine import (
HookImplementation,
HookImplementationMarker,
HookSpecification,
HookSpecificationMarker,
PluginValidationError,
)
example_hookspec = HookSpecificationMarker("example")
example_implementation = HookImplementationMarker("example")
@pytest.fixture
def hook_caller(pm):
class Hooks:
@example_hookspec
def method1(self, arg):
pass
pm.add_hookspecs(Hooks)
return pm.hook.method1
@pytest.fixture
def addmeth(hook_caller):
def addmeth(tryfirst=False, trylast=False, hookwrapper=False):
def wrap(func):
example_implementation(
tryfirst=tryfirst, trylast=trylast, hookwrapper=hookwrapper
)(func)
hook_caller._add_hookimpl(
HookImplementation(func, **func.example_impl)
)
return func
return wrap
return addmeth
def funcs(hookmethods):
return [hookmethod.function for hookmethod in hookmethods]
def test_adding_nonwrappers(hook_caller, addmeth):
@addmeth()
def method1():
pass
@addmeth()
def method2():
pass
@addmeth()
def method3():
pass
assert funcs(hook_caller._nonwrappers) == [method1, method2, method3]
def test_adding_nonwrappers_trylast(hook_caller, addmeth):
@addmeth()
def method1_middle():
pass
@addmeth(trylast=True)
def method1():
pass
@addmeth()
def method1_b():
pass
assert funcs(hook_caller._nonwrappers) == [
method1,
method1_middle,
method1_b,
]
def test_adding_nonwrappers_trylast3(hook_caller, addmeth):
@addmeth()
def method1_a():
pass
@addmeth(trylast=True)
def method1_b():
pass
@addmeth()
def method1_c():
pass
@addmeth(trylast=True)
def method1_d():
pass
assert funcs(hook_caller._nonwrappers) == [
method1_d,
method1_b,
method1_a,
method1_c,
]
def test_adding_nonwrappers_trylast2(hook_caller, addmeth):
@addmeth()
def method1_middle():
pass
@addmeth()
def method1_b():
pass
@addmeth(trylast=True)
def method1():
pass
assert funcs(hook_caller._nonwrappers) == [
method1,
method1_middle,
method1_b,
]
def test_adding_nonwrappers_tryfirst(hook_caller, addmeth):
@addmeth(tryfirst=True)
def method1():
pass
@addmeth()
def method1_middle():
pass
@addmeth()
def method1_b():
pass
assert funcs(hook_caller._nonwrappers) == [
method1_middle,
method1_b,
method1,
]
def test_adding_wrappers_ordering(hook_caller, addmeth):
@addmeth(hookwrapper=True)
def method1():
pass
@addmeth()
def method1_middle():
pass
@addmeth(hookwrapper=True)
def method3():
pass
assert funcs(hook_caller._nonwrappers) == [method1_middle]
assert funcs(hook_caller._wrappers) == [method1, method3]
def test_adding_wrappers_ordering_tryfirst(hook_caller, addmeth):
@addmeth(hookwrapper=True, tryfirst=True)
def method1():
pass
@addmeth(hookwrapper=True)
def method2():
pass
assert hook_caller._nonwrappers == []
assert funcs(hook_caller._wrappers) == [method2, method1]
def test_hookspec(pm):
class HookSpecification:
@example_hookspec()
def he_myhook1(arg1):
pass
@example_hookspec(firstresult=True)
def he_myhook2(arg1):
pass
@example_hookspec(firstresult=False)
def he_myhook3(arg1):
pass
pm.add_hookspecs(HookSpecification)
assert not pm.hook.he_myhook1.spec.firstresult
assert pm.hook.he_myhook2.spec.firstresult
assert not pm.hook.he_myhook3.spec.firstresult
def test_hookspec_reserved_argnames(pm):
"""Certain argument names are reserved and cannot be used in specs."""
class HookSpecificationA:
@example_hookspec()
def he_myhook1(_plugin):
pass
class HookSpecificationB:
@example_hookspec()
def he_myhook1(_skip_impls):
pass
for cls in (HookSpecificationA, HookSpecificationB):
with pytest.raises(ValueError):
pm.add_hookspecs(cls)
@pytest.mark.parametrize(
"name", ["hookwrapper", "optionalhook", "tryfirst", "trylast"]
)
@pytest.mark.parametrize("val", [True, False])
def test_hookimpl(name, val):
@example_implementation(**{name: val})
def he_myhook1(arg1):
pass
if val:
assert he_myhook1.example_impl.get(name)
else:
assert not hasattr(he_myhook1, name)
def test_hookrelay_registry(pm):
"""Verify hook caller instances are registered by name onto the relay
and can be likewise unregistered."""
class Api:
@example_hookspec
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
hook = pm.hook
assert hasattr(hook, "hello")
assert repr(hook.hello).find("hello") != -1
class Plugin:
@example_implementation
def hello(self, arg):
return arg + 1
plugin = Plugin()
pm.register(plugin)
out = hook.hello(arg=3)
assert out == [4]
assert not hasattr(hook, "world")
pm.unregister(plugin)
assert hook.hello(arg=3) == []
def test_hookrelay_registration_by_specname(pm):
"""Verify hook caller instances may also be registered by specifying a
specname option to the hookimpl"""
class Api:
@example_hookspec
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
hook = pm.hook
assert hasattr(hook, "hello")
assert len(pm.hook.hello.get_hookimpls()) == 0
class Plugin:
@example_implementation(specname="hello")
def foo(self, arg):
return arg + 1
plugin = Plugin()
pm.register(plugin)
out = hook.hello(arg=3)
assert out == [4]
def test_hookrelay_registration_by_specname_raises(pm):
"""Verify using specname still raises the types of errors during registration as it
would have without using specname."""
class Api:
@example_hookspec
def hello(self, arg):
"api hook 1"
pm.add_hookspecs(Api)
# make sure a bad signature still raises an error when using specname
class Plugin:
@example_implementation(specname="hello")
def foo(self, arg, too, many, args):
return arg + 1
with pytest.raises(PluginValidationError):
pm.register(Plugin())
# make sure check_pending still fails if specname doesn't have a
# corresponding spec. EVEN if the function name matches one.
class Plugin2:
@example_implementation(specname="bar")
def hello(self, arg):
return arg + 1
pm.register(Plugin2())
with pytest.raises(PluginValidationError):
pm.check_pending()
def test_legacy_specimpl_opt():
impl = HookImplementation(lambda x: x)
assert impl.opts
spec = HookSpecification(type("Hook", (), {'x': lambda x: x}), 'x')
assert spec.opts
|