← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Robert Collins
  • Date: 2005-10-11 01:05:24 UTC
  • mto: This revision was merged to the branch mainline in revision 1438.
  • Revision ID: robertc@robertcollins.net-20051011010524-e258bc8d051cc9d2
add a cache bound to Transactions, and a precious facility, so that we keep inventory.weave in memory, but can discard weaves for other such files.

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
import os
 
27
from bzrlib.osutils import config_dir
 
28
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
 
29
 
 
30
all_plugins = []
 
31
_loaded = False
 
32
 
 
33
 
 
34
def load_plugins():
 
35
    """
 
36
    Find all python plugins and load them.
 
37
 
 
38
    Loading a plugin means importing it into the python interpreter.
 
39
    The plugin is expected to make calls to register commands when
 
40
    it's loaded (or perhaps access other hooks in future.)
 
41
 
 
42
    A list of plugs is stored in bzrlib.plugin.all_plugins for future
 
43
    reference.
 
44
 
 
45
    The environment variable BZR_PLUGIN_PATH is considered a delimited
 
46
    set of paths to look through. Each entry is searched for *.py
 
47
    files (and whatever other extensions are used in the platform,
 
48
    such as *.pyd).
 
49
    """
 
50
 
 
51
    global all_plugins, _loaded
 
52
    if _loaded:
 
53
        # People can make sure plugins are loaded, they just won't be twice
 
54
        return
 
55
        #raise BzrError("plugins already initialized")
 
56
    _loaded = True
 
57
 
 
58
    import sys, os, imp
 
59
    
 
60
    from bzrlib.trace import log_error, mutter, log_exception
 
61
    from bzrlib.errors import BzrError
 
62
    from bzrlib import plugins
 
63
 
 
64
    dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
 
65
    dirs.insert(0, os.path.dirname(plugins.__file__))
 
66
 
 
67
    # The problem with imp.get_suffixes() is that it doesn't include
 
68
    # .pyo which is technically valid
 
69
    # It also means that "testmodule.so" will show up as both test and testmodule
 
70
    # though it is only valid as 'test'
 
71
    # but you should be careful, because "testmodule.py" loads as testmodule.
 
72
    suffixes = imp.get_suffixes()
 
73
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
 
74
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
 
75
    for d in dirs:
 
76
        # going through them one by one allows different plugins with the same
 
77
        # filename in different directories in the path
 
78
        mutter('looking for plugins in %s' % d)
 
79
        if not d:
 
80
            continue
 
81
        plugin_names = set()
 
82
        if not os.path.isdir(d):
 
83
            continue
 
84
        for f in os.listdir(d):
 
85
            path = os.path.join(d, f)
 
86
            if os.path.isdir(path):
 
87
                for entry in package_entries:
 
88
                    # This directory should be a package, and thus added to
 
89
                    # the list
 
90
                    if os.path.isfile(os.path.join(path, entry)):
 
91
                        break
 
92
                else: # This directory is not a package
 
93
                    continue
 
94
            else:
 
95
                for suffix_info in suffixes:
 
96
                    if f.endswith(suffix_info[0]):
 
97
                        f = f[:-len(suffix_info[0])]
 
98
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
 
99
                            f = f[:-len('module')]
 
100
                        break
 
101
                else:
 
102
                    continue
 
103
            mutter('add plugin name %s' % f)
 
104
            plugin_names.add(f)
 
105
 
 
106
        plugin_names = list(plugin_names)
 
107
        plugin_names.sort()
 
108
        for name in plugin_names:
 
109
            try:
 
110
                plugin_info = imp.find_module(name, [d])
 
111
                mutter('load plugin %r' % (plugin_info,))
 
112
                try:
 
113
                    plugin = imp.load_module('bzrlib.plugin.' + name,
 
114
                                             *plugin_info)
 
115
                    all_plugins.append(plugin)
 
116
                finally:
 
117
                    if plugin_info[0] is not None:
 
118
                        plugin_info[0].close()
 
119
 
 
120
                mutter('loaded succesfully')
 
121
            except:
 
122
                log_error('Unable to load plugin %r from %r' % (name, d))
 
123
                log_exception()
 
124