diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/freefeatures.rst | 72 | ||||
| -rw-r--r-- | docs/pycon2010/fileutil.py | 12 | ||||
| -rw-r--r-- | docs/pycon2010/graph.py | 41 | ||||
| -rw-r--r-- | docs/pycon2010/pirate.py | 3 | ||||
| -rw-r--r-- | docs/pycon2010/pirate2.py | 1 | ||||
| -rw-r--r-- | docs/pycon2010/pirate3.py | 5 | ||||
| -rw-r--r-- | docs/pycon2010/pirate4.py | 11 | ||||
| -rw-r--r-- | docs/pycon2010/pirate5.py | 11 | ||||
| -rw-r--r-- | docs/pycon2010/pirate6.py | 11 | ||||
| -rw-r--r-- | docs/pycon2010/pirate7.py | 11 | ||||
| -rw-r--r-- | docs/pycon2010/pirate8.py | 13 | ||||
| -rw-r--r-- | docs/pycon2010/pycon2010.rst | 64 | ||||
| -rw-r--r-- | docs/pycon2010/schematic.py | 32 | ||||
| -rw-r--r-- | docs/unfreefeatures.rst | 42 |
15 files changed, 127 insertions, 204 deletions
diff --git a/docs/conf.py b/docs/conf.py index ee6b5e6a..29fe144a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,7 +11,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +# import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst index 87952611..43b39b29 100644 --- a/docs/freefeatures.rst +++ b/docs/freefeatures.rst @@ -51,8 +51,8 @@ Commands at invocation You can send commands to your app as you invoke it by including them as extra arguments to the program. -``cmd2`` interprets each argument as a separate -command, so you should enclose each command in +``cmd2`` interprets each argument as a separate +command, so you should enclose each command in quotation marks if it is more than a one-word command. :: @@ -60,9 +60,9 @@ quotation marks if it is more than a one-word command. cat@eee:~/proj/cmd2/example$ python example.py "say hello" "say Gracie" quit hello Gracie - cat@eee:~/proj/cmd2/example$ + cat@eee:~/proj/cmd2/example$ + - Output redirection ================== @@ -75,7 +75,7 @@ As in a Unix shell, output of a command can be redirected: ending with a bare ``>``, as in ``mycommand args >``.. Redirecting to paste buffer requires software to be installed on the operating system, pywin32_ on Windows or xclip_ on \*nix. - + If your application depends on mathematical syntax, ``>`` may be a bad choice for redirecting output - it will prevent you from using the greater-than sign in your actual user commands. You can override your @@ -83,7 +83,7 @@ app's value of ``self.redirector`` to use a different string for output redirect class MyApp(cmd2.Cmd): redirector = '->' - + :: (Cmd) say line1 -> out.txt @@ -94,7 +94,7 @@ app's value of ``self.redirector`` to use a different string for output redirect .. _pywin32: http://sourceforge.net/projects/pywin32/ .. _xclip: http://www.cyberciti.biz/faq/xclip-linux-insert-files-command-output-intoclipboard/ - + Python ====== @@ -109,34 +109,34 @@ See see :ref:`parameters`) :: - (Cmd) py print("-".join("spelling")) - s-p-e-l-l-i-n-g - (Cmd) py - Python 2.6.4 (r264:75706, Dec 7 2009, 18:45:15) - [GCC 4.4.1] on linux2 - Type "help", "copyright", "credits" or "license" for more information. - (CmdLineApp) - - py <command>: Executes a Python command. - py: Enters interactive Python mode. - End with `Ctrl-D` (Unix) / `Ctrl-Z` (Windows), `quit()`, 'exit()`. - Non-python commands can be issued with `cmd("your command")`. - - >>> import os - >>> os.uname() - ('Linux', 'eee', '2.6.31-19-generic', '#56-Ubuntu SMP Thu Jan 28 01:26:53 UTC 2010', 'i686') - >>> cmd("say --piglatin {os}".format(os=os.uname()[0])) - inuxLay - >>> self.prompt - '(Cmd) ' - >>> self.prompt = 'Python was here > ' - >>> quit() - Python was here > + (Cmd) py print("-".join("spelling")) + s-p-e-l-l-i-n-g + (Cmd) py + Python 2.6.4 (r264:75706, Dec 7 2009, 18:45:15) + [GCC 4.4.1] on linux2 + Type "help", "copyright", "credits" or "license" for more information. + (CmdLineApp) + + py <command>: Executes a Python command. + py: Enters interactive Python mode. + End with `Ctrl-D` (Unix) / `Ctrl-Z` (Windows), `quit()`, 'exit()`. + Non-python commands can be issued with `cmd("your command")`. + + >>> import os + >>> os.uname() + ('Linux', 'eee', '2.6.31-19-generic', '#56-Ubuntu SMP Thu Jan 28 01:26:53 UTC 2010', 'i686') + >>> cmd("say --piglatin {os}".format(os=os.uname()[0])) + inuxLay + >>> self.prompt + '(Cmd) ' + >>> self.prompt = 'Python was here > ' + >>> quit() + Python was here > Searchable command history ========================== -All cmd_-based applications have access to previous commands with +All cmd_-based applications have access to previous commands with the up- and down- cursor keys. All cmd_-based applications on systems with the ``readline`` module @@ -155,7 +155,7 @@ also provide `bash-like history list editing`_. Quitting the application ======================== -``cmd2`` pre-defines a ``quit`` command for you (with +``cmd2`` pre-defines a ``quit`` command for you (with synonyms ``exit`` and simply ``q``). It's trivial, but it's one less thing for you to remember. @@ -164,14 +164,14 @@ Abbreviated commands ==================== ``cmd2`` apps will accept shortened command names -so long as there is no ambiguity. Thus, if +so long as there is no ambiguity. Thus, if ``do_divide`` is defined, then ``divid``, ``div``, or even ``d`` will suffice, so long as there are no other commands defined beginning with *divid*, *div*, or *d*. This behavior can be turned off with ``app.abbrev`` (see :ref:`parameters`) - + Misc. pre-defined commands ========================== @@ -196,12 +196,12 @@ a ``cmd2``-based app is copied from the screen and pasted into a text file, ``transcript.txt``, then a transcript test can be run against it:: python app.py --test transcript.txt - + Any non-whitespace deviations between the output prescribed in ``transcript.txt`` and the actual output from a fresh run of the application will be reported as a unit test failure. (Whitespace is ignored during the comparison.) -Regular expressions can be embedded in the transcript inside paired ``/`` +Regular expressions can be embedded in the transcript inside paired ``/`` slashes. These regular expressions should not include any whitespace expressions. diff --git a/docs/pycon2010/fileutil.py b/docs/pycon2010/fileutil.py deleted file mode 100644 index 5e754b5a..00000000 --- a/docs/pycon2010/fileutil.py +++ /dev/null @@ -1,12 +0,0 @@ -import glob -import os.path - -for fullfilename in glob.glob('/home/cat/proj/cmd2/*.py'): - (dirpath, fname) = os.path.split(fullfilename) - stats = os.stat(fullfilename) - binds['path'] = dirpath - binds['name'] = fname - binds['bytes'] = stats.st_size - cmd("""INSERT INTO cat.files (path, name, bytes) - VALUES (%(path)s, %(name)s, %(bytes)s)""") -quit() diff --git a/docs/pycon2010/graph.py b/docs/pycon2010/graph.py deleted file mode 100644 index 96ffde72..00000000 --- a/docs/pycon2010/graph.py +++ /dev/null @@ -1,41 +0,0 @@ -from turtle import * -pu() -goto(-400,-400) - -def label(txt): - write(txt, font=('Arial', 20, 'italic')) -hideturtle() -width(6) - -def line(len, _label): - start = pos() - pd() - forward(len) - pu() - forward(30) - pd() - label(_label) - pu() - goto(start) - -def tech(x, y, _label): - pu() - goto(x, y) - pd() - write(_label, font=('Arial', 40, 'bold')) - pu() - -line(600, "Easy to write") -left(90) -line(600, "Easy to use") - -tech(-360, 160, 'GUI') -tech(-390, 100, 'AJAX') -tech(-300, -10, 'webapp') -tech(190, -380, 'CLU') -tech(60, -320, 'TUI') -tech(100, -210, 'cmd') -tech(80, -80, 'cmd2') - -while True: - pass
\ No newline at end of file diff --git a/docs/pycon2010/pirate.py b/docs/pycon2010/pirate.py index 98db50ea..48afe629 100644 --- a/docs/pycon2010/pirate.py +++ b/docs/pycon2010/pirate.py @@ -1,7 +1,8 @@ +# coding=utf-8 from cmd import Cmd class Pirate(Cmd): pass pirate = Pirate() -pirate.cmdloop()
\ No newline at end of file +pirate.cmdloop() diff --git a/docs/pycon2010/pirate2.py b/docs/pycon2010/pirate2.py index e2c49609..c1852f03 100644 --- a/docs/pycon2010/pirate2.py +++ b/docs/pycon2010/pirate2.py @@ -1,3 +1,4 @@ +# coding=utf-8 from cmd import Cmd # using ``do_`` methods diff --git a/docs/pycon2010/pirate3.py b/docs/pycon2010/pirate3.py index 7977a8dc..61eb2d4e 100644 --- a/docs/pycon2010/pirate3.py +++ b/docs/pycon2010/pirate3.py @@ -1,3 +1,4 @@ +# coding=utf-8 from cmd import Cmd # using hook @@ -7,12 +8,12 @@ class Pirate(Cmd): 'Seize booty from a passing ship.' self.gold += 1 def do_drink(self, arg): - 'Drown your sorrrows in rrrum.' + 'Drown your sorrrows in rrrum.' self.gold -= 1 def precmd(self, line): self.initial_gold = self.gold return line - def postcmd(self, stop, line): + def postcmd(self, stop, line): if self.gold != self.initial_gold: print('Now we gots {0} doubloons' .format(self.gold)) diff --git a/docs/pycon2010/pirate4.py b/docs/pycon2010/pirate4.py index 5de9c212..29de7301 100644 --- a/docs/pycon2010/pirate4.py +++ b/docs/pycon2010/pirate4.py @@ -1,3 +1,4 @@ +# coding=utf-8 from cmd import Cmd # using arguments @@ -8,20 +9,20 @@ class Pirate(Cmd): self.gold += 1 def do_drink(self, arg): '''Drown your sorrrows in rrrum. - - drink [n] - drink [n] barrel[s] o' rum.''' + + drink [n] - drink [n] barrel[s] o' rum.''' try: self.gold -= int(arg) except: if arg: print('''What's "{0}"? I'll take rrrum.'''.format(arg)) - self.gold -= 1 + self.gold -= 1 def precmd(self, line): self.initial_gold = self.gold return line - def postcmd(self, stop, line): + def postcmd(self, stop, line): if self.gold != self.initial_gold: print('Now we gots {0} doubloons'.format(self.gold)) pirate = Pirate() -pirate.cmdloop()
\ No newline at end of file +pirate.cmdloop() diff --git a/docs/pycon2010/pirate5.py b/docs/pycon2010/pirate5.py index 7add4635..f6125f57 100644 --- a/docs/pycon2010/pirate5.py +++ b/docs/pycon2010/pirate5.py @@ -1,3 +1,4 @@ +# coding=utf-8 from cmd import Cmd # quitting @@ -8,18 +9,18 @@ class Pirate(Cmd): self.gold += 1 def do_drink(self, arg): '''Drown your sorrrows in rrrum. - - drink [n] - drink [n] barrel[s] o' rum.''' + + drink [n] - drink [n] barrel[s] o' rum.''' try: self.gold -= int(arg) except: if arg: print('''What's "{0}"? I'll take rrrum.'''.format(arg)) - self.gold -= 1 + self.gold -= 1 def precmd(self, line): self.initial_gold = self.gold return line - def postcmd(self, stop, line): + def postcmd(self, stop, line): if self.gold != self.initial_gold: print('Now we gots {0} doubloons' .format(self.gold)) @@ -29,7 +30,7 @@ class Pirate(Cmd): return stop def do_quit(self, arg): print("Quiterrr!") - return True + return True pirate = Pirate() pirate.cmdloop() diff --git a/docs/pycon2010/pirate6.py b/docs/pycon2010/pirate6.py index 4a03fed4..dbb18ce9 100644 --- a/docs/pycon2010/pirate6.py +++ b/docs/pycon2010/pirate6.py @@ -1,3 +1,4 @@ +# coding=utf-8 from cmd2 import Cmd # prompts and defaults @@ -12,18 +13,18 @@ class Pirate(Cmd): self.gold += 1 def do_drink(self, arg): '''Drown your sorrrows in rrrum. - - drink [n] - drink [n] barrel[s] o' rum.''' + + drink [n] - drink [n] barrel[s] o' rum.''' try: self.gold -= int(arg) except: if arg: print('''What's "{0}"? I'll take rrrum.'''.format(arg)) - self.gold -= 1 + self.gold -= 1 def precmd(self, line): self.initial_gold = self.gold return line - def postcmd(self, stop, line): + def postcmd(self, stop, line): if self.gold != self.initial_gold: print('Now we gots {0} doubloons' .format(self.gold)) @@ -33,7 +34,7 @@ class Pirate(Cmd): return stop def do_quit(self, arg): print("Quiterrr!") - return True + return True pirate = Pirate() pirate.cmdloop() diff --git a/docs/pycon2010/pirate7.py b/docs/pycon2010/pirate7.py index 25ff5822..32f4954d 100644 --- a/docs/pycon2010/pirate7.py +++ b/docs/pycon2010/pirate7.py @@ -1,3 +1,4 @@ +# coding=utf-8 from cmd2 import Cmd # prompts and defaults @@ -11,18 +12,18 @@ class Pirate(Cmd): self.gold += 1 def do_drink(self, arg): '''Drown your sorrrows in rrrum. - - drink [n] - drink [n] barrel[s] o' rum.''' + + drink [n] - drink [n] barrel[s] o' rum.''' try: self.gold -= int(arg) except: if arg: print('''What's "{0}"? I'll take rrrum.'''.format(arg)) - self.gold -= 1 + self.gold -= 1 def precmd(self, line): self.initial_gold = self.gold return line - def postcmd(self, stop, line): + def postcmd(self, stop, line): if self.gold != self.initial_gold: print('Now we gots {0} doubloons' .format(self.gold)) @@ -32,7 +33,7 @@ class Pirate(Cmd): return stop def do_quit(self, arg): print("Quiterrr!") - return True + return True default_to_shell = True multilineCommands = ['sing'] terminators = Cmd.terminators + ['...'] diff --git a/docs/pycon2010/pirate8.py b/docs/pycon2010/pirate8.py index 3e80b241..c80d41f4 100644 --- a/docs/pycon2010/pirate8.py +++ b/docs/pycon2010/pirate8.py @@ -1,3 +1,4 @@ +# coding=utf-8 from cmd2 import Cmd, options, make_option # prompts and defaults @@ -11,18 +12,18 @@ class Pirate(Cmd): self.gold += 1 def do_drink(self, arg): '''Drown your sorrrows in rrrum. - - drink [n] - drink [n] barrel[s] o' rum.''' + + drink [n] - drink [n] barrel[s] o' rum.''' try: self.gold -= int(arg) except: if arg: print('''What's "{0}"? I'll take rrrum.'''.format(arg)) - self.gold -= 1 + self.gold -= 1 def precmd(self, line): self.initial_gold = self.gold return line - def postcmd(self, stop, line): + def postcmd(self, stop, line): if self.gold != self.initial_gold: print('Now we gots {0} doubloons' .format(self.gold)) @@ -32,7 +33,7 @@ class Pirate(Cmd): return stop def do_quit(self, arg): print("Quiterrr!") - return True + return True default_to_shell = True multilineCommands = ['sing'] terminators = Cmd.terminators + ['...'] @@ -44,7 +45,7 @@ class Pirate(Cmd): @options([make_option('--ho', type='int', default=2, help="How often to chant 'ho'"), make_option('-c', '--commas', - action="store_true", + action="store_true", help="Intersperse commas")]) def do_yo(self, arg, opts): chant = ['yo'] + ['ho'] * opts.ho diff --git a/docs/pycon2010/pycon2010.rst b/docs/pycon2010/pycon2010.rst index 0b3b7a46..6c3af676 100644 --- a/docs/pycon2010/pycon2010.rst +++ b/docs/pycon2010/pycon2010.rst @@ -11,7 +11,7 @@ Web 2.0 .. image:: web-2-0-logos.gif :height: 350px - + But first... ============ @@ -20,10 +20,10 @@ But first... .. image:: akkad.png :height: 250px - + Sargon the Great Founder of Akkadian Empire - + .. twenty-third century BC In between @@ -31,16 +31,16 @@ In between .. image:: apple.jpg :height: 250px - + Command-Line Interface - Unlike the Akkadian Empire, + Unlike the Akkadian Empire, the CLI will never die. Defining CLI ============ Also known as - + - "Line-oriented command interpreter" - "Command-line interface" - "Shell" @@ -85,24 +85,24 @@ Examples .. image:: urwid.png :height: 250px - + Decide your priorities ====================== .. image:: strategy.png :height: 350px - + A ``cmd`` app: pirate.py ======================== :: from cmd import Cmd - + class Pirate(Cmd): pass - + pirate = Pirate() pirate.cmdloop() @@ -114,9 +114,9 @@ Fundamental prrrinciple ======================= .. class:: huge - - ``(Cmd) foo a b c`` - + + ``(Cmd) foo a b c`` + becomes ``self.do_foo('a b c')`` @@ -139,7 +139,7 @@ Fundamental prrrinciple print('Now we gots {0} doubloons' .format(self.gold)) -.. do_methods; more help +.. do_methods; more help Hooks ===== @@ -163,16 +163,16 @@ Hooks: pirate3.py 'Seize booty from a passing ship.' self.gold += 1 def do_drink(self, arg): - 'Drown your sorrrows in rrrum.' + 'Drown your sorrrows in rrrum.' self.gold -= 1 def precmd(self, line): self.initial_gold = self.gold return line - def postcmd(self, stop, line): + def postcmd(self, stop, line): if self.gold != self.initial_gold: print('Now we gots {0} doubloons' .format(self.gold)) - + Arguments: pirate4.py ===================== @@ -180,22 +180,22 @@ Arguments: pirate4.py def do_drink(self, arg): '''Drown your sorrrows in rrrum. - - drink [n] - drink [n] barrel[s] o' rum.''' + + drink [n] - drink [n] barrel[s] o' rum.''' try: self.gold -= int(arg) except: if arg: print('''What's "{0}"? I'll take rrrum.''' .format(arg)) - self.gold -= 1 - + self.gold -= 1 + quitting: pirate5.py ==================== :: - def postcmd(self, stop, line): + def postcmd(self, stop, line): if self.gold != self.initial_gold: print('Now we gots {0} doubloons' .format(self.gold)) @@ -205,7 +205,7 @@ quitting: pirate5.py return stop def do_quit(self, arg): print("Quiterrr!") - return True + return True prompts, defaults: pirate6.py ============================= @@ -227,7 +227,7 @@ Other CLI packages * CMdO * pycopia * cmdlin - * cmd2 + * cmd2 Demo ==== @@ -258,7 +258,7 @@ Script files Commands at invocation -Output redirection +Output redirection Python @@ -273,9 +273,9 @@ But wait, there's more * Timing * Echo * Debug - + Minor changes: pirate7.py -========================= +========================= :: @@ -287,18 +287,18 @@ Minor changes: pirate7.py Cmd.shortcuts.update({'~': 'sing'}) def do_sing(self, arg): print(self.colorize(arg, self.songcolor)) - + Now how much would you pay? =========================== options / flags -Quiet (suppress feedback) +Quiet (suppress feedback) BASH-style ``select`` Parsing: terminators, suffixes - + Options: pirate8.py =================== @@ -307,13 +307,13 @@ Options: pirate8.py @options([make_option('--ho', type='int', default=2, help="How often to chant 'ho'"), make_option('-c', '--commas', - action="store_true", + action="store_true", help="Intersperse commas")]) def do_yo(self, arg, opts): chant = ['yo'] + ['ho'] * opts.ho separator = ', ' if opts.commas else ' ' chant = separator.join(chant) - print('{0} and a bottle of {1}' + print('{0} and a bottle of {1}' .format(chant, arg)) Serious example: sqlpython diff --git a/docs/pycon2010/schematic.py b/docs/pycon2010/schematic.py deleted file mode 100644 index 80774859..00000000 --- a/docs/pycon2010/schematic.py +++ /dev/null @@ -1,32 +0,0 @@ -from turtle import * -hideturtle() -width(6) -pensize = 10 -pu() -goto(0,-400) - -def rectangle(x, y, _label): - pu() - seth(0) - backward(x / 2) - fontsize = 40 - pd() - for i in range(2): - forward(x) - left(90) - forward(y) - left(90) - pu() - forward(x / 2) - left(90) - forward(y / 2 - fontsize) - pd() - write(_label, align='center', font=('Arial', fontsize, 'bold')) - -rectangle(800, 80, 'cmd') -pu() -forward(80) -rectangle(200, 400, 'cmd2') - -while True: - pass diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index 1cd0081c..c9149409 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -6,13 +6,13 @@ Multiline commands ================== Command input may span multiple lines for the -commands whose names are listed in the +commands whose names are listed in the parameter ``app.multilineCommands``. These commands will be executed only after the user has entered a *terminator*. By default, the command terminators is ``;``; replacing or appending to the list -``app.terminators`` allows different +``app.terminators`` allows different terminators. A blank line is *always* considered a command terminator (cannot be overridden). @@ -21,17 +21,17 @@ Parsed statements ================= ``cmd2`` passes ``arg`` to a ``do_`` method (or -``default`) as a ParsedString, a subclass of +``default`) as a ParsedString, a subclass of string that includes an attribute ``parsed``. ``parsed`` is a ``pyparsing.ParseResults`` -object produced by applying a pyparsing_ +object produced by applying a pyparsing_ grammar applied to ``arg``. It may include: command Name of the command called raw - Full input exactly as typed. + Full input exactly as typed. terminator Character used to end a multiline command @@ -68,9 +68,9 @@ process are painfully complex and should not be considered stable; future ``cmd2`` releases may change it somewhat (hopefully reducing complexity). -(Getting ``arg`` as a ``ParsedString`` is +(Getting ``arg`` as a ``ParsedString`` is technically "free", in that it requires no application -changes from the cmd_ standard, but there will +changes from the cmd_ standard, but there will be no result unless you change your application to *use* ``arg.parsed``.) @@ -83,7 +83,7 @@ to *use* ``arg.parsed``.) Environment parameters ====================== -Your application can define user-settable parameters +Your application can define user-settable parameters which your code can reference. Create them as class attributes with their default values, and add them (with optional documentation) to ``settable``. @@ -111,7 +111,7 @@ documentation) to ``settable``. (Cmd) set --long degrees_c: 22 # temperature in Celsius - sunny: False # + sunny: False # (Cmd) sunbathe Too dim. (Cmd) set sunny yes @@ -135,7 +135,7 @@ a ``do_`` methods accept Unix-style *flags*. It uses optparse_ to parse the flags, and they work the same way as for that module. -Flags are defined with the ``options`` decorator, +Flags are defined with the ``options`` decorator, which is passed a list of optparse_-style options, each created with ``make_option``. The method should accept a second argument, ``opts``, in @@ -180,19 +180,19 @@ the option's online help. arg_desc='(from city) (to city)') def do_travel(self, arg, opts=None): 'Gets you from (from city) to (to city).' - + :: (Cmd) help travel Gets you from (from city) to (to city). Usage: travel [options] (from-city) (to-city) - + Options: -h, --help show this help message and exit -t, --train by train - -.. _optparse: + +.. _optparse: .. _outputters: @@ -200,17 +200,17 @@ poutput, pfeedback, perror ========================== Standard ``cmd`` applications produce their output with ``self.stdout.write('output')`` (or with ``print``, -but ``print`` decreases output flexibility). ``cmd2`` applications can use +but ``print`` decreases output flexibility). ``cmd2`` applications can use ``self.poutput('output')``, ``self.pfeedback('message')``, and ``self.perror('errmsg')`` instead. These methods have these advantages: - More concise - ``.pfeedback()`` destination is controlled by :ref:`quiet` parameter. - + color ===== -Text output can be colored by wrapping it in the ``colorize`` method. +Text output can be colored by wrapping it in the ``colorize`` method. .. automethod:: cmd2.Cmd.colorize @@ -221,7 +221,7 @@ quiet Controls whether ``self.pfeedback('message')`` output is suppressed; useful for non-essential feedback that the user may not always want -to read. ``quiet`` is only relevant if +to read. ``quiet`` is only relevant if ``app.pfeedback`` is sometimes used. ``select`` @@ -234,13 +234,13 @@ Presents numbered options to user, as bash ``select``. .. automethod:: cmd2.Cmd.select :: - + def do_eat(self, arg): sauce = self.select('sweet salty', 'Sauce? ') result = '{food} with {sauce} sauce, yum!' result = result.format(food=arg, sauce=sauce) self.stdout.write(result + '\n') - + :: (Cmd) eat wheaties @@ -248,4 +248,4 @@ Presents numbered options to user, as bash ``select``. 2. salty Sauce? 2 wheaties with salty sauce, yum! -
\ No newline at end of file + |