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
|
""" A plugin manager that gets its plugins from Eggs. """
# Standard library imports.
import logging, pkg_resources, re
# Enthought library imports.
from enthought.traits.api import Instance, List, Str
# Local imports.
from egg_utils import get_entry_points_in_egg_order
from plugin_manager import PluginManager
# Logging.
logger = logging.getLogger(__name__)
class EggPluginManager(PluginManager):
""" A plugin manager that gets its plugins from Eggs.
To declare a plugin (or plugins) in your egg use an entry point in your
'setup.py' file, e.g.
[enthought.envisage.plugins]
acme.foo = acme.foo.foo_plugin:FooPlugin
The left hand side of the entry point declaration must be the same as the
'id' trait of the plugin (e.g. the 'FooPlugin' would have its 'id' trait
set to 'acme.foo'). This allows the plugin manager to filter out plugins
using the 'include' and 'exclude' lists (if specified) *without* having to
import and instantiate them.
"""
# Entry point Id.
PLUGINS = 'enthought.envisage.plugins'
#### 'EggPluginManager' interface #########################################
# The working set that contains the eggs that contain the plugins that
# live in the house that Jack built ;^) By default we use the global
# working set.
working_set = Instance(pkg_resources.WorkingSet, pkg_resources.working_set)
# An optional list of the Ids of the plugins that are to be excluded by
# the manager.
#
# Each item in the list is actually a regular expression as used by the
# 're' module.
exclude = List(Str)
# An optional list of the Ids of the plugins that are to be included by
# the manager (i.e. *only* plugins with Ids in this list will be added to
# the manager).
#
# Each item in the list is actually a regular expression as used by the
# 're' module.
include = List(Str)
###########################################################################
# Protected 'PluginManager' interface.
###########################################################################
def __plugins_default(self):
""" Trait initializer. """
plugins = []
for ep in get_entry_points_in_egg_order(self.working_set,self.PLUGINS):
if self._is_included(ep.name) and not self._is_excluded(ep.name):
plugin = self._create_plugin_from_ep(ep)
plugins.append(plugin)
logger.debug('egg plugin manager found plugins <%s>', plugins)
return plugins
###########################################################################
# Private interface.
###########################################################################
def _create_plugin_from_ep(self, ep):
""" Create a plugin from an extension point. """
klass = ep.load()
plugin = klass(application=self.application)
# Warn if the entry point is an old-style one where the LHS didn't have
# to be the same as the plugin Id.
if ep.name != plugin.id:
logger.warn(
'entry point name <%s> should be the same as the '
'plugin id <%s>' % (ep.name, plugin.id)
)
return plugin
def _is_excluded(self, plugin_id):
""" Return True if the plugin Id is excluded.
If no 'exclude' patterns are specified then this method returns False
for all plugin Ids.
"""
if len(self.exclude) == 0:
return False
for pattern in self.exclude:
if re.match(pattern, plugin_id) is not None:
return True
return False
def _is_included(self, plugin_id):
""" Return True if the plugin Id is included.
If no 'include' patterns are specified then this method returns True
for all plugin Ids.
"""
if len(self.include) == 0:
return True
for pattern in self.include:
if re.match(pattern, plugin_id) is not None:
return True
return False
#### EOF ######################################################################
|
