1
# Copyright (C) 2006, 2008 Canonical Ltd
1
# Copyright (C) 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Classes to provide name-to-object registry-like support."""
62
62
return super(_LazyObjectGetter, self).get_obj()
64
64
def _do_import(self):
66
segments = self._member_name.split('.')
69
names = [self._member_name]
70
obj = __import__(self._module_name, globals(), locals(), names)
72
for segment in segments:
73
obj = getattr(obj, segment)
65
obj = __import__(self._module_name, globals(), locals(),
68
obj = getattr(obj, self._member_name)
75
70
self._imported = True
112
107
:param obj: The object to register.
113
108
:param help: Help text for this entry. This may be a string or
114
109
a callable. If it is a callable, it should take two
115
parameters (registry, key): this registry and the key that
110
parameters (registry, key): this registry and the key that
116
111
the help was registered under.
117
112
:param info: More information for this entry. Registry.get_info()
118
113
can be used to get this information. Registry treats this as an
133
128
"""Register a new object to be loaded on request.
135
130
:param module_name: The python path to the module. Such as 'os.path'.
136
:param member_name: The member of the module to return. If empty or
131
:param member_name: The member of the module to return. If empty or
137
132
None, get() will return the module itself.
138
133
:param help: Help text for this entry. This may be a string or
140
:param info: More information for this entry. Registry
135
:param info: More information for this entry. Registry
141
136
:param override_existing: If True, replace the existing object
142
137
with the new one. If False, if there is already something
143
138
registered with the same key, raise a KeyError
157
152
"""Return the object register()'ed to the given key.
159
154
May raise ImportError if the object was registered lazily and
160
there are any problems, or AttributeError if the module does not
155
there are any problems, or AttributeError if the module does not
161
156
have the supplied member.
163
158
:param key: The key to obtain the object for. If no object has been
179
174
:return: a tuple of (object, remainder), where the remainder is the
180
175
portion of the name that did not match the key.
182
for key in self.keys():
177
for key, value in self.iteritems():
183
178
if fullname.startswith(key):
184
return self.get(key), fullname[len(key):]
179
return value, fullname[len(key):]
186
181
def _get_key_or_default(self, key=None):
187
182
"""Return either 'key' or the default key if key is None"""
221
216
for key, getter in self._dict.iteritems():
222
217
yield key, getter.get_obj()
225
return sorted(self.iteritems())
227
219
def _set_default_key(self, key):
228
220
if not self._dict.has_key(key):
229
221
raise KeyError('No object registered under key %s.' % key)
236
228
default_key = property(_get_default_key, _set_default_key,
237
229
doc="Current value of the default key."
238
230
" Can be set to any existing key.")
241
class FormatRegistry(Registry):
242
"""Registry specialised for handling formats."""
244
def __init__(self, other_registry=None):
245
Registry.__init__(self)
246
self._other_registry = other_registry
248
def register_lazy(self, key, module_name, member_name,
249
help=None, info=None,
250
override_existing=False):
251
# Overridden to allow capturing registrations to two seperate
252
# registries in a single call.
253
Registry.register_lazy(self, key, module_name, member_name,
254
help=help, info=info, override_existing=override_existing)
255
if self._other_registry is not None:
256
self._other_registry.register_lazy(key, module_name, member_name,
257
help=help, info=info, override_existing=override_existing)
259
def get(self, format_string):
260
r = Registry.get(self, format_string)