← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/registry.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/registry.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006, 2008 Canonical Ltd
2
2
#
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
12
12
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Classes to provide name-to-object registry-like support."""
18
18
 
62
62
        return super(_LazyObjectGetter, self).get_obj()
63
63
 
64
64
    def _do_import(self):
65
 
        obj = __import__(self._module_name, globals(), locals(),
66
 
                         [self._member_name])
67
 
        if self._member_name:
68
 
            obj = getattr(obj, self._member_name)
 
65
        if self._member_name:
 
66
            segments = self._member_name.split('.')
 
67
            names = segments[0:1]
 
68
        else:
 
69
            names = [self._member_name]
 
70
        obj = __import__(self._module_name, globals(), locals(), names)
 
71
        if self._member_name:
 
72
            for segment in segments:
 
73
                obj = getattr(obj, segment)
69
74
        self._obj = obj
70
75
        self._imported = True
71
76
 
 
77
    def __repr__(self):
 
78
        return "<%s.%s object at %x, module=%r attribute=%r>" % (
 
79
            self.__class__.__module__, self.__class__.__name__, id(self),
 
80
            self._module_name, self._member_name)
 
81
 
72
82
 
73
83
class Registry(object):
74
84
    """A class that registers objects to a name.
102
112
        :param obj: The object to register.
103
113
        :param help: Help text for this entry. This may be a string or
104
114
                a callable. If it is a callable, it should take two
105
 
                parameters (registry, key): this registry and the key that 
 
115
                parameters (registry, key): this registry and the key that
106
116
                the help was registered under.
107
117
        :param info: More information for this entry. Registry.get_info()
108
118
                can be used to get this information. Registry treats this as an
123
133
        """Register a new object to be loaded on request.
124
134
 
125
135
        :param module_name: The python path to the module. Such as 'os.path'.
126
 
        :param member_name: The member of the module to return.  If empty or 
 
136
        :param member_name: The member of the module to return.  If empty or
127
137
                None, get() will return the module itself.
128
138
        :param help: Help text for this entry. This may be a string or
129
139
                a callable.
130
 
        :param info: More information for this entry. Registry 
 
140
        :param info: More information for this entry. Registry
131
141
        :param override_existing: If True, replace the existing object
132
142
                with the new one. If False, if there is already something
133
143
                registered with the same key, raise a KeyError
147
157
        """Return the object register()'ed to the given key.
148
158
 
149
159
        May raise ImportError if the object was registered lazily and
150
 
        there are any problems, or AttributeError if the module does not 
 
160
        there are any problems, or AttributeError if the module does not
151
161
        have the supplied member.
152
162
 
153
163
        :param key: The key to obtain the object for. If no object has been
162
172
        """
163
173
        return self._dict[self._get_key_or_default(key)].get_obj()
164
174
 
 
175
    def get_prefix(self, fullname):
 
176
        """Return an object whose key is a prefix of the supplied value.
 
177
 
 
178
        :fullname: The name to find a prefix for
 
179
        :return: a tuple of (object, remainder), where the remainder is the
 
180
            portion of the name that did not match the key.
 
181
        """
 
182
        for key in self.keys():
 
183
            if fullname.startswith(key):
 
184
                return self.get(key), fullname[len(key):]
 
185
 
165
186
    def _get_key_or_default(self, key=None):
166
187
        """Return either 'key' or the default key if key is None"""
167
188
        if key is not None:
200
221
        for key, getter in self._dict.iteritems():
201
222
            yield key, getter.get_obj()
202
223
 
 
224
    def items(self):
 
225
        return sorted(self.iteritems())
 
226
 
203
227
    def _set_default_key(self, key):
204
228
        if not self._dict.has_key(key):
205
229
            raise KeyError('No object registered under key %s.' % key)
212
236
    default_key = property(_get_default_key, _set_default_key,
213
237
                            doc="Current value of the default key."
214
238
                                " Can be set to any existing key.")
 
239
 
 
240
 
 
241
class FormatRegistry(Registry):
 
242
    """Registry specialised for handling formats."""
 
243
 
 
244
    def __init__(self, other_registry=None):
 
245
        Registry.__init__(self)
 
246
        self._other_registry = other_registry
 
247
 
 
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)
 
258
 
 
259
    def get(self, format_string):
 
260
        r = Registry.get(self, format_string)
 
261
        if callable(r):
 
262
            r = r()
 
263
        return r
 
264
 
 
265