/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Martin Pool
  • Date: 2005-06-22 09:35:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050622093524-b15e2d374c2ae6ea
- move standard plugins from contrib/plugins to just ./plugins

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
 
 
18
# This module implements plug-in support.
 
19
# Any python module in $BZR_PLUGIN_PATH will be imported upon initialization
 
20
# of bzrlib (and then forgotten about).  In the plugin's main body, it should
 
21
# update any bzrlib registries it wants to extend; for example, to add new
 
22
# commands, import bzrlib.commands and add your new command to the
 
23
# plugin_cmds variable.
 
24
 
 
25
 
 
26
DEFAULT_PLUGIN_PATH = '~/.bzr.conf/plugins'
 
27
 
 
28
all_plugins = []
 
29
 
 
30
 
 
31
def load_plugins():
 
32
    """
 
33
    Find all python plugins and load them.
 
34
 
 
35
    Loading a plugin means importing it into the python interpreter.
 
36
    The plugin is expected to make calls to register commands when
 
37
    it's loaded (or perhaps access other hooks in future.)
 
38
 
 
39
    A list of plugs is stored in bzrlib.plugin.all_plugins for future
 
40
    reference.
 
41
 
 
42
    The environment variable BZR_PLUGIN_PATH is considered a delimited
 
43
    set of paths to look through. Each entry is searched for *.py
 
44
    files (and whatever other extensions are used in the platform,
 
45
    such as *.pyd).
 
46
    """
 
47
 
 
48
    import sys, os, imp
 
49
    try:
 
50
        set
 
51
    except NameError:
 
52
        from sets import Set as set         # python2.3
 
53
 
 
54
    from bzrlib.trace import log_error, mutter, log_exception
 
55
    from bzrlib.errors import BzrError
 
56
 
 
57
    bzrpath = os.environ.get('BZR_PLUGIN_PATH')
 
58
    if not bzrpath:
 
59
        bzrpath = os.path.expanduser(DEFAULT_PLUGIN_PATH)
 
60
 
 
61
    global all_plugins
 
62
    if all_plugins:
 
63
        raise BzrError("plugins already initialized")
 
64
 
 
65
    # The problem with imp.get_suffixes() is that it doesn't include
 
66
    # .pyo which is technically valid
 
67
    # It also means that "testmodule.so" will show up as both test and testmodule
 
68
    # though it is only valid as 'test'
 
69
    # but you should be careful, because "testmodule.py" loads as testmodule.
 
70
    suffixes = imp.get_suffixes()
 
71
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
 
72
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
 
73
    for d in bzrpath.split(os.pathsep):
 
74
        # going through them one by one allows different plugins with the same
 
75
        # filename in different directories in the path
 
76
        mutter('looking for plugins in %s' % d)
 
77
        if not d:
 
78
            continue
 
79
        plugin_names = set()
 
80
        if not os.path.isdir(d):
 
81
            continue
 
82
        for f in os.listdir(d):
 
83
            path = os.path.join(d, f)
 
84
            if os.path.isdir(path):
 
85
                for entry in package_entries:
 
86
                    # This directory should be a package, and thus added to
 
87
                    # the list
 
88
                    if os.path.isfile(os.path.join(path, entry)):
 
89
                        break
 
90
                else: # This directory is not a package
 
91
                    continue
 
92
            else:
 
93
                for suffix_info in suffixes:
 
94
                    if f.endswith(suffix_info[0]):
 
95
                        f = f[:-len(suffix_info[0])]
 
96
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
 
97
                            f = f[:-len('module')]
 
98
                        break
 
99
                else:
 
100
                    continue
 
101
            mutter('add plugin name %s' % f)
 
102
            plugin_names.add(f)
 
103
 
 
104
        plugin_names = list(plugin_names)
 
105
        plugin_names.sort()
 
106
        for name in plugin_names:
 
107
            try:
 
108
                plugin_info = imp.find_module(name, [d])
 
109
                mutter('load plugin %r' % (plugin_info,))
 
110
                try:
 
111
                    plugin = imp.load_module('bzrlib.plugin.' + name,
 
112
                                             *plugin_info)
 
113
                    all_plugins.append(plugin_info)
 
114
                finally:
 
115
                    if plugin_info[0] is not None:
 
116
                        plugin_info[0].close()
 
117
            except Exception, e:
 
118
                log_error('Unable to load plugin %r from %r' % (name, d))
 
119
                log_error(str(e))
 
120
                log_exception()
 
121