← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lazy_import.py

  • Committer: John Whitley
  • Date: 2010-01-11 16:44:02 UTC
  • mto: This revision was merged to the branch mainline in revision 4981.
  • Revision ID: whitley@bangpath.org-20100111164402-9luag9p9ahpy4kmz
Terminology change: exclusion => exception.
Tweaked presentation of new logic in ExceptionGlobster

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lazy_import.py
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
"""Functionality to create lazy evaluation objects.
18
18
 
48
48
    needed.
49
49
    """
50
50
 
51
 
    __slots__ = ('_scope', '_factory', '_name')
 
51
    __slots__ = ('_scope', '_factory', '_name', '_real_obj')
 
52
 
 
53
    # Setting this to True will allow you to do x = y, and still access members
 
54
    # from both variables. This should not normally be enabled, but is useful
 
55
    # when building documentation.
 
56
    _should_proxy = False
52
57
 
53
58
    def __init__(self, scope, factory, name):
54
59
        """Create a temporary object in the specified scope.
59
64
            It will be passed (self, scope, name)
60
65
        :param name: The variable name in the given scope.
61
66
        """
62
 
        self._scope = scope
63
 
        self._factory = factory
64
 
        self._name = name
 
67
        object.__setattr__(self, '_scope', scope)
 
68
        object.__setattr__(self, '_factory', factory)
 
69
        object.__setattr__(self, '_name', name)
 
70
        object.__setattr__(self, '_real_obj', None)
65
71
        scope[name] = self
66
72
 
67
73
    def _replace(self):
81
87
                          " to another variable?",
82
88
                extra=e)
83
89
        obj = factory(self, scope, name)
 
90
        if ScopeReplacer._should_proxy:
 
91
            object.__setattr__(self, '_real_obj', obj)
84
92
        scope[name] = obj
85
93
        return obj
86
94
 
92
100
        # del self._name
93
101
 
94
102
    def __getattribute__(self, attr):
95
 
        _replace = object.__getattribute__(self, '_replace')
96
 
        obj = _replace()
97
 
        _cleanup = object.__getattribute__(self, '_cleanup')
98
 
        _cleanup()
 
103
        obj = object.__getattribute__(self, '_real_obj')
 
104
        if obj is None:
 
105
            _replace = object.__getattribute__(self, '_replace')
 
106
            obj = _replace()
 
107
            _cleanup = object.__getattribute__(self, '_cleanup')
 
108
            _cleanup()
99
109
        return getattr(obj, attr)
100
110
 
 
111
    def __setattr__(self, attr, value):
 
112
        obj = object.__getattribute__(self, '_real_obj')
 
113
        if obj is None:
 
114
            _replace = object.__getattribute__(self, '_replace')
 
115
            obj = _replace()
 
116
            _cleanup = object.__getattribute__(self, '_cleanup')
 
117
            _cleanup()
 
118
        return setattr(obj, attr, value)
 
119
 
101
120
    def __call__(self, *args, **kwargs):
102
121
        _replace = object.__getattribute__(self, '_replace')
103
122
        obj = _replace()
130
149
 
131
150
        :param scope: The scope that objects should be imported into.
132
151
            Typically this is globals()
133
 
        :param name: The variable name. Often this is the same as the 
 
152
        :param name: The variable name. Often this is the same as the
134
153
            module_path. 'bzrlib'
135
154
        :param module_path: A list for the fully specified module path
136
155
            ['bzrlib', 'foo', 'bar']
138
157
            None, indicating the module is being imported.
139
158
        :param children: Children entries to be imported later.
140
159
            This should be a map of children specifications.
141
 
            {'foo':(['bzrlib', 'foo'], None, 
 
160
            {'foo':(['bzrlib', 'foo'], None,
142
161
                {'bar':(['bzrlib', 'foo', 'bar'], None {})})
143
162
            }
144
163
        Examples:
151
170
            from foo import bar, baz would get translated into 2 import
152
171
            requests. On for 'name=bar' and one for 'name=baz'
153
172
        """
154
 
        if member is not None:
155
 
            assert not children, \
156
 
                'Cannot supply both a member and children'
 
173
        if (member is not None) and children:
 
174
            raise ValueError('Cannot supply both a member and children')
157
175
 
158
 
        self._import_replacer_children = children
159
 
        self._member = member
160
 
        self._module_path = module_path
 
176
        object.__setattr__(self, '_import_replacer_children', children)
 
177
        object.__setattr__(self, '_member', member)
 
178
        object.__setattr__(self, '_module_path', module_path)
161
179
 
162
180
        # Indirecting through __class__ so that children can
163
181
        # override _import (especially our instrumented version)
241
259
 
242
260
        :param import_str: The import string to process
243
261
        """
244
 
        assert import_str.startswith('import ')
 
262
        if not import_str.startswith('import '):
 
263
            raise ValueError('bad import string %r' % (import_str,))
245
264
        import_str = import_str[len('import '):]
246
265
 
247
266
        for path in import_str.split(','):
286
305
 
287
306
        :param from_str: The import string to process
288
307
        """
289
 
        assert from_str.startswith('from ')
 
308
        if not from_str.startswith('from '):
 
309
            raise ValueError('bad from/import %r' % from_str)
290
310
        from_str = from_str[len('from '):]
291
311
 
292
312
        from_module, import_list = from_str.split(' import ')