← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

Merge from integration.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
42
42
import imp
43
43
import os
44
44
import sys
 
45
import types
45
46
 
46
47
import bzrlib
47
48
from bzrlib.config import config_dir
49
50
        log_exception_quietly
50
51
from bzrlib.errors import BzrError
51
52
from bzrlib import plugins
52
 
 
53
 
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
54
 
 
55
 
all_plugins = []
 
53
from bzrlib.osutils import pathjoin
 
54
 
 
55
DEFAULT_PLUGIN_PATH = pathjoin(config_dir(), 'plugins')
 
56
 
56
57
_loaded = False
57
58
 
58
59
 
 
60
def all_plugins():
 
61
    """Return a dictionary of the plugins."""
 
62
    result = {}
 
63
    for name, plugin in bzrlib.plugins.__dict__.items():
 
64
        if isinstance(plugin, types.ModuleType):
 
65
            result[name] = plugin
 
66
    return result
 
67
 
 
68
 
59
69
def load_plugins():
60
 
    """Find all python plugins and load them.
61
 
 
62
 
    Loading a plugin means importing it into the python interpreter.
63
 
    The plugin is expected to make calls to register commands when
64
 
    it's loaded (or perhaps access other hooks in future.)
65
 
 
66
 
    A list of plugs is stored in bzrlib.plugin.all_plugins for future
67
 
    reference.
 
70
    """Load bzrlib plugins.
68
71
 
69
72
    The environment variable BZR_PLUGIN_PATH is considered a delimited
70
73
    set of paths to look through. Each entry is searched for *.py
71
74
    files (and whatever other extensions are used in the platform,
72
75
    such as *.pyd).
 
76
 
 
77
    load_from_dirs() provides the underlying mechanism and is called with
 
78
    the default directory list to provide the normal behaviour.
73
79
    """
74
 
 
75
 
    global all_plugins, _loaded
 
80
    global _loaded
76
81
    if _loaded:
77
82
        # People can make sure plugins are loaded, they just won't be twice
78
83
        return
82
87
    dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
83
88
    dirs.insert(0, os.path.dirname(plugins.__file__))
84
89
 
 
90
    load_from_dirs(dirs)
 
91
 
 
92
 
 
93
def load_from_dirs(dirs):
 
94
    """Load bzrlib plugins found in each dir in dirs.
 
95
 
 
96
    Loading a plugin means importing it into the python interpreter.
 
97
    The plugin is expected to make calls to register commands when
 
98
    it's loaded (or perhaps access other hooks in future.)
 
99
 
 
100
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
 
101
    for future reference.
 
102
    """
85
103
    # The problem with imp.get_suffixes() is that it doesn't include
86
104
    # .pyo which is technically valid
87
105
    # It also means that "testmodule.so" will show up as both test and testmodule
91
109
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
92
110
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
93
111
    for d in dirs:
94
 
        # going through them one by one allows different plugins with the same
95
 
        # filename in different directories in the path
 
112
        if not d:
 
113
            continue
96
114
        mutter('looking for plugins in %s', d)
97
 
        if not d:
98
 
            continue
99
115
        plugin_names = set()
100
116
        if not os.path.isdir(d):
101
117
            continue
102
118
        for f in os.listdir(d):
103
 
            path = os.path.join(d, f)
 
119
            path = pathjoin(d, f)
104
120
            if os.path.isdir(path):
105
121
                for entry in package_entries:
106
122
                    # This directory should be a package, and thus added to
107
123
                    # the list
108
 
                    if os.path.isfile(os.path.join(path, entry)):
 
124
                    if os.path.isfile(pathjoin(path, entry)):
109
125
                        break
110
126
                else: # This directory is not a package
111
127
                    continue
118
134
                        break
119
135
                else:
120
136
                    continue
121
 
            mutter('add plugin name %s', f)
122
 
            plugin_names.add(f)
 
137
            if getattr(bzrlib.plugins, f, None):
 
138
                mutter('Plugin name %s already loaded', f)
 
139
            else:
 
140
                mutter('add plugin name %s', f)
 
141
                plugin_names.add(f)
123
142
 
124
143
        plugin_names = list(plugin_names)
125
144
        plugin_names.sort()
130
149
                try:
131
150
                    plugin = imp.load_module('bzrlib.plugins.' + name,
132
151
                                             *plugin_info)
133
 
                    all_plugins.append(plugin)
134
152
                    setattr(bzrlib.plugins, name, plugin)
135
153
                finally:
136
154
                    if plugin_info[0] is not None: