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
|
#############
API Reference
#############
.. currentmodule:: napari_plugin_engine
.. autosummary::
:nosignatures:
PluginManager
HookCaller
HookResult
HookImplementation
HookSpecification
HookSpecificationMarker
HookImplementationMarker
PluginManager
=============
.. autoclass:: PluginManager
:members:
:private-members:
:exclude-members: _load_and_register
HookCaller
==========
.. autoclass:: HookCaller
:members:
:private-members:
:special-members:
:exclude-members:
__init__,
__repr__,
__weakref__,
_check_call_kwargs,
_maybe_apply_history,
HookResult
==========
.. autoclass:: HookResult
:members:
HookSpecification
=================
.. autoclass:: HookSpecification
:members:
HookImplementation
==================
.. autoclass:: HookImplementation
:members:
Decorators & Markers
====================
HookSpecificationMarker
-----------------------
.. autoclass:: HookSpecificationMarker
:members:
:special-members:
:exclude-members: __init__, __weakref__
HookImplementationMarker
------------------------
.. autoclass:: HookImplementationMarker
:members:
:special-members:
:exclude-members: __init__, __weakref__
Exceptions
==========
.. autosummary::
:nosignatures:
PluginError
PluginImportError
PluginRegistrationError
PluginImplementationError
PluginValidationError
PluginCallError
HookCallError
PluginError
-----------
.. autoclass:: PluginError
:members:
:show-inheritance:
PluginImportError
-----------------
.. autoclass:: PluginImportError
:members:
:show-inheritance:
PluginRegistrationError
------------------------
.. autoclass:: PluginRegistrationError
:members:
:show-inheritance:
PluginImplementationError
-------------------------
.. autoclass:: PluginImplementationError
:members:
:show-inheritance:
PluginValidationError
---------------------
.. autoclass:: PluginValidationError
:members:
:show-inheritance:
PluginCallError
---------------
.. autoclass:: PluginCallError
:members:
:show-inheritance:
HookCallError
-------------
.. autoclass:: HookCallError
:members:
:show-inheritance:
Extra Functions
===============
.. autofunction:: napari_plugin_engine.hooks._multicall
.. autofunction:: napari_plugin_engine.manager.ensure_namespace
.. autofunction:: napari_plugin_engine.manager.temp_path_additions
.. autofunction:: napari_plugin_engine.dist.get_dist
Types
=====
.. autodata:: napari_plugin_engine.hooks.HookExecFunc
|
