~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
import sys, os, imp
26
 
try:
27
 
    set
28
 
except NameError:
29
 
    from sets import Set as set
30
 
from bzrlib.trace import log_error
31
 
 
32
 
 
33
 
def load_plugins():
34
 
    """Find all python files which are plugins, and load them
35
 
 
36
 
    The environment variable BZR_PLUGIN_PATH is considered a delimited set of
37
 
    paths to look through. Each entry is searched for *.py files (and whatever
38
 
    other extensions are used in the platform, such as *.pyd).
39
 
    """
40
 
    bzrpath = os.environ.get('BZR_PLUGIN_PATH', os.path.expanduser('~/.bzr/plugins'))
41
 
 
42
 
    # The problem with imp.get_suffixes() is that it doesn't include
43
 
    # .pyo which is technically valid
44
 
    # It also means that "testmodule.so" will show up as both test and testmodule
45
 
    # though it is only valid as 'test'
46
 
    # but you should be careful, because "testmodule.py" loads as testmodule.
47
 
    suffixes = imp.get_suffixes()
48
 
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
49
 
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
50
 
    for d in bzrpath.split(os.pathsep):
51
 
        # going trough them one by one allows different plugins with the same
52
 
        # filename in different directories in the path
53
 
        if not d:
54
 
            continue
55
 
        plugin_names = set()
56
 
        if not os.path.isdir(d):
57
 
            continue
58
 
        for f in os.listdir(d):
59
 
            path = os.path.join(d, f)
60
 
            if os.path.isdir(path):
61
 
                for entry in package_entries:
62
 
                    # This directory should be a package, and thus added to
63
 
                    # the list
64
 
                    if os.path.isfile(os.path.join(path, entry)):
65
 
                        break
66
 
                else: # This directory is not a package
67
 
                    continue
68
 
            else:
69
 
                for suffix_info in suffixes:
70
 
                    if f.endswith(suffix_info[0]):
71
 
                        f = f[:-len(suffix_info[0])]
72
 
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
73
 
                            f = f[:-len('module')]
74
 
                        break
75
 
                else:
76
 
                    continue
77
 
            plugin_names.add(f)
78
 
 
79
 
        plugin_names = list(plugin_names)
80
 
        plugin_names.sort()
81
 
        for name in plugin_names:
82
 
            try:
83
 
                plugin_info = imp.find_module(name, [d])
84
 
                try:
85
 
                    plugin = imp.load_module('bzrlib.plugin.' + name,
86
 
                                             *plugin_info)
87
 
                finally:
88
 
                    if plugin_info[0] is not None:
89
 
                        plugin_info[0].close()
90
 
            except Exception, e:
91
 
                log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
92