File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -26,6 +26,12 @@ A transcript can automatically generated based upon commands previously executed
2626
2727This is by far the easiest way to generate a transcript.
2828
29+ .. warning ::
30+
31+ Make sure you use the **poutput() ** method in your ``cmd2 `` application for generating command output. This method
32+ of the ``cmd2.Cmd `` class ensure that output is properly redirected when redirecting to a file, piping to a shell
33+ command, and when generating a transcript.
34+
2935Manually
3036--------
3137Here's a transcript created from ``python examples/example.py ``::
Original file line number Diff line number Diff line change @@ -155,9 +155,14 @@ but ``print`` decreases output flexibility). ``cmd2`` applications can use
155155``self.poutput('output') ``, ``self.pfeedback('message') ``, and ``self.perror('errmsg') ``
156156instead. These methods have these advantages:
157157
158+ - Handle output redirection to file and/or pipe appropriately
158159- More concise
159160 - ``.pfeedback() `` destination is controlled by :ref: `quiet ` parameter.
160161
162+ .. automethod :: cmd2.Cmd.poutput
163+ .. automethod :: cmd2.Cmd.perror
164+ .. automethod :: cmd2.Cmd.pfeedback
165+
161166
162167color
163168=====
You can’t perform that action at this time.
0 commit comments