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
71
|
# Copyright (C) 2004 Aaron Bentley
# <aaron.bentley@utoronto.ca>
#
# 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 sys
import os
#ensure that the parent directory is in the path (for epydoc)
sys.path=[os.path.realpath(os.path.dirname(__file__)+"/..")]+sys.path
import commands
__docformat__ = "restructuredtext"
__doc__ = "command template"
class Template(commands.BaseCommand):
"""Template for writing new commands"""
def __init__(self):
self.description = self.__doc__
# override get_completer if you want custom completion
# def get_completer(self, arg, index):
# return cmdutil.iter_dir_completions(arg)
def do_command(self, cmdargs):
parser=self.get_parser()
(options, args) = parser.parse_args(cmdargs)
if len(args) != 1:
raise errors.GetHelp
return 0
def get_parser(self):
parser = cmdutil.CmdOptionParser("example ARGUMENT1 ARGUMENT2")
return parser
def help(self, parser=None):
"""
Prints a help message.
:param parser: If supplied, the parser to use for generating help. If \
not supplied, it is retrieved.
:type parser: cmdutil.CmdOptionParser
"""
if parser==None:
parser=self.get_parser()
parser.print_help()
print """
Verbose help text goes here.
"""
#This function assigns the command class to a user command name
def add_command(commands):
commands["template"] = Template
# arch-tag: 9feb1e39-86dd-447f-8999-5f8eab1f4ddf
|