aboutsummaryrefslogtreecommitdiffstats
path: root/libbe/plugin.py
blob: 0964fba01a4aa3aaca41e2d547f2ccbd2cf77fd8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# Copyright (C) 2005 Aaron Bentley and Panometrics, Inc.
# <abentley@panoramicfeedback.com>
#
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program; if not, write to the Free Software
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
import os
import os.path
import sys
import doctest

def my_import(mod_name):
    module = __import__(mod_name)
    components = mod_name.split('.')
    for comp in components[1:]:
        module = getattr(module, comp)
    return module

def iter_plugins(prefix):
    """
    >>> "list" in [n for n,m in iter_plugins("becommands")]
    True
    >>> "plugin" in [n for n,m in iter_plugins("libbe")]
    True
    """
    modfiles = os.listdir(os.path.join(plugin_path, prefix))
    modfiles.sort()
    for modfile in modfiles:
        if modfile.startswith('.'):
            continue # the occasional emacs temporary file
        if modfile.endswith(".py") and modfile != "__init__.py":
            yield modfile[:-3], my_import(prefix+"."+modfile[:-3])


def get_plugin(prefix, name):
    """
    >>> get_plugin("becommands", "asdf") is None
    True
    >>> q = repr(get_plugin("becommands", "list"))
    >>> q.startswith("<module 'becommands.list' from ")
    True
    """
    dirprefix = os.path.join(*prefix.split('.'))
    command_path = os.path.join(plugin_path, dirprefix, name+".py")
    if os.path.isfile(command_path):
        return my_import(prefix + "." + name)
    return None

plugin_path = os.path.realpath(os.path.dirname(os.path.dirname(__file__)))
if plugin_path not in sys.path:
    sys.path.append(plugin_path)

suite = doctest.DocTestSuite()

def _test():
    import doctest
    doctest.testmod()

if __name__ == "__main__":
    _test()