← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/registry.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-13 00:26:41 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101013002641-9tlh9k89mlj1666m
Keep docs-plain working.

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
17
17
"""Classes to provide name-to-object registry-like support."""
18
18
 
19
19
 
20
 
from bzrlib.pyutils import get_named_object
21
 
 
22
 
 
23
20
class _ObjectGetter(object):
24
21
    """Maintain a reference to an object, and return the object on request.
25
22
 
35
32
    def __init__(self, obj):
36
33
        self._obj = obj
37
34
 
38
 
    def get_module(self):
39
 
        """Get the module the object was loaded from."""
40
 
        return self._obj.__module__
41
 
 
42
35
    def get_obj(self):
43
36
        """Get the object that was saved at creation time"""
44
37
        return self._obj
58
51
        self._imported = False
59
52
        super(_LazyObjectGetter, self).__init__(None)
60
53
 
61
 
    def get_module(self):
62
 
        """Get the module the referenced object will be loaded from.
63
 
        """
64
 
        return self._module_name
65
 
 
66
54
    def get_obj(self):
67
55
        """Get the referenced object.
68
56
 
70
58
        return the imported object.
71
59
        """
72
60
        if not self._imported:
73
 
            self._obj = get_named_object(self._module_name, self._member_name)
74
 
            self._imported = True
 
61
            self._do_import()
75
62
        return super(_LazyObjectGetter, self).get_obj()
76
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
 
77
77
    def __repr__(self):
78
 
        return "<%s.%s object at %x, module=%r attribute=%r imported=%r>" % (
 
78
        return "<%s.%s object at %x, module=%r attribute=%r>" % (
79
79
            self.__class__.__module__, self.__class__.__name__, id(self),
80
 
            self._module_name, self._member_name, self._imported)
 
80
            self._module_name, self._member_name)
81
81
 
82
82
 
83
83
class Registry(object):
132
132
                      override_existing=False):
133
133
        """Register a new object to be loaded on request.
134
134
 
135
 
        :param key: This is the key to use to request the object later.
136
135
        :param module_name: The python path to the module. Such as 'os.path'.
137
136
        :param member_name: The member of the module to return.  If empty or
138
137
                None, get() will return the module itself.
139
138
        :param help: Help text for this entry. This may be a string or
140
139
                a callable.
141
 
        :param info: More information for this entry. Registry.get_info()
142
 
                can be used to get this information. Registry treats this as an
143
 
                opaque storage location (it is defined by the caller).
 
140
        :param info: More information for this entry. Registry
144
141
        :param override_existing: If True, replace the existing object
145
142
                with the new one. If False, if there is already something
146
143
                registered with the same key, raise a KeyError
175
172
        """
176
173
        return self._dict[self._get_key_or_default(key)].get_obj()
177
174
 
178
 
    def _get_module(self, key):
179
 
        """Return the module the object will be or was loaded from.
180
 
 
181
 
        :param key: The key to obtain the module for.
182
 
        :return: The name of the module
183
 
        """
184
 
        return self._dict[key].get_module()
185
 
 
186
175
    def get_prefix(self, fullname):
187
176
        """Return an object whose key is a prefix of the supplied value.
188
177
 
259
248
        Registry.__init__(self)
260
249
        self._other_registry = other_registry
261
250
 
262
 
    def register(self, key, obj, help=None, info=None,
263
 
                 override_existing=False):
264
 
        Registry.register(self, key, obj, help=help, info=info,
265
 
            override_existing=override_existing)
266
 
        if self._other_registry is not None:
267
 
            self._other_registry.register(key, obj, help=help,
268
 
                info=info, override_existing=override_existing)
269
 
 
270
251
    def register_lazy(self, key, module_name, member_name,
271
252
                      help=None, info=None,
272
253
                      override_existing=False):
278
259
            self._other_registry.register_lazy(key, module_name, member_name,
279
260
                help=help, info=info, override_existing=override_existing)
280
261
 
281
 
    def remove(self, key):
282
 
        Registry.remove(self, key)
283
 
        if self._other_registry is not None:
284
 
            self._other_registry.remove(key)
285
 
 
286
262
    def get(self, format_string):
287
263
        r = Registry.get(self, format_string)
288
264
        if callable(r):
289
265
            r = r()
290
266
        return r
 
267
 
 
268