← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lazy_import.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-28 06:58:22 UTC
  • mfrom: (2379.2.3 hpss-chroot)
  • Revision ID: pqm@pqm.ubuntu.com-20070328065822-999550a858a3ced3
(robertc) Fix chroot urls to not expose the url of the transport they are protecting, allowing regular url operations to work on them. (Robert Collins, Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lazy_import.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Functionality to create lazy evaluation objects.
18
18
 
19
19
This includes waiting to import a module until it is actually used.
20
20
 
21
21
Most commonly, the 'lazy_import' function is used to import other modules
22
 
in an on-demand fashion. Typically use looks like::
23
 
 
 
22
in an on-demand fashion. Typically use looks like:
24
23
    from bzrlib.lazy_import import lazy_import
25
24
    lazy_import(globals(), '''
26
25
    from bzrlib import (
31
30
    import bzrlib.branch
32
31
    ''')
33
32
 
34
 
Then 'errors, osutils, branch' and 'bzrlib' will exist as lazy-loaded
35
 
objects which will be replaced with a real object on first use.
 
33
    Then 'errors, osutils, branch' and 'bzrlib' will exist as lazy-loaded
 
34
    objects which will be replaced with a real object on first use.
36
35
 
37
 
In general, it is best to only load modules in this way. This is because
38
 
it isn't safe to pass these variables to other functions before they
39
 
have been replaced. This is especially true for constants, sometimes
40
 
true for classes or functions (when used as a factory, or you want
41
 
to inherit from them).
 
36
    In general, it is best to only load modules in this way. This is because
 
37
    it isn't safe to pass these variables to other functions before they
 
38
    have been replaced. This is especially true for constants, sometimes
 
39
    true for classes or functions (when used as a factory, or you want
 
40
    to inherit from them).
42
41
"""
43
42
 
44
 
from __future__ import absolute_import
45
 
 
46
43
 
47
44
class ScopeReplacer(object):
48
45
    """A lazy object that will replace itself in the appropriate scope.
51
48
    needed.
52
49
    """
53
50
 
54
 
    __slots__ = ('_scope', '_factory', '_name', '_real_obj')
55
 
 
56
 
    # If you to do x = y, setting this to False will disallow access to
57
 
    # members from the second variable (i.e. x). This should normally
58
 
    # be enabled for reasons of thread safety and documentation, but
59
 
    # will be disabled during the selftest command to check for abuse.
60
 
    _should_proxy = True
 
51
    __slots__ = ('_scope', '_factory', '_name')
61
52
 
62
53
    def __init__(self, scope, factory, name):
63
54
        """Create a temporary object in the specified scope.
68
59
            It will be passed (self, scope, name)
69
60
        :param name: The variable name in the given scope.
70
61
        """
71
 
        object.__setattr__(self, '_scope', scope)
72
 
        object.__setattr__(self, '_factory', factory)
73
 
        object.__setattr__(self, '_name', name)
74
 
        object.__setattr__(self, '_real_obj', None)
 
62
        self._scope = scope
 
63
        self._factory = factory
 
64
        self._name = name
75
65
        scope[name] = self
76
66
 
77
 
    def _resolve(self):
78
 
        """Return the real object for which this is a placeholder"""
 
67
    def _replace(self):
 
68
        """Actually replace self with other in the given scope"""
79
69
        name = object.__getattribute__(self, '_name')
80
 
        real_obj = object.__getattribute__(self, '_real_obj')
81
 
        if real_obj is None:
82
 
            # No obj generated previously, so generate from factory and scope.
 
70
        try:
83
71
            factory = object.__getattribute__(self, '_factory')
84
72
            scope = object.__getattribute__(self, '_scope')
85
 
            obj = factory(self, scope, name)
86
 
            if obj is self:
87
 
                raise errors.IllegalUseOfScopeReplacer(name, msg="Object tried"
88
 
                    " to replace itself, check it's not using its own scope.")
89
 
 
90
 
            # Check if another thread has jumped in while obj was generated.
91
 
            real_obj = object.__getattribute__(self, '_real_obj')
92
 
            if real_obj is None:
93
 
                # Still no prexisting obj, so go ahead and assign to scope and
94
 
                # return. There is still a small window here where races will
95
 
                # not be detected, but safest to avoid additional locking.
96
 
                object.__setattr__(self, '_real_obj', obj)
97
 
                scope[name] = obj
98
 
                return obj
99
 
 
100
 
        # Raise if proxying is disabled as obj has already been generated.
101
 
        if not ScopeReplacer._should_proxy:
 
73
        except AttributeError, e:
 
74
            # Because ScopeReplacer objects only replace a single
 
75
            # item, passing them to another variable before they are
 
76
            # replaced would cause them to keep getting replaced
 
77
            # (only they are replacing the wrong variable). So we
 
78
            # make it forbidden, and try to give a good error.
102
79
            raise errors.IllegalUseOfScopeReplacer(
103
 
                name, msg="Object already replaced, did you assign it"
104
 
                          " to another variable?")
105
 
        return real_obj
 
80
                name, msg="Object already cleaned up, did you assign it"
 
81
                          " to another variable?",
 
82
                extra=e)
 
83
        obj = factory(self, scope, name)
 
84
        scope[name] = obj
 
85
        return obj
 
86
 
 
87
    def _cleanup(self):
 
88
        """Stop holding on to all the extra stuff"""
 
89
        del self._factory
 
90
        del self._scope
 
91
        # We keep _name, so that we can report errors
 
92
        # del self._name
106
93
 
107
94
    def __getattribute__(self, attr):
108
 
        obj = object.__getattribute__(self, '_resolve')()
 
95
        _replace = object.__getattribute__(self, '_replace')
 
96
        obj = _replace()
 
97
        _cleanup = object.__getattribute__(self, '_cleanup')
 
98
        _cleanup()
109
99
        return getattr(obj, attr)
110
100
 
111
 
    def __setattr__(self, attr, value):
112
 
        obj = object.__getattribute__(self, '_resolve')()
113
 
        return setattr(obj, attr, value)
114
 
 
115
101
    def __call__(self, *args, **kwargs):
116
 
        obj = object.__getattribute__(self, '_resolve')()
 
102
        _replace = object.__getattribute__(self, '_replace')
 
103
        obj = _replace()
 
104
        _cleanup = object.__getattribute__(self, '_cleanup')
 
105
        _cleanup()
117
106
        return obj(*args, **kwargs)
118
107
 
119
108
 
120
 
def disallow_proxying():
121
 
    """Disallow lazily imported modules to be used as proxies.
122
 
 
123
 
    Calling this function might cause problems with concurrent imports
124
 
    in multithreaded environments, but will help detecting wasteful
125
 
    indirection, so it should be called when executing unit tests.
126
 
 
127
 
    Only lazy imports that happen after this call are affected.
128
 
    """
129
 
    ScopeReplacer._should_proxy = False
130
 
 
131
 
 
132
109
class ImportReplacer(ScopeReplacer):
133
110
    """This is designed to replace only a portion of an import list.
134
111
 
153
130
 
154
131
        :param scope: The scope that objects should be imported into.
155
132
            Typically this is globals()
156
 
        :param name: The variable name. Often this is the same as the
 
133
        :param name: The variable name. Often this is the same as the 
157
134
            module_path. 'bzrlib'
158
135
        :param module_path: A list for the fully specified module path
159
136
            ['bzrlib', 'foo', 'bar']
161
138
            None, indicating the module is being imported.
162
139
        :param children: Children entries to be imported later.
163
140
            This should be a map of children specifications.
164
 
            ::
165
 
            
166
 
                {'foo':(['bzrlib', 'foo'], None,
167
 
                    {'bar':(['bzrlib', 'foo', 'bar'], None {})})
168
 
                }
169
 
 
170
 
        Examples::
171
 
 
 
141
            {'foo':(['bzrlib', 'foo'], None, 
 
142
                {'bar':(['bzrlib', 'foo', 'bar'], None {})})
 
143
            }
 
144
        Examples:
172
145
            import foo => name='foo' module_path='foo',
173
146
                          member=None, children={}
174
147
            import foo.bar => name='foo' module_path='foo', member=None,
178
151
            from foo import bar, baz would get translated into 2 import
179
152
            requests. On for 'name=bar' and one for 'name=baz'
180
153
        """
181
 
        if (member is not None) and children:
182
 
            raise ValueError('Cannot supply both a member and children')
 
154
        if member is not None:
 
155
            assert not children, \
 
156
                'Cannot supply both a member and children'
183
157
 
184
 
        object.__setattr__(self, '_import_replacer_children', children)
185
 
        object.__setattr__(self, '_member', member)
186
 
        object.__setattr__(self, '_module_path', module_path)
 
158
        self._import_replacer_children = children
 
159
        self._member = member
 
160
        self._module_path = module_path
187
161
 
188
162
        # Indirecting through __class__ so that children can
189
163
        # override _import (especially our instrumented version)
197
171
        module_path = object.__getattribute__(self, '_module_path')
198
172
        module_python_path = '.'.join(module_path)
199
173
        if member is not None:
200
 
            module = __import__(module_python_path, scope, scope, [member], level=0)
 
174
            module = __import__(module_python_path, scope, scope, [member])
201
175
            return getattr(module, member)
202
176
        else:
203
 
            module = __import__(module_python_path, scope, scope, [], level=0)
 
177
            module = __import__(module_python_path, scope, scope, [])
204
178
            for path in module_path[1:]:
205
179
                module = getattr(module, path)
206
180
 
267
241
 
268
242
        :param import_str: The import string to process
269
243
        """
270
 
        if not import_str.startswith('import '):
271
 
            raise ValueError('bad import string %r' % (import_str,))
 
244
        assert import_str.startswith('import ')
272
245
        import_str = import_str[len('import '):]
273
246
 
274
247
        for path in import_str.split(','):
313
286
 
314
287
        :param from_str: The import string to process
315
288
        """
316
 
        if not from_str.startswith('from '):
317
 
            raise ValueError('bad from/import %r' % from_str)
 
289
        assert from_str.startswith('from ')
318
290
        from_str = from_str[len('from '):]
319
291
 
320
292
        from_module, import_list = from_str.split(' import ')
375
347
def lazy_import(scope, text, lazy_import_class=None):
376
348
    """Create lazy imports for all of the imports in text.
377
349
 
378
 
    This is typically used as something like::
379
 
 
380
 
        from bzrlib.lazy_import import lazy_import
381
 
        lazy_import(globals(), '''
382
 
        from bzrlib import (
383
 
            foo,
384
 
            bar,
385
 
            baz,
386
 
            )
387
 
        import bzrlib.branch
388
 
        import bzrlib.transport
389
 
        ''')
 
350
    This is typically used as something like:
 
351
    from bzrlib.lazy_import import lazy_import
 
352
    lazy_import(globals(), '''
 
353
    from bzrlib import (
 
354
        foo,
 
355
        bar,
 
356
        baz,
 
357
        )
 
358
    import bzrlib.branch
 
359
    import bzrlib.transport
 
360
    ''')
390
361
 
391
362
    Then 'foo, bar, baz' and 'bzrlib' will exist as lazy-loaded
392
363
    objects which will be replaced with a real object on first use.