/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/registry.py

  • Committer: John Ferlito
  • Date: 2009-09-02 04:31:45 UTC
  • mto: (4665.7.1 serve-init)
  • mto: This revision was merged to the branch mainline in revision 4913.
  • Revision ID: johnf@inodes.org-20090902043145-gxdsfw03ilcwbyn5
Add a debian init script for bzr --serve

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/registry.py
1
 
# Copyright (C) 2006-2010 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
16
16
 
17
17
"""Classes to provide name-to-object registry-like support."""
18
18
 
19
 
from .pyutils import get_named_object
20
 
 
21
19
 
22
20
class _ObjectGetter(object):
23
21
    """Maintain a reference to an object, and return the object on request.
34
32
    def __init__(self, obj):
35
33
        self._obj = obj
36
34
 
37
 
    def get_module(self):
38
 
        """Get the module the object was loaded from."""
39
 
        return self._obj.__module__
40
 
 
41
35
    def get_obj(self):
42
36
        """Get the object that was saved at creation time"""
43
37
        return self._obj
57
51
        self._imported = False
58
52
        super(_LazyObjectGetter, self).__init__(None)
59
53
 
60
 
    def get_module(self):
61
 
        """Get the module the referenced object will be loaded from.
62
 
        """
63
 
        return self._module_name
64
 
 
65
54
    def get_obj(self):
66
55
        """Get the referenced object.
67
56
 
69
58
        return the imported object.
70
59
        """
71
60
        if not self._imported:
72
 
            self._obj = get_named_object(self._module_name, self._member_name)
73
 
            self._imported = True
 
61
            self._do_import()
74
62
        return super(_LazyObjectGetter, self).get_obj()
75
63
 
 
64
    def _do_import(self):
 
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)
 
74
        self._obj = obj
 
75
        self._imported = True
 
76
 
76
77
    def __repr__(self):
77
 
        return "<%s.%s object at %x, module=%r attribute=%r imported=%r>" % (
 
78
        return "<%s.%s object at %x, module=%r attribute=%r>" % (
78
79
            self.__class__.__module__, self.__class__.__name__, id(self),
79
 
            self._module_name, self._member_name, self._imported)
 
80
            self._module_name, self._member_name)
80
81
 
81
82
 
82
83
class Registry(object):
100
101
        self._default_key = None
101
102
        # Map from key => (is_lazy, info)
102
103
        self._dict = {}
103
 
        self._aliases = {}
104
104
        self._help_dict = {}
105
105
        self._info_dict = {}
106
106
 
107
 
    def aliases(self):
108
 
        """Return a set of the format names which are aliases."""
109
 
        return dict(self._aliases.items())
110
 
 
111
 
    def alias_map(self):
112
 
        ret = {}
113
 
        for alias, target in self._aliases.items():
114
 
            ret.setdefault(target, []).append(alias)
115
 
        return ret
116
 
 
117
107
    def register(self, key, obj, help=None, info=None,
118
108
                 override_existing=False):
119
109
        """Register a new object to a name.
142
132
                      override_existing=False):
143
133
        """Register a new object to be loaded on request.
144
134
 
145
 
        :param key: This is the key to use to request the object later.
146
135
        :param module_name: The python path to the module. Such as 'os.path'.
147
136
        :param member_name: The member of the module to return.  If empty or
148
137
                None, get() will return the module itself.
149
138
        :param help: Help text for this entry. This may be a string or
150
139
                a callable.
151
 
        :param info: More information for this entry. Registry.get_info()
152
 
                can be used to get this information. Registry treats this as an
153
 
                opaque storage location (it is defined by the caller).
 
140
        :param info: More information for this entry. Registry
154
141
        :param override_existing: If True, replace the existing object
155
142
                with the new one. If False, if there is already something
156
143
                registered with the same key, raise a KeyError
161
148
        self._dict[key] = _LazyObjectGetter(module_name, member_name)
162
149
        self._add_help_and_info(key, help=help, info=info)
163
150
 
164
 
    def register_alias(self, key, target, info=None):
165
 
        """Register an alias.
