← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/package_mf.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-23 08:51:52 UTC
  • mfrom: (5131.2.6 support_OO_flag)
  • mto: This revision was merged to the branch mainline in revision 5179.
  • Revision ID: v.ladeuil+lp@free.fr-20100423085152-uoewc1vnkwqhw0pj
Manually assign docstrings to command objects, so that they work with python -OO

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/package_mf.py
 
1
# Copyright (C) 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Custom module finder for entire package"""
 
18
 
 
19
import modulefinder
 
20
import os
 
21
import sys
 
22
 
 
23
 
 
24
class CustomModuleFinder(modulefinder.ModuleFinder):
 
25
    """Custom module finder for processing python packages,
 
26
    e.g. bzr plugins packages.
 
27
 
 
28
    :param  path:   list of directories to search for modules;
 
29
                    if not specified, python standard library only is used.
 
30
    """
 
31
 
 
32
    def __init__(self, path=None, debug=0, excludes=[], replace_paths=[]):
 
33
        if path is None:
 
34
            path = [os.path.dirname(os.__file__)]    # only python std lib
 
35
        modulefinder.ModuleFinder.__init__(self, path, debug, excludes,
 
36
            replace_paths)
 
37
 
 
38
    def run_package(self, package_path):
 
39
        """Recursively process each module in package with run_script method.
 
40
 
 
41
        :param  package_path:   path to package directory.
 
42
        """
 
43
        stack = [package_path]
 
44
        while stack:
 
45
            curdir = stack.pop(0)
 
46
            py = os.listdir(curdir)
 
47
            for i in py:
 
48
                full = os.path.join(curdir, i)
 
49
                if os.path.isdir(full):
 
50
                    init = os.path.join(full, '__init__.py')
 
51
                    if os.path.isfile(init):
 
52
                        stack.append(full)
 
53
                    continue
 
54
                if not i.endswith('.py'):
 
55
                    continue
 
56
                if i == 'setup.py':     # skip
 
57
                    continue
 
58
                self.run_script(full)
 
59
 
 
60
    def get_result(self):
 
61
        """Return 2-tuple: (list of packages, list of modules)"""
 
62
        keys = self.modules.keys()
 
63
        keys.sort()
 
64
        mods = []
 
65
        packs = []
 
66
        for key in keys:
 
67
            m = self.modules[key]
 
68
            if not m.__file__:      # skip builtins
 
69
                continue
 
70
            if m.__path__:
 
71
                packs.append(key)
 
72
            elif key != '__main__':
 
73
                mods.append(key)
 
74
        return (packs, mods)
 
75
 
 
76
 
 
77
if __name__ == '__main__':
 
78
    package = sys.argv[1]
 
79
 
 
80
    mf = CustomModuleFinder()
 
81
    mf.run_package(package)
 
82
 
 
83
    packs, mods = mf.get_result()
 
84
 
 
85
    print 'Packages:'
 
86
    print packs
 
87
 
 
88
    print 'Modules:'
 
89
    print mods