1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 """Extend OptionParser with commands.
20
21 Example:
22
23 >>> parser = OptionParser()
24 >>> parser.usage = '%prog COMMAND [options] <arg> ...'
25 >>> parser.add_command('build', 'mymod.build')
26 >>> parser.add_command('clean', run_clean, add_opt_clean)
27 >>> run, options, args = parser.parse_command(sys.argv[1:])
28 >>> return run(options, args[1:])
29
30 With mymod.build that defines two functions run and add_options
31
32
33
34
35 """
36 __docformat__ = "restructuredtext en"
37
38
39
40 import sys
41 import optparse
42
44
49
51 """name of the command
52 name of module or tuple of functions (run, add_options)
53 """
54 assert isinstance(mod_or_funcs, str) or isinstance(mod_or_funcs, tuple), \
55 "mod_or_funcs has to be a module name or a tuple of functions"
56 self._commands[name] = (mod_or_funcs, help)
57
59 optparse.OptionParser.print_help(self)
60 print '\ncommands:'
61 for cmdname, (_, help) in self._commands.items():
62 print '% 10s - %s' % (cmdname, help)
63
65 if len(args) == 0:
66 self.print_main_help()
67 sys.exit(1)
68 cmd = args[0]
69 args = args[1:]
70 if cmd not in self._commands:
71 if cmd in ('-h', '--help'):
72 self.print_main_help()
73 sys.exit(0)
74 elif self.version is not None and cmd == "--version":
75 self.print_version()
76 sys.exit(0)
77 self.error('unknown command')
78 self.prog = '%s %s' % (self.prog, cmd)
79 mod_or_f, help = self._commands[cmd]
80
81 self.description = help
82 if isinstance(mod_or_f, str):
83 exec 'from %s import run, add_options' % mod_or_f
84 else:
85 run, add_options = mod_or_f
86 add_options(self)
87 (options, args) = self.parse_args(args)
88 if not (self.min_args <= len(args) <= self.max_args):
89 self.error('incorrect number of arguments')
90 return run, options, args
91