166
 
 
167
 
        :param key: Alias name
168
 
        :param target: Target key name
169
 
        """
170
 
        if key in self._dict and key not in self._aliases:
171
 
            raise KeyError('Key %r already registered and not an alias' % key)
172
 
        self._dict[key] = self._dict[target]
173
 
        self._aliases[key] = target
174
 
        if info is None:
175
 
            info = self._info_dict[target]
176
 
        self._add_help_and_info(key, help=self._help_dict[target], info=info)
177
 
 
178
151
    def _add_help_and_info(self, key, help=None, info=None):
179
152
        """Add the help and information about this key"""
180
153
        self._help_dict[key] = help
199
172
        """
200
173
        return self._dict[self._get_key_or_default(key)].get_obj()
201
174
 
202
 
    def _get_module(self, key):
203
 
        """Return the module the object will be or was loaded from.
204
 
 
205
 
        :param key: The key to obtain the module for.
206
 
        :return: The name of the module
207
 
        """
208
 
        return self._dict[key].get_module()
209
 
 
210
175
    def get_prefix(self, fullname):
211
176
        """Return an object whose key is a prefix of the supplied value.
212
177
 
250
215
 
251
216
    def keys(self):
252
217
        """Get a list of registered entries"""
253
 
        return sorted(self._dict)
 
218
        return sorted(self._dict.keys())
254
219
 
255
220
    def iteritems(self):
256
 
        for key in self._dict:
257
 
            yield key, self._dict[key].get_obj()
 
221
        for key, getter in self._dict.iteritems():
 
222
            yield key, getter.get_obj()
258
223
 
259
224
    def items(self):
260
 
        # We should not use the iteritems() implementation below (see bug
261
 
        # #430510)
262
 
        return [(key, self._dict[key].get_obj()) for key in self.keys()]
 
225
        return sorted(self.iteritems())
263
226
 
264
227
    def _set_default_key(self, key):
265
 
        if key not in self._dict:
 
228
        if not self._dict.has_key(key):
266
229
            raise KeyError('No object registered under key %s.' % key)
267
230
        else:
268
231
            self._default_key = key
271
234
        return self._default_key
272
235
 
273
236
    default_key = property(_get_default_key, _set_default_key,
274
 
                           doc="Current value of the default key."
275
 
                           " Can be set to any existing key.")
 
237
                            doc="Current value of the default key."
 
238
                                " Can be set to any existing key.")
276
239
 
277
240
 
278
241
class FormatRegistry(Registry):
282
245
        Registry.__init__(self)
283
246
        self._other_registry = other_registry
284
247
 
285
 
    def register(self, key, obj, help=None, info=None,
286
 
                 override_existing=False):
287
 
        Registry.register(self, key, obj, help=help, info=info,
288
 
                          override_existing=override_existing)
289
 
        if self._other_registry is not None:
290
 
            self._other_registry.register(key, obj, help=help,
291
 
                                          info=info, override_existing=override_existing)
292
 
 
293
248
    def register_lazy(self, key, module_name, member_name,
294
249
                      help=None, info=None,
295
250
                      override_existing=False):
296
251
        # Overridden to allow capturing registrations to two seperate
297
252
        # registries in a single call.
298
253
        Registry.register_lazy(self, key, module_name, member_name,
299
 
                               help=help, info=info, override_existing=override_existing)
 
254
                help=help, info=info, override_existing=override_existing)
300
255
        if self._other_registry is not None:
301
256
            self._other_registry.register_lazy(key, module_name, member_name,
302
 
                                               help=help, info=info, override_existing=override_existing)
303
 
 
304
 
    def remove(self, key):
305
 
        Registry.remove(self, key)
306
 
        if self._other_registry is not None:
307
 
            self._other_registry.remove(key)
 
257
                help=help, info=info, override_existing=override_existing)
308
258
 
309
259
    def get(self, format_string):
310
260
        r = Registry.get(self, format_string)
311
261
        if callable(r):
312
262
            r = r()
313
263
        return r
 
264
 
 
265