1
|
|
|
""" |
2
|
|
|
The pluginmanager module cares about the management of plugin status and their changes between status. |
3
|
|
|
|
4
|
|
|
There are two manager classes for managing plugin related objects. |
5
|
|
|
|
6
|
|
|
* PluginManager: Cares about initialised Plugins, which can be activated and deactivated. |
7
|
|
|
* PluginClassManager: Cares about plugin classes, which are used to create plugins. |
8
|
|
|
|
9
|
|
|
A plugin class can be reused for several plugins. The only thing to care about is the naming of a plugin. |
10
|
|
|
This plugin name must be unique inside a groundwork app and can be set during plugin initialisation/activation. |
11
|
|
|
""" |
12
|
|
|
|
13
|
|
|
from pkg_resources import iter_entry_points |
14
|
|
|
import logging |
15
|
|
|
import inspect |
16
|
|
|
|
17
|
|
|
from groundwork.patterns.gw_base_pattern import GwBasePattern |
18
|
|
|
from groundwork.exceptions import PluginNotActivatableException, PluginNotInitialisableException, \ |
19
|
|
|
PluginRegistrationException, PluginNotDeactivatableException |
20
|
|
|
|
21
|
|
|
|
22
|
|
|
class PluginManager: |
23
|
|
|
""" |
24
|
|
|
PluginManager for searching, initialising, activating and deactivating groundwork plugins. |
25
|
|
|
""" |
26
|
|
|
|
27
|
|
|
def __init__(self, app, strict=False): |
28
|
|
|
""" |
29
|
|
|
Initialises the plugin manager. |
30
|
|
|
|
31
|
|
|
Additional plugins can be registered by adding their class via the plugins argument. |
32
|
|
|
|
33
|
|
|
:param app: groundwork application object |
34
|
|
|
:param strict: If True, problems during plugin registration/initialisation or activation will throw an exception |
35
|
|
|
""" |
36
|
|
|
self._log = logging.getLogger(__name__) |
37
|
|
|
self._strict = strict |
38
|
|
|
self._app = app |
39
|
|
|
self._plugins = {} |
40
|
|
|
|
41
|
|
|
#: Instance of :class:`~groundwork.pluginmanager.PluginClassManager`. |
42
|
|
|
#: Handles the registration of plugin classes, which can be used to create new plugins during runtime. |
43
|
|
|
self.classes = PluginClassManager(self._app, self._strict) |
44
|
|
|
|
45
|
|
|
def initialise_by_names(self, plugins=None): |
46
|
|
|
""" |
47
|
|
|
Initialises given plugins, but does not activate them. |
48
|
|
|
|
49
|
|
|
This is needed to import and configure libraries, which are imported by used patterns, like GwFlask. |
50
|
|
|
|
51
|
|
|
After this action, all needed python modules are imported and configured. |
52
|
|
|
Also the groundwork application object is ready and contains functions and objects, which were added |
53
|
|
|
by patterns, like app.commands from GwCommandsPattern. |
54
|
|
|
|
55
|
|
|
The class of a given plugin must already be registered in the :class:`.PluginClassManager`. |
56
|
|
|
|
57
|
|
|
:param plugins: List of plugin names |
58
|
|
|
:type plugins: list of strings |
59
|
|
|
""" |
60
|
|
|
|
61
|
|
|
if plugins is None: |
62
|
|
|
plugins = [] |
63
|
|
|
|
64
|
|
|
self._log.debug("Plugins Initialisation started") |
65
|
|
|
if not isinstance(plugins, list): |
66
|
|
|
raise AttributeError("plugins must be a list, not %s" % type(plugins)) |
67
|
|
|
|
68
|
|
|
self._log.debug("Plugins to initialise: %s" % ", ".join(plugins)) |
69
|
|
|
plugin_initialised = [] |
70
|
|
|
for plugin_name in plugins: |
71
|
|
|
if not isinstance(plugin_name, str): |
72
|
|
|
raise AttributeError("plugin name must be a str, not %s" % type(plugin_name)) |
73
|
|
|
|
74
|
|
|
plugin_class = self.classes.get(plugin_name) |
75
|
|
|
self.initialise(plugin_class.clazz, plugin_name) |
76
|
|
|
|
77
|
|
|
self._log.info("Plugins initialised: %s" % ", ".join(plugin_initialised)) |
78
|
|
|
|
79
|
|
|
def initialise(self, clazz, name=None): |
80
|
|
|
if clazz is not None and issubclass(clazz, GwBasePattern): |
81
|
|
|
if name is None: |
82
|
|
|
name = clazz.__name__ |
83
|
|
|
try: |
84
|
|
|
# Plugin Initialisation |
85
|
|
|
plugin_instance = clazz(app=self._app, name=name) |
86
|
|
|
# Let's be sure the correct name was set. Even if the init_routine of |
87
|
|
|
# the plugin does not support the name parameter. |
88
|
|
|
if plugin_instance.name != name: |
89
|
|
|
plugin_instance.name = name |
90
|
|
|
except Exception as e: |
91
|
|
|
self._log.warning("Plugin class %s could not be initialised" % clazz.__name__) |
92
|
|
|
if self._strict: |
93
|
|
|
raise PluginNotInitialisableException("Plugin class %s could not be initialised" % clazz.__name__) \ |
94
|
|
|
from e |
95
|
|
|
|
96
|
|
|
# Let's be sure, that GwBasePattern got called |
97
|
|
|
if not hasattr(plugin_instance, "_plugin_base_initialised") \ |
98
|
|
|
or plugin_instance._plugin_base_initialised is not True: |
99
|
|
|
self._log.error("GwBasePattern.__init__() was not called during initialisation. " |
100
|
|
|
"Please add 'super(*args, **kwargs).__init__()' to the top of all involved " |
101
|
|
|
"plugin/pattern init routines." |
102
|
|
|
"Activate logging debug-output to see all involved classes.") |
103
|
|
|
for mro_class in clazz.__mro__: |
104
|
|
|
self._log.debug(mro_class) |
105
|
|
|
raise Exception("GwBasePattern.__init()__ was not called during initialisation.") |
106
|
|
|
self._register_initialisation(plugin_instance) |
107
|
|
|
self._log.debug("Plugin %s initialised" % name) |
108
|
|
|
return plugin_instance |
109
|
|
|
|
110
|
|
|
if clazz is None: |
111
|
|
|
self._log.warn("Plugin class %s not found" % clazz.__name__) |
112
|
|
|
return None |
113
|
|
|
|
114
|
|
|
if not issubclass(clazz, GwBasePattern): |
115
|
|
|
self._log.warn("Can not load %s. Plugin is not based on groundwork.Plugin." % clazz.__name__) |
116
|
|
|
if self._strict: |
117
|
|
|
raise Exception("Can not load %s. Plugin is not based on groundwork.Plugin." % clazz.__name__) |
118
|
|
|
return None |
119
|
|
|
|
120
|
|
|
def _register_initialisation(self, plugin_instance): |
121
|
|
|
""" |
122
|
|
|
Internal functions to perform registration actions after plugin load was successful. |
123
|
|
|
""" |
124
|
|
|
self._plugins[plugin_instance.name] = plugin_instance |
125
|
|
|
|
126
|
|
|
def activate(self, plugins=[]): |
127
|
|
|
""" |
128
|
|
|
Activates given plugins. |
129
|
|
|
|
130
|
|
|
This calls mainly plugin.activate() and plugins register needed resources like commands, signals or |
131
|
|
|
documents. |
132
|
|
|
|
133
|
|
|
If given plugins have not been initialised, this is also done via :func:`_load`. |
134
|
|
|
|
135
|
|
|
:param plugins: List of plugin names |
136
|
|
|
:type plugins: list of strings |
137
|
|
|
""" |
138
|
|
|
self._log.debug("Plugins Activation started") |
139
|
|
|
|
140
|
|
|
if not isinstance(plugins, list): |
141
|
|
|
raise AttributeError("plugins must be a list, not %s" % type(plugins)) |
142
|
|
|
|
143
|
|
|
self._log.debug("Plugins to activate: %s" % ", ".join(plugins)) |
144
|
|
|
|
145
|
|
|
plugins_activated = [] |
146
|
|
|
for plugin_name in plugins: |
147
|
|
|
if not isinstance(plugin_name, str): |
148
|
|
View Code Duplication |
raise AttributeError("plugin name must be a str, not %s" % type(plugin_name)) |
|
|
|
|
149
|
|
|
|
150
|
|
|
if plugin_name not in self._plugins.keys() and plugin_name in self.classes._classes.keys(): |
151
|
|
|
self._log.debug("Initialisation needed before activation.") |
152
|
|
|
try: |
153
|
|
|
self.initialise_by_names([plugin_name]) |
154
|
|
|
except Exception as e: |
155
|
|
|
self._log.error("Couldn't initialise plugin %s" % plugin_name) |
156
|
|
|
if self._strict: |
157
|
|
|
raise Exception("Couldn't initialise plugin %s" % plugin_name) from e |
158
|
|
|
else: |
159
|
|
|
continue |
160
|
|
|
if plugin_name in self._plugins.keys(): |
161
|
|
|
self._log.debug("Activating plugin %s" % plugin_name) |
162
|
|
|
if not self._plugins[plugin_name].active: |
163
|
|
|
try: |
164
|
|
|
self._plugins[plugin_name].activate() |
165
|
|
|
except Exception as e: |
166
|
|
|
raise PluginNotActivatableException("Plugin %s could not be activated" % plugin_name) from e |
167
|
|
|
else: |
168
|
|
|
self._log.debug("Plugin %s activated" % plugin_name) |
169
|
|
|
plugins_activated.append(plugin_name) |
170
|
|
|
else: |
171
|
|
|
self._log.warning("Plugin %s got already activated." % plugin_name) |
172
|
|
|
if self._strict: |
173
|
|
|
raise PluginNotInitialisableException() |
174
|
|
|
|
175
|
|
|
self._log.info("Plugins activated: %s" % ", ".join(plugins_activated)) |
176
|
|
|
|
177
|
|
|
def deactivate(self, plugins=[]): |
178
|
|
|
""" |
179
|
|
|
Deactivates given plugins. |
180
|
|
|
|
181
|
|
|
A given plugin must be activated, otherwise it is ignored and no action takes place (no signals are fired, |
182
|
|
|
no deactivate functions are called.) |
183
|
|
|
|
184
|
|
|
A deactivated plugin is still loaded and initialised and can be reactivated by calling :func:`activate` again. |
185
|
|
|
It is also still registered in the :class:`.PluginManager` and can be requested via :func:`get`. |
186
|
|
|
|
187
|
|
|
:param plugins: List of plugin names |
188
|
|
|
:type plugins: list of strings |
189
|
|
|
""" |
190
|
|
View Code Duplication |
self._log.debug("Plugins Deactivation started") |
|
|
|
|
191
|
|
|
|
192
|
|
|
if not isinstance(plugins, list): |
193
|
|
|
raise AttributeError("plugins must be a list, not %s" % type(plugins)) |
194
|
|
|
|
195
|
|
|
self._log.debug("Plugins to deactivate: %s" % ", ".join(plugins)) |
196
|
|
|
|
197
|
|
|
plugins_deactivated = [] |
198
|
|
|
for plugin_name in plugins: |
199
|
|
|
if not isinstance(plugin_name, str): |
200
|
|
|
raise AttributeError("plugin name must be a str, not %s" % type(plugin_name)) |
201
|
|
|
|
202
|
|
|
if plugin_name not in self._plugins.keys(): |
203
|
|
|
self._log.info("Unknown activated plugin %s" % plugin_name) |
204
|
|
|
continue |
205
|
|
|
else: |
206
|
|
|
self._log.debug("Deactivating plugin %s" % plugin_name) |
207
|
|
|
if not self._plugins[plugin_name].active: |
208
|
|
|
self._log.warning("Plugin %s seems to be already deactivated" % plugin_name) |
209
|
|
|
else: |
210
|
|
|
try: |
211
|
|
|
self._plugins[plugin_name].deactivate() |
212
|
|
|
except Exception as e: |
213
|
|
|
raise PluginNotDeactivatableException("Plugin %s could not be deactivated" % plugin_name) from e |
214
|
|
|
else: |
215
|
|
|
self._log.debug("Plugin %s deactivated" % plugin_name) |
216
|
|
|
plugins_deactivated.append(plugin_name) |
217
|
|
|
|
218
|
|
|
self._log.info("Plugins deactivated: %s" % ", ".join(plugins_deactivated)) |
219
|
|
|
|
220
|
|
|
def get(self, name=None): |
221
|
|
|
""" |
222
|
|
|
Returns the plugin object with the given name. |
223
|
|
|
Or if a name is not given, the complete plugin dictionary is returned. |
224
|
|
|
|
225
|
|
|
:param name: Name of a plugin |
226
|
|
|
:return: None, single plugin or dictionary of plugins |
227
|
|
|
""" |
228
|
|
|
if name is None: |
229
|
|
|
return self._plugins |
230
|
|
|
else: |
231
|
|
|
if name not in self._plugins.keys(): |
232
|
|
|
return None |
233
|
|
|
else: |
234
|
|
|
return self._plugins[name] |
235
|
|
|
|
236
|
|
|
def exist(self, name): |
237
|
|
|
""" |
238
|
|
|
Returns True if plugin exists. |
239
|
|
|
:param name: plugin name |
240
|
|
|
:return: boolean |
241
|
|
|
""" |
242
|
|
|
if name in self._plugins.keys(): |
243
|
|
|
return True |
244
|
|
|
return False |
245
|
|
|
|
246
|
|
|
def is_active(self, name): |
247
|
|
|
""" |
248
|
|
|
Returns True if plugin exists and is active. |
249
|
|
|
If plugin does not exist, it returns None |
250
|
|
|
|
251
|
|
|
:param name: plugin name |
252
|
|
|
:return: boolean or None |
253
|
|
|
""" |
254
|
|
|
if name in self._plugins.keys(): |
255
|
|
|
return self._plugins["name"].active |
256
|
|
|
return None |
257
|
|
|
|
258
|
|
|
|
259
|
|
|
class PluginClassManager: |
260
|
|
|
""" |
261
|
|
|
Manages the plugin classes, which can be used to initialise and activate new plugins. |
262
|
|
|
|
263
|
|
|
Loads all plugin classes from entry_point "groundwork.plugin" automatically during own initialisation. |
264
|
|
|
Provides functions to register new plugin classes during runtime. |
265
|
|
|
""" |
266
|
|
|
|
267
|
|
|
def __init__(self, app, strict=False): |
268
|
|
|
self._log = logging.getLogger(__name__) |
269
|
|
|
self._app = app |
270
|
|
|
self._strict = strict |
271
|
|
|
self._classes = {} |
272
|
|
|
self._get_plugins_by_entry_points() |
273
|
|
|
|
274
|
|
|
def _get_plugins_by_entry_points(self): |
275
|
|
|
""" |
276
|
|
|
Registers plugin classes, which are in sys.path and have an entry_point called 'groundwork.plugin'. |
277
|
|
|
:return: dict of plugin classes |
278
|
|
|
""" |
279
|
|
|
# Let's find and register every plugin, which is in sys.path and has defined a entry_point 'groundwork.plugin' |
280
|
|
|
# in it's setup.py |
281
|
|
|
entry_points = [] |
282
|
|
|
classes = {} |
283
|
|
|
for entry_point in iter_entry_points(group='groundwork.plugin', name=None): |
284
|
|
|
entry_points.append(entry_point) |
285
|
|
|
|
286
|
|
|
for entry_point in entry_points: |
287
|
|
|
try: |
288
|
|
|
entry_point_object = entry_point.load() |
289
|
|
|
except Exception as e: |
290
|
|
|
# We should not throw an exception now, because a package/entry_point can be outdated, using an old |
291
|
|
|
# api from groundwork, tries to import unavailable packages, what ever... |
292
|
|
|
# We just do not make it available. That's all we can do. |
293
|
|
|
self._log.warning("Couldn't load entry_point %s. Reason: %s" % (entry_point.name, e)) |
294
|
|
|
continue |
295
|
|
|
|
296
|
|
|
if not issubclass(entry_point_object, GwBasePattern): |
297
|
|
|
self._log.warning("entry_point %s is not a subclass of groundworkPlugin" % entry_point.name) |
298
|
|
|
continue |
299
|
|
|
plugin_name = entry_point_object.__name__ |
300
|
|
|
|
301
|
|
|
plugin_class = self.register_class(entry_point_object, plugin_name, |
302
|
|
|
entrypoint_name=entry_point.name, |
303
|
|
|
distribution_path=entry_point.dist.location, |
304
|
|
|
distribution_key=entry_point.dist.key, |
305
|
|
|
distribution_version=entry_point.dist.version) |
306
|
|
|
|
307
|
|
|
classes[plugin_name] = plugin_class |
308
|
|
|
# classes[plugin_name] = { |
309
|
|
|
# "name": plugin_name, |
310
|
|
|
# "entry_point": entry_point.name, |
311
|
|
|
# "path": entry_point.dist.location, |
312
|
|
|
# "class": entry_point_object, |
313
|
|
|
# "distribution": { |
314
|
|
|
# "key": entry_point.dist.key, |
315
|
|
|
# "version": entry_point.dist.version |
316
|
|
|
# }, |
317
|
|
|
# } |
318
|
|
|
self._log.debug("Found plugin: %s at entry_point %s of package %s (%s)" % (plugin_name, entry_point.name, |
319
|
|
|
entry_point.dist.key, |
320
|
|
|
entry_point.dist.version)) |
321
|
|
|
return classes |
322
|
|
|
|
323
|
|
|
def register(self, classes=[]): |
324
|
|
|
""" |
325
|
|
|
Registers new plugins. |
326
|
|
|
|
327
|
|
|
The registration only creates a new entry for a plugin inside the _classes dictionary. |
328
|
|
|
It does not activate or even initialise the plugin. |
329
|
|
|
|
330
|
|
|
A plugin must be a class, which inherits directly or indirectly from GwBasePattern. |
331
|
|
|
|
332
|
|
|
:param classes: List of plugin classes |
333
|
|
|
:type classes: list |
334
|
|
|
""" |
335
|
|
|
if not isinstance(classes, list): |
336
|
|
|
raise AttributeError("plugins must be a list, not %s." % type(classes)) |
337
|
|
|
|
338
|
|
|
plugin_registered = [] |
339
|
|
|
|
340
|
|
|
for plugin_class in classes: |
341
|
|
|
plugin_name = plugin_class.__name__ |
342
|
|
|
self.register_class(plugin_class, plugin_name) |
343
|
|
|
self._log.debug("Plugin %s registered" % plugin_name) |
344
|
|
|
plugin_registered.append(plugin_name) |
345
|
|
|
|
346
|
|
|
self._log.info("Plugins registered: %s" % ", ".join(plugin_registered)) |
347
|
|
|
|
348
|
|
|
def register_class(self, clazz, name=None, entrypoint_name=None, distribution_path=None, |
349
|
|
|
distribution_key=None, distribution_version=None): |
350
|
|
|
|
351
|
|
|
if name is None: |
352
|
|
|
name = clazz.__name__ |
353
|
|
|
|
354
|
|
|
if not inspect.isclass(clazz) or not issubclass(clazz, GwBasePattern): |
355
|
|
|
self._log.error("Given plugin is not a subclass of groundworkPlugin.") |
356
|
|
|
if self._strict: |
357
|
|
|
raise AttributeError("Given plugin is not a subclass of groundworkPlugin.") |
358
|
|
|
|
359
|
|
|
if isinstance(clazz, GwBasePattern): |
360
|
|
|
self._log.error("Given plugin %s is already initialised. Please provide a class not an instance.") |
361
|
|
|
if self._strict: |
362
|
|
|
raise Exception("Given plugin %s is already initialised. Please provide a class not an instance.") |
363
|
|
|
|
364
|
|
|
if name in self._classes.keys(): |
365
|
|
|
self._log.warning("Plugin %s already registered" % name) |
366
|
|
|
if self._strict: |
367
|
|
|
raise PluginRegistrationException("Plugin %s already registered" % name) |
368
|
|
|
|
369
|
|
|
self._classes[name] = PluginClass(name, clazz, entrypoint_name, distribution_path, |
370
|
|
|
distribution_key, distribution_version) |
371
|
|
|
|
372
|
|
|
return self._classes[name] |
373
|
|
|
|
374
|
|
|
# self._classes[name] = { |
375
|
|
|
# "name": plugin_name, |
376
|
|
|
# "entry_point": None, |
377
|
|
|
# "path": None, |
378
|
|
|
# "class": plugin, |
379
|
|
|
# "distribution": None, |
380
|
|
|
# } |
381
|
|
|
|
382
|
|
|
def get(self, name=None): |
383
|
|
|
""" |
384
|
|
|
Returns the plugin class object with the given name. |
385
|
|
|
Or if a name is not given, the complete plugin dictionary is returned. |
386
|
|
|
|
387
|
|
|
:param name: Name of a plugin |
388
|
|
|
:return: None, single plugin or dictionary of plugins |
389
|
|
|
""" |
390
|
|
|
if name is None: |
391
|
|
|
return self._classes |
392
|
|
|
else: |
393
|
|
|
if name not in self._classes.keys(): |
394
|
|
|
return None |
395
|
|
|
else: |
396
|
|
|
return self._classes[name] |
397
|
|
|
|
398
|
|
|
def exist(self, name): |
399
|
|
|
""" |
400
|
|
|
Returns True if plugin class exists. |
401
|
|
|
:param name: plugin name |
402
|
|
|
:return: boolean |
403
|
|
|
""" |
404
|
|
|
if name in self._classes.keys(): |
405
|
|
|
return True |
406
|
|
|
return False |
407
|
|
|
|
408
|
|
|
|
409
|
|
|
class PluginClass: |
410
|
|
|
def __init__(self, name, clazz, entrypoint_name, distribution_path, distribution_key, distribution_version): |
411
|
|
|
self.name = name |
412
|
|
|
self.entrypoint_name = entrypoint_name |
413
|
|
|
self.clazz = clazz |
414
|
|
|
self.distribution = { |
415
|
|
|
"path": distribution_path, |
416
|
|
|
"key": distribution_key, |
417
|
|
|
"version": distribution_version |
418
|
|
|
} |
419
|
|
|
|