annotate example/example.py @ 119:fe47c5b269cc release 0.4, uploaded to PyPI

altering README to match exampleSession.txt
author catherine@dellzilla
date Tue, 28 Oct 2008 14:09:44 -0400
parents 7d215852f9a6
children 07dff0ba981e
rev   line source
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
1 '''A sample application for cmd2.'''
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
2
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
3 from cmd2 import Cmd, make_option, options, Cmd2TestCase
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
4 import unittest, optparse, sys
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
5
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
6 class CmdLineApp(Cmd):
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
7 multilineCommands = ['orate']
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
8 Cmd.shortcuts.update({'&': 'speak'})
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
9 maxrepeats = 3
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
10 Cmd.settable.append('maxrepeats')
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
11
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
12 @options([make_option('-p', '--piglatin', action="store_true", help="atinLay"),
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
13 make_option('-s', '--shout', action="store_true", help="N00B EMULATION MODE"),
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
14 make_option('-r', '--repeat', type="int", help="output [n] times")
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
15 ])
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
16 def do_speak(self, arg, opts=None):
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
17 """Repeats what you tell me to."""
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
18 arg = ''.join(arg)
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
19 if opts.piglatin:
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
20 arg = '%s%say' % (arg[1:], arg[0])
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
21 if opts.shout:
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
22 arg = arg.upper()
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
23 repetitions = opts.repeat or 1
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
24 for i in range(min(repetitions, self.maxrepeats)):
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
25 self.stdout.write(arg)
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
26 self.stdout.write('\n')
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
27 # self.stdout.write is better than "print", because Cmd can be
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
28 # initialized with a non-standard output destination
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
29
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
30 do_say = do_speak # now "say" is a synonym for "speak"
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
31 do_orate = do_speak # another synonym, but this one takes multi-line input
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
32
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
33 class TestMyAppCase(Cmd2TestCase):
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
34 CmdApp = CmdLineApp
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
35 transcriptFileName = 'exampleSession.txt'
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
36
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
37 parser = optparse.OptionParser()
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
38 parser.add_option('-t', '--test', dest='unittests', action='store_true', default=False, help='Run unit test suite')
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
39 (callopts, callargs) = parser.parse_args()
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
40 if callopts.unittests:
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
41 sys.argv = [sys.argv[0]] # the --test argument upsets unittest.main()
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
42 unittest.main()
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
43 else:
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
44 app = CmdLineApp()
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents:
diff changeset
45 app.cmdloop()