Mercurial > python-cmd2

comparison docs/unfreefeatures.rst @ 388:52ab96d4f179

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix some Sphinx warnings
author anatoly techtonik <techtonik@gmail.com>
date Mon, 21 Jun 2010 17:02:20 +0300
parents 8aa71e8f1064
children 9d5ff2ddfdea
comparison
equal deleted inserted replaced
387:43ce9110d5a6 388:52ab96d4f179
21 ================= 21 =================
22 22
23 ``cmd2`` passes ``arg`` to a ``do_`` method (or 23 ``cmd2`` passes ``arg`` to a ``do_`` method (or
24 ``default`) as a ParsedString, a subclass of 24 ``default`) as a ParsedString, a subclass of
25 string that includes an attribute ``parsed``. 25 string that includes an attribute ``parsed``.
26 ``parsed`` is a ``pyparsing.ParseResults``_ 26 ``parsed`` is a ``pyparsing.ParseResults``
27 object produced by applying a pyparsing_ 27 object produced by applying a pyparsing_
28 grammar applied to ``arg``. It may include: 28 grammar applied to ``arg``. It may include:
29 29
30 command 30 command
31 Name of the command called 31 Name of the command called
58 - suffix: E 58 - suffix: E
59 - terminator: ; 59 - terminator: ;
60 60
61 If ``parsed`` does not contain an attribute, 61 If ``parsed`` does not contain an attribute,
62 querying for it will return ``None``. (This 62 querying for it will return ``None``. (This
63 is a characteristic of ``pyparsing.ParseResults``_.) 63 is a characteristic of ``pyparsing.ParseResults``.)
64 64
65 ParsedString was developed to support sqlpython_ 65 ParsedString was developed to support sqlpython_
66 and reflects its needs. The parsing grammar and 66 and reflects its needs. The parsing grammar and
67 process are painfully complex and should not be 67 process are painfully complex and should not be
68 considered stable; future ``cmd2`` releases may 68 considered stable; future ``cmd2`` releases may
71 (Getting ``arg`` as a ``ParsedString`` is 71 (Getting ``arg`` as a ``ParsedString`` is
72 technically "free", in that it requires no application 72 technically "free", in that it requires no application
73 changes from the cmd_ standard, but there will 73 changes from the cmd_ standard, but there will
74 be no result unless you change your application 74 be no result unless you change your application
75 to *use* ``arg.parsed``.) 75 to *use* ``arg.parsed``.)
76
77 .. _sqlpython: http://pypi.python.org/pypi/sqlpython/
78
79 .. _cmd: http://docs.python.org/library/cmd.html#module-cmd
80
81 .. _pyparsing: http://pyparsing.wikispaces.com/
76 82
77 Environment parameters 83 Environment parameters
78 ====================== 84 ======================
79 85
80 Your application can define user-settable parameters 86 Your application can define user-settable parameters