/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 breezy/registry.py

  • Committer: Jelmer Vernooij
  • Date: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

Show diffs side-by-side

added added

removed removed

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