/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: John Arbash Meinel
  • Date: 2005-12-01 18:16:47 UTC
  • mto: (1185.50.19 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1532.
  • Revision ID: john@arbash-meinel.com-20051201181647-2d65af900f14ba6a
Switched os.path.abspath and os.path.realpath to osutils.* (still passes on cygwin)

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
"""bzr python plugin support
 
19
 
 
20
Any python module in $BZR_PLUGIN_PATH will be imported upon initialization of
 
21
bzrlib. The module will be imported as 'bzrlib.plugins.$BASENAME(PLUGIN)'.
 
22
In the plugin's main body, it should update any bzrlib registries it wants to
 
23
extend; for example, to add new commands, import bzrlib.commands and add your
 
24
new command to the plugin_cmds variable.
 
25
"""
 
26
 
 
27
# TODO: Refactor this to make it more testable.  The main problem at the
 
28
# moment is that loading plugins affects the global process state -- for bzr
 
29
# in general use it's a reasonable assumption that all plugins are loaded at
 
30
# startup and then stay loaded, but this is less good for testing.
 
31
# 
 
32
# Several specific issues:
 
33
#  - plugins can't be unloaded and will continue to effect later tests
 
34
#  - load_plugins does nothing if called a second time
 
35
#  - plugin hooks can't be removed
 
36
#
 
37
# Our options are either to remove these restrictions, or work around them by
 
38
# loading the plugins into a different space than the one running the tests.
 
39
# That could be either a separate Python interpreter or perhaps a new
 
40
# namespace inside this interpreter.
 
41
 
 
42
import imp
 
43
import os
 
44
import sys
 
45
 
 
46
import bzrlib
 
47
from bzrlib.config import config_dir
 
48
from bzrlib.trace import log_error, mutter, log_exception, warning, \
 
49
        log_exception_quietly
 
50
from bzrlib.errors import BzrError
 
51
from bzrlib import plugins
 
52
from bzrlib.osutils import pathjoin
 
53
 
 
54
DEFAULT_PLUGIN_PATH = pathjoin(config_dir(), 'plugins')
 
55
 
 
56
all_plugins = []
 
57
_loaded = False
 
58
 
 
59
 
 
60
def load_plugins():
 
61
    """Find all python plugins and load them.
 
62
 
 
63
    Loading a plugin means importing it into the python interpreter.
 
64
    The plugin is expected to make calls to register commands when
 
65
    it's loaded (or perhaps access other hooks in future.)
 
66
 
 
67
    A list of plugs is stored in bzrlib.plugin.all_plugins for future
 
68
    reference.
 
69
 
 
70
    The environment variable BZR_PLUGIN_PATH is considered a delimited
 
71
    set of paths to look through. Each entry is searched for *.py
 
72
    files (and whatever other extensions are used in the platform,
 
73
    such as *.pyd).
 
74
    """
 
75
 
 
76
    global all_plugins, _loaded
 
77
    if _loaded:
 
78
        # People can make sure plugins are loaded, they just won't be twice
 
79
        return
 
80
        #raise BzrError("plugins already initialized")
 
81
    _loaded = True
 
82
 
 
83
    dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
 
84
    dirs.insert(0, os.path.dirname(plugins.__file__))
 
85
 
 
86
    # The problem with imp.get_suffixes() is that it doesn't include
 
87
    # .pyo which is technically valid
 
88
    # It also means that "testmodule.so" will show up as both test and testmodule
 
89
    # though it is only valid as 'test'
 
90
    # but you should be careful, because "testmodule.py" loads as testmodule.
 
91
    suffixes = imp.get_suffixes()
 
92
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
 
93
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
 
94
    for d in dirs:
 
95
        # going through them one by one allows different plugins with the same
 
96
        # filename in different directories in the path
 
97
        mutter('looking for plugins in %s', d)
 
98
        if not d:
 
99
            continue
 
100
        plugin_names = set()
 
101
        if not os.path.isdir(d):
 
102
            continue
 
103
        for f in os.listdir(d):
 
104
            path = pathjoin(d, f)
 
105
            if os.path.isdir(path):
 
106
                for entry in package_entries:
 
107
                    # This directory should be a package, and thus added to
 
108
                    # the list
 
109
                    if os.path.isfile(pathjoin(path, entry)):
 
110
                        break
 
111
                else: # This directory is not a package
 
112
                    continue
 
113
            else:
 
114
                for suffix_info in suffixes:
 
115
                    if f.endswith(suffix_info[0]):
 
116
                        f = f[:-len(suffix_info[0])]
 
117
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
 
118
                            f = f[:-len('module')]
 
119
                        break
 
120
                else:
 
121
                    continue
 
122
            mutter('add plugin name %s', f)
 
123
            plugin_names.add(f)
 
124
 
 
125
        plugin_names = list(plugin_names)
 
126
        plugin_names.sort()
 
127
        for name in plugin_names:
 
128
            try:
 
129
                plugin_info = imp.find_module(name, [d])
 
130
                mutter('load plugin %r', plugin_info)
 
131
                try:
 
132
                    plugin = imp.load_module('bzrlib.plugins.' + name,
 
133
                                             *plugin_info)
 
134
                    all_plugins.append(plugin)
 
135
                    setattr(bzrlib.plugins, name, plugin)
 
136
                finally:
 
137
                    if plugin_info[0] is not None:
 
138
                        plugin_info[0].close()
 
139
 
 
140
                mutter('loaded succesfully')
 
141
            except KeyboardInterrupt:
 
142
                raise
 
143
            except Exception, e:
 
144
                ## import pdb; pdb.set_trace()
 
145
                warning('Unable to load plugin %r from %r' % (name, d))
 
146
                log_exception_quietly()