annotate docs/freefeatures.rst @ 359:5b95dacca46e

remove ex2
author catherine@Drou
date Thu, 18 Feb 2010 01:15:39 -0500
parents 49dd1ce6cfd6
children 52ab96d4f179
rev   line source
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
1 ===================================
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
2 Features requiring no modifications
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
3 ===================================
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
4
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
5 These features are provided "for free" to a cmd_-based application
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
6 simply by replacing ``import cmd`` with ``import cmd2 as cmd``.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
7
315
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
8 Script files
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
9 ============
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
10
331
6306edc46a6e more docs
cat@eee
parents: 329
diff changeset
11 Text files can serve as scripts for your ``cmd2``-based
6306edc46a6e more docs
cat@eee
parents: 329
diff changeset
12 application, with the ``load``, ``save``, and ``edit``
6306edc46a6e more docs
cat@eee
parents: 329
diff changeset
13 commands.
315
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
14
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
15 .. automethod:: cmd2.Cmd.do_load
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
16
325
4172feeddf76 want to incorporate run() for tests - not yet working
catherine@dellzilla
parents: 324
diff changeset
17 .. automethod:: cmd2.Cmd.do_save
4172feeddf76 want to incorporate run() for tests - not yet working
catherine@dellzilla
parents: 324
diff changeset
18
331
6306edc46a6e more docs
cat@eee
parents: 329
diff changeset
19 .. automethod:: cmd2.Cmd.do_edit
6306edc46a6e more docs
cat@eee
parents: 329
diff changeset
20
345
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
21 Comments
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
22 ========
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
23
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
24 Comments are omitted from the argument list
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
25 before it is passed to a ``do_`` method. By
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
26 default, both Python-style and C-style comments
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
27 are recognized; you may change this by overriding
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
28 ``app.commentGrammars`` with a different pyparsing_
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
29 grammar.
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
30
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
31 Comments can be useful in :ref:`script`s. Used
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
32 in an interactive session, they may indicate
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
33 mental imbalance.
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
34
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
35 ::
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
36
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
37 def do_speak(self, arg):
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
38 self.stdout.write(arg + '\n')
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
39
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
40 ::
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
41
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
42 (Cmd) speak it was /* not */ delicious! # Yuck!
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
43 it was delicious!
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
44
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
45 Commands at invocation
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
46 ======================
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
47
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
48 You can send commands to your app as you invoke it by
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
49 including them as extra arguments to the program.
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
50 ``cmd2`` interprets each argument as a separate
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
51 command, so you should enclose each command in
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
52 quotation marks if it is more than a one-word command.
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
53
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
54 ::
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
55
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
56 cat@eee:~/proj/cmd2/example$ python example.py "say hello" "say Gracie" quit
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
57 hello
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
58 Gracie
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
59 cat@eee:~/proj/cmd2/example$
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
60
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
61
315
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
62 Output redirection
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
63 ==================
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
64
324
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
65 As in a Unix shell, output of a command can be redirected:
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
66
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
67 - sent to a file with ``>``, as in ``mycommand args > filename.txt``
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
68 - piped (``|``) as input to operating-system commands, as in
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
69 ``mycommand args | wc``
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
70 - sent to the paste buffer, ready for the next Copy operation, by
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
71 ending with a bare ``>``, as in ``mycommand args >``.. Redirecting
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
72 to paste buffer requires software to be installed on the operating
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
73 system, pywin32_ on Windows or xclip_ on *nix.
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
74
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
75 .. _pywin32:: http://sourceforge.net/projects/pywin32/
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
76 .. _xclip:: http://www.cyberciti.biz/faq/xclip-linux-insert-files-command-output-intoclipboard/
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 315
diff changeset
77
315
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
78 Python
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
79 ======
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
80
328
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
81 ::
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
82
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
83 The ``py`` command will run its arguments as a Python
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
84 command. Entered without arguments, it enters an
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
85 interactive Python session. That session can call
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
86 "back" to your application with ``cmd("")``. Through
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
87 ``self``, it also has access to your application
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
88 instance itself. (If that thought terrifies you,
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
89 you can set the ``locals_in_py`` parameter to ``False``.
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
90 See see :ref:`parameters`)
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
91
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
92 ::
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
93
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
94 (Cmd) py print("-".join("spelling"))
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
95 s-p-e-l-l-i-n-g
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
96 (Cmd) py
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
97 Python 2.6.4 (r264:75706, Dec 7 2009, 18:45:15)
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
98 [GCC 4.4.1] on linux2
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
99 Type "help", "copyright", "credits" or "license" for more information.
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
100 (CmdLineApp)
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
101
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
102 py <command>: Executes a Python command.
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
103 py: Enters interactive Python mode.
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
104 End with `Ctrl-D` (Unix) / `Ctrl-Z` (Windows), `quit()`, 'exit()`.
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
105 Non-python commands can be issued with `cmd("your command")`.
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
106
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
107 >>> import os
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
108 >>> os.uname()
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
109 ('Linux', 'eee', '2.6.31-19-generic', '#56-Ubuntu SMP Thu Jan 28 01:26:53 UTC 2010', 'i686')
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
110 >>> cmd("say --piglatin {os}".format(os=os.uname()[0]))
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
111 inuxLay
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
112 >>> self.prompt
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
113 '(Cmd) '
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
114 >>> self.prompt = 'Python was here > '
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
115 >>> quit()
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
116 Python was here >
7b2bca3951a7 locals_in_py
cat@eee
parents: 325
diff changeset
117
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
118 Searchable command history
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
119 ==========================
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
120
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
121 All cmd_-based applications have access to previous commands with
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
122 the up- and down- cursor keys.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
123
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
124 All cmd_-based applications on systems with the ``readline`` module
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
125 also provide `bash-like history list editing`_.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
126
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
127 .. _`bash-like history list editing`: http://www.talug.org/events/20030709/cmdline_history.html
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
128
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
129 ``cmd2`` makes a third type of history access available, consisting of these commands:
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
130
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
131 .. automethod:: cmd2.Cmd.do_history
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
132
329
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
133 .. automethod:: cmd2.Cmd.do_list
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
134
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
135 .. automethod:: cmd2.Cmd.do_run
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
136
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
137 Quitting the application
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
138 ========================
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
139
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
140 ``cmd2`` pre-defines a ``quit`` command for you (with
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
141 synonyms ``exit`` and simply ``q``).
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
142 It's trivial, but it's one less thing for you to remember.
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
143
331
6306edc46a6e more docs
cat@eee
parents: 329
diff changeset
144
345
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
145 Abbreviated commands
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
146 ====================
331
6306edc46a6e more docs
cat@eee
parents: 329
diff changeset
147
345
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
148 ``cmd2`` apps will accept shortened command names
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
149 so long as there is no ambiguity. Thus, if
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
150 ``do_divide`` is defined, then ``divid``, ``div``,
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
151 or even ``d`` will suffice, so long as there are
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
152 no other commands defined beginning with *divid*,
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
153 *div*, or *d*.
331
6306edc46a6e more docs
cat@eee
parents: 329
diff changeset
154
345
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
155 This behavior can be turned off with ``app.abbrev`` (see :ref:`parameters`)
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
156
332
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
157 Misc. pre-defined commands
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
158 ==========================
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
159
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
160 Several generically useful commands are defined
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
161 with automatically included ``do_`` methods.
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
162
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
163 .. automethod:: cmd2.Cmd.do_quit
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
164
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
165 .. automethod:: cmd2.Cmd.do_pause
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
166
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
167 .. automethod:: cmd2.Cmd.do_shell
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
168
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
169 ( ``!`` is a shortcut for ``shell``; thus ``!ls``
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
170 is equivalent to ``shell ls``.)
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
171
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
172
315
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
173 Transcript-based testing
a08c50b7d3d3 doc skeleton
cat@eee
parents: 314
diff changeset
174 ========================
345
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 332
diff changeset
175
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
176 If the entire transcript (input and output) of a successful session of
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
177 a ``cmd2``-based app is copied from the screen and pasted into a text
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
178 file, ``transcript.txt``, then a transcript test can be run against it::
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
179
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
180 python app.py --test transcript.txt
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
181
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
182 Any deviations between the output prescribed in ``transcript.txt`` and
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
183 the actual output from a fresh run of the application will be reported
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
184 as a unit test failure.