← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lazy_import.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

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
43
 
65
64
            It will be passed (self, scope, name)
66
65
        :param name: The variable name in the given scope.
67
66
        """
68
 
        object.__setattr__(self, '_scope', scope)
69
 
        object.__setattr__(self, '_factory', factory)
70
 
        object.__setattr__(self, '_name', name)
71
 
        object.__setattr__(self, '_real_obj', None)
 
67
        self._scope = scope
 
68
        self._factory = factory
 
69
        self._name = name
 
70
        self._real_obj = None
72
71
        scope[name] = self
73
72
 
74
73
    def _replace(self):
88
87
                          " to another variable?",
89
88
                extra=e)
90
89
        obj = factory(self, scope, name)
91
 
        if obj is self:
92
 
            raise errors.IllegalUseOfScopeReplacer(name, msg="Object tried"
93
 
                " to replace itself, check it's not using its own scope.")
94
90
        if ScopeReplacer._should_proxy:
95
 
            object.__setattr__(self, '_real_obj', obj)
 
91
            self._real_obj = obj
96
92
        scope[name] = obj
97
93
        return obj
98
94
 
99
95
    def _cleanup(self):
100
96
        """Stop holding on to all the extra stuff"""
101
 
        try:
102
 
            del self._factory
103
 
        except AttributeError:
104
 
            # Oops, we just lost a race with another caller of _cleanup.  Just
105
 
            # ignore it.
106
 
            pass
107
 
 
108
 
        try:
109
 
            del self._scope
110
 
        except AttributeError:
111
 
            # Another race loss.  See above.
112
 
            pass
113
 
 
 
97
        del self._factory
 
98
        del self._scope
114
99
        # We keep _name, so that we can report errors
115
100
        # del self._name
116
101
 
123
108
            _cleanup()
124
109
        return getattr(obj, attr)
125
110
 
126
 
    def __setattr__(self, attr, value):
127
 
        obj = object.__getattribute__(self, '_real_obj')
128
 
        if obj is None:
129
 
            _replace = object.__getattribute__(self, '_replace')
130
 
            obj = _replace()
131
 
            _cleanup = object.__getattribute__(self, '_cleanup')
132
 
            _cleanup()
133
 
        return setattr(obj, attr, value)
134
 
 
135
111
    def __call__(self, *args, **kwargs):
136
112
        _replace = object.__getattribute__(self, '_replace')
137
113
        obj = _replace()
164
140
 
165
141
        :param scope: The scope that objects should be imported into.
166
142
            Typically this is globals()
167
 
        :param name: The variable name. Often this is the same as the
 
143
        :param name: The variable name. Often this is the same as the 
168
144
            module_path. 'bzrlib'
169
145
        :param module_path: A list for the fully specified module path
170
146
            ['bzrlib', 'foo', 'bar']
172
148
            None, indicating the module is being imported.
173
149
        :param children: Children entries to be imported later.
174
150
            This should be a map of children specifications.
175
 
            ::
176
 
            
177
 
                {'foo':(['bzrlib', 'foo'], None,
178
 
                    {'bar':(['bzrlib', 'foo', 'bar'], None {})})
179
 
                }
180
 
 
181
 
        Examples::
182
 
 
 
151
            {'foo':(['bzrlib', 'foo'], None, 
 
152
                {'bar':(['bzrlib', 'foo', 'bar'], None {})})
 
153
            }
 
154
        Examples:
183
155
            import foo => name='foo' module_path='foo',
184
156
                          member=None, children={}
185
157
            import foo.bar => name='foo' module_path='foo', member=None,
189
161
            from foo import bar, baz would get translated into 2 import
190
162
            requests. On for 'name=bar' and one for 'name=baz'
191
163
        """
192
 
        if (member is not None) and children:
193
 
            raise ValueError('Cannot supply both a member and children')
 
164
        if member is not None:
 
165
            assert not children, \
 
166
                'Cannot supply both a member and children'
194
167
 
195
 
        object.__setattr__(self, '_import_replacer_children', children)
196
 
        object.__setattr__(self, '_member', member)
197
 
        object.__setattr__(self, '_module_path', module_path)
 
168
        self._import_replacer_children = children
 
169
        self._member = member
 
170
        self._module_path = module_path
198
171
 
199
172
        # Indirecting through __class__ so that children can
200
173
        # override _import (especially our instrumented version)
278
251
 
279
252
        :param import_str: The import string to process
280
253
        """
281
 
        if not import_str.startswith('import '):
282
 
            raise ValueError('bad import string %r' % (import_str,))
 
254
        assert import_str.startswith('import ')
283
255
        import_str = import_str[len('import '):]
284
256
 
285
257
        for path in import_str.split(','):
324
296
 
325
297
        :param from_str: The import string to process
326
298
        """
327
 
        if not from_str.startswith('from '):
328
 
            raise ValueError('bad from/import %r' % from_str)
 
299
        assert from_str.startswith('from ')
329
300
        from_str = from_str[len('from '):]
330
301
 
331
302
        from_module, import_list = from_str.split(' import ')
386
357
def lazy_import(scope, text, lazy_import_class=None):
387
358
    """Create lazy imports for all of the imports in text.
388
359
 
389
 
    This is typically used as something like::
390
 
 
391
 
        from bzrlib.lazy_import import lazy_import
392
 
        lazy_import(globals(), '''
393
 
        from bzrlib import (
394
 
            foo,
395
 
            bar,
396
 
            baz,
397
 
            )
398
 
        import bzrlib.branch
399
 
        import bzrlib.transport
400
 
        ''')
 
360
    This is typically used as something like:
 
361
    from bzrlib.lazy_import import lazy_import
 
362
    lazy_import(globals(), '''
 
363
    from bzrlib import (
 
364
        foo,
 
365
        bar,
 
366
        baz,
 
367
        )
 
368
    import bzrlib.branch
 
369
    import bzrlib.transport
 
370
    ''')
401
371
 
402
372
    Then 'foo, bar, baz' and 'bzrlib' will exist as lazy-loaded
403
373
    objects which will be replaced with a real object on first use